GuidesAPI ReferenceChangelog
Log In
API Reference

List all Payouts

get
https://api-sandbox.uqpaytech.com/api/v2/payment/payout

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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required
≥ 1

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

integer
required
1 to 100

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

string

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

string

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

string
enum

Payout status filter

Show Details
INITIATEDPayout has been initiated
PROCESSINGPayout is being processed (bank is processing)
COMPLETEDPayout completed successfully
FAILEDPayout failed
FAILED_REFUNDEDPayout failed and funds have been refunded
Allowed:
Headers
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.

uuid
required

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.

Responses

Updated 9 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago