# List All Payouts

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/payouts/list:
    get:
      summary: List All Payouts
      deprecated: false
      description: ''
      tags:
        - API Reference/Payouts/Payouts
      parameters:
        - name: Accept
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
        - name: Content-Type
          in: header
          description: ''
          required: true
          example: application/json
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  description: >-
                    Only return payouts that have the given status: pending,
                    paid, failed, or canceled.
                created:
                  type: object
                  properties:
                    gt:
                      type: string
                      description: >-
                        Return results where the created field is greater than
                        this value.
                    gte:
                      type: string
                      description: >-
                        Return results where the created field is greater than
                        or equal to this value.
                    lt:
                      type: string
                      description: >-
                        Return results where the created field is less than this
                        value.
                    lte:
                      type: string
                      description: >-
                        Return results where the created field is less than or
                        equal to this value.
                  description: >-
                    A filter on the list based on the object created field. The
                    value can be a string with an integer Unix timestamp, or it
                    can be a dictionary with the following options:
                  x-apifox-orders:
                    - gt
                    - gte
                    - lt
                    - lte
                  x-apifox-ignore-properties: []
                destination:
                  type: string
                  description: >-
                    The ID of an external account - only return payouts sent to
                    this external account.
                ending_before:
                  type: string
                  description: >-
                    A cursor for use in pagination. ending_before is an object
                    ID that defines your place in the list. For instance, if you
                    make a list request and receive 100 objects, starting with
                    obj_bar, your subsequent call can include
                    ending_before=obj_bar in order to fetch the previous page of
                    the list.
                limit:
                  type: integer
                  description: >-
                    A limit on the number of objects to be returned. Limit can
                    range between 1 and 100, and the default is 10.
                starting_after:
                  type: string
                  description: >-
                    A cursor for use in pagination. starting_after is an object
                    ID that defines your place in the list. For instance, if you
                    make a list request and receive 100 objects, ending with
                    obj_foo, your subsequent call can include
                    starting_after=obj_foo in order to fetch the next page of
                    the list.
              x-apifox-orders:
                - status
                - created
                - destination
                - ending_before
                - limit
                - starting_after
              x-apifox-ignore-properties: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/List'
              example:
                object: list
                url: /v1/payouts
                has_more: false
                data:
                  - id: po_1M9OPNL6kclEVx6MVxzULjsL
                    object: payout
                    amount: 1100
                    created: 1669707553
                    currency: eur
                    destination: ba_xxxxxxxxxx
                    failure_balance_transaction: null
                    failure_code: null
                    failure_message: null
                    livemode: false
                    metadata: {}
                    method: standard
                    original_payout: null
                    reversed_by: null
                    source_type: card
                    statement_descriptor: null
                    status: in_transit
                    type: bank_account
          headers: {}
          x-apifox-name: OK
      security:
        - basic: []
      x-apifox-folder: API Reference/Payouts/Payouts
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/1296482/apis/api-42648528-run
components:
  schemas:
    List:
      type: object
      properties:
        object:
          type: string
          default: '"list"'
        url:
          type: string
        has_more:
          type: boolean
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              object:
                type: string
              api_version:
                type: 'null'
              application:
                type: 'null'
              created:
                type: integer
              description:
                type: string
              enabled_events:
                type: array
                items:
                  type: string
              livemode:
                type: boolean
              metadata:
                type: object
                properties: {}
                x-apifox-orders: []
                x-apifox-ignore-properties: []
              status:
                type: string
              url:
                type: string
            x-apifox-orders:
              - id
              - object
              - api_version
              - application
              - created
              - description
              - enabled_events
              - livemode
              - metadata
              - status
              - url
            x-apifox-ignore-properties: []
      x-apifox-orders:
        - object
        - url
        - has_more
        - data
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
  securitySchemes:
    basic:
      type: http
      scheme: basic
servers:
  - url: https://apitest.wooshpay.com
    description: 官网测试
security:
  - basic: []

```