v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Payouts

List Payouts

Retrieves a list of payout transactions. The response can be filtered by specifying a creation date range or payout status.

Usage Guidelines:

If start_time and end_time are both omitted, the API returns payouts from the last 30 days by default.
If only end_time is provided, it retrieves payouts within the past 30 days up to end_time.

get/v1/payouts

Query parameters

page_sizeinteger required

Example:10

The maximum number of items to return per page. This number can be between 1 - 100

page_numberinteger required

Example:1

The page number to retrieve the next set of items. The number has to be greater than 1.

payout_status'INITIATED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'FAILED_REFUNDED'

Payout status enumeration.

INITIATED: Payout has been initiated.
PROCESSING: Payout is being processed (bank is processing).
COMPLETED: Payout completed successfully.
FAILED: Payout failed.
FAILED_REFUNDED: Payout failed and funds have been refunded.

Example:INITIATED

Payout status filter

start_timestring

Example:2024-03-01T00:00:00+08:00

Exclusive start time used to filter by create_time. ISO 8601 format.

end_timestring

Example:2024-03-02T00:00:00+08:00

Exclusive end time used to filter by create_time. ISO 8601 format.

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Response

OK - Successfully retrieved a list of payouts.

total_pagesinteger

The total pages of available items.

total_itemsinteger

The total counts of available items.

Example response

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "total_pages": 10,
      "total_items": 105,
      "data": [
        {
          "payout_id": "PO1968582687224500224",
          "payout_amount": "100.00",
          "internal_note": "Payment to supplier",
          "statement_descriptor": "UQPAY PAYOUT",
          "payout_status": "INITIATED",
          "create_time": "2024-03-01T00:00:00+08:00",
          "completed_time": "2024-03-01T00:00:00+08:00"
        }
      ]
    }
  ]
}