Skip to main content
GET
List Payouts

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

x-on-behalf-of
string

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. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Query Parameters

page_size
integer
required

The maximum number of items to return per page. Must be between 10 and 100, inclusive.

Required range: 1 <= x <= 100
Example:

10

page_number
integer
required

The page number to retrieve a specific set of items. Must be 1 or greater.

Required range: x >= 1
Example:

1

payout_status
enum<string>

Status of the payout The payout's status.

  • READY_TO_SEND: The payout has been validated and is ready for processing.
  • PENDING: The payout is currently being processed by the system.
  • REJECTED: The payout was rejected due to validation or compliance requirements not being met.
  • FAILED: The payout process encountered an error and could not be completed.
  • COMPLETED: The payout has been successfully processed and funds have been transferred.
Available options:
READY_TO_SEND,
PENDING,
REJECTED,
FAILED,
COMPLETED
start_time
string

The start time of created_time in ISO8601 format (inclusive).

Example:

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

end_time
string

The end time of created_time in ISO8601 format (inclusive).

Example:

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

Response

200 - application/json

OK - Successfully retrieved a list of payouts.

total_pages
integer

The total number of pages of available items.

Example:

10

total_items
integer

The total counts of available items.

Example:

105

data
object[]