Payout History
Use this endpoint to retrieve a list of payout transactions for a specific business. The list can be filtered by various criteria, such as time range, status, amount, currency, network, type (internal or external), and more. Pagination is also available to fetch the results in smaller sets.
POST
https://api.oxapay.com/api/list
Request Body
key*
string
Your Payout API key for authentication and authorization.
orderBy
string
Display the list in ascending or descending order. Possible values: 'asc', 'desc' [default 'desc'].
sortBy
string
Sort the received list by a parameter. Set to 'create_date' by default. Possible values: 'create_date', 'pay_date', 'amount' [default 'create_date'].
page
integer
The page number of the results you want to retrieve. Possible values: from 1 to the total number of pages - default 1.
size
integer
Number of records to be displayed on one page. Possible values: from 1 to 200 - default 10.
status
string
Filter payouts based on their status (processing, complete, rejected, etc.).
type
string
Filter payouts based on type (internal or external).
network
string
currency
string
toAmount
string
Specify the maximum payout amount for filtering.
fromAmount
string
Specify the minimum payout amount for filtering.
toDate
string
The start of the date window to query for payouts in unix format
fromDate
string
The start of the date window to query for payouts in unix format
Please note that this response sample includes a list of payout transactions with their respective details and a metadata section providing information about the total number of records and pages available.
Example codes
Please remember to replace YOUR_PAYOUT_API_KEY
with your actual payout API key and adjust the parameters as needed for your specific use case.
Last updated