Sign in
Payout-history

get/payout

Query parameters

statusstring

Filter payouts based on their status (processing, complete, rejected, etc.).

type'external' | 'internal'

Filter payouts based on type.

currencystring

Specify the currency symbol for filtering payouts in a specific currency.

networkstring

Specify the blockchain network for filtering payouts on a particular network.

from_amountnumber

Specify the minimum payout amount for filtering.

to_amountnumber

Specify the maximum payout amount for filtering.

from_dateinteger

The start of the date window to query for payouts in UNIX format.

to_dateinteger

The end of the date window to query for payouts in UNIX format.

sort_by'create_date' | 'pay_date' | 'amount'

Sort the received list by a parameter.

sort_type'asc' | 'desc'

Display the list in ascending or descending order.

sizeinteger

Number of records to be displayed on one page.

pageinteger

The page number of the results you want to retrieve.

Headers

payout_api_keystring required

Your Payout API Key for authentication and authorization.

Content-Typestring required

Response

Successful operation

messagestring

A message containing additional information about the result of the request.

statusinteger

The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors).

versionstring

The version of the API being used.

Changes

No recorded changes to this endpoint across all 1 revision of this API.