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_timeandend_timeare both omitted, the API returns payouts from the last 30 days by default. - If only
end_timeis provided, it retrieves payouts within the past 30 days up toend_time.
Authorizations
The API token for login provided by UQPay.
Headers
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
The maximum number of items to return per page. Must be between 10 and 100, inclusive.
1 <= x <= 10010
The page number to retrieve a specific set of items. Must be 1 or greater.
x >= 11
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.
READY_TO_SEND, PENDING, REJECTED, FAILED, COMPLETED The start time of created_time in ISO8601 format (inclusive).
"2024-03-01T00:00:00+08:00"
The end time of created_time in ISO8601 format (inclusive).
"2024-03-01T00:00:00+08:00"

