v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Payment Payouts

List all Payouts

Retrieve a list of payout orders with optional filtering and pagination support.

Usage Guidelines

Default behavior: If no date range is specified, returns the first page of payouts created from one month ago to today.
Date range filtering: When using date filters, both start_time and end_time parameters are required, and end_time must be greater than or equal to start_time. The time range must not exceed one month.

get/v2/payment/payout

Query parameters

page_numberinteger required

Example:1

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

page_sizeinteger required

Example:10

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

start_timestring

Example:2025-07-01

Payout creation start date (inclusive). Date format YYYY-MM-DD represents the start of the day (00:00:00).

end_timestring

Example:2025-07-31

Payout creation end date (inclusive). Date format YYYY-MM-DD represents the end of the day (23:59:59).

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

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.

x-idempotency-keystring uuid

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Response

List of payouts retrieved successfully

total_pagesinteger required

The total pages of available items.

total_itemsinteger required

The total counts of available items.

Example response

{
  "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"
    }
  ]
}