Listing payouts
GET /api/public/v1/payouts
Returns a paginated list of payouts, ordered by creation time by default.
Headers
Content-Type
application/vnd.api+json
Authorization
Bearer <api_key>
URL Parameters
order
string
Field to sort by. Supported value: created_at.
order_type
string
Sort direction. asc or desc.
page
number
Page number to return.
per_page
number
Number of results per page.
reference
string
Filter by payout reference.
created_at_from
string
Return payouts created at or after this ISO 8601 timestamp, e.g. 2024-06-18T15:49:02.031Z.
created_at_to
string
Return payouts created at or before this ISO 8601 timestamp, e.g. 2024-06-18T15:49:02.031Z.
Response Body
data[].id
string
Payout ID.
data[].type
string
Always payouts.
data[].attributes.reference
string
Your internal correlation key, as set at creation.
data[].attributes.address
string
Recipient's wallet address.
data[].attributes.createdAt
string
ISO 8601 timestamp of when the payout was created.
data[].attributes.expiresAt
string
ISO 8601 timestamp of when the exchange rate lock expires.
data[].attributes.absorbFees
boolean
Deprecated. Use absorbPayoutFee and absorbNetworkFee instead.
data[].attributes.absorbPayoutFee
boolean
If false, the payout fee was deducted from the amount the recipient received. If true, the fee was charged to your account balance.
data[].attributes.absorbNetworkFee
boolean
If false, the network fee was deducted from the amount the recipient received. If true, the fee was charged to your account balance.
data[].attributes.amount
number
Payout amount in currency.
data[].attributes.currency
string
Payout amount currency code.
data[].attributes.payCurrency
string
Currency code of the cryptocurrency sent to the recipient.
data[].attributes.payAmount
string
Amount of cryptocurrency sent to the recipient.
data[].attributes.txid
string
On-chain transaction hash. null until the transaction is broadcast.
data[].attributes.payNetwork
string
Network code of the cryptocurrency sent. See Supported Currencies.
data[].attributes.payNetworkName
string
Human-readable network name, e.g. Tron (TRC20).
data[].attributes.networkFee
string
Network fee amount in networkFeeCurrency.
data[].attributes.networkFeeCurrency
string
Currency of the network fee.
data[].attributes.payoutFee
string
Txn service fee amount in payoutFeeCurrency.
data[].attributes.payoutFeeCurrency
string
Currency of the Txn service fee.
data[].attributes.displayFee
string
Payout fee expressed in currency.
data[].attributes.displayFeeCurrency
string
Currency of displayFee. Always matches currency.
data[].attributes.amountCharged
string
Total amount debited from your account, including all fees, in amountChargedCurrency.
data[].attributes.amountChargedCurrency
string
Currency of amountCharged. Matches chargeCurrency.
data[].attributes.payChargeRate
string
Exchange rate between payCurrency and amountChargedCurrency applied by Txn.
data[].attributes.payChargeRateCurrency
string
Quote currency of payChargeRate.
data[].attributes.exchangeRate
string
Exchange rate between payCurrency and currency applied by Txn.
data[].attributes.paymentMethod
string
Payment method used: on_chain or binance_pay.
data[].attributes.receiverBinanceId
string
Recipient's Binance ID. Present only for binance_pay payouts.
data[].attributes.approvalStatus
string
Approval workflow status. null for API-created payouts. See Payout Status Flow.
data[].attributes.binanceStatus
string
Binance Pay processing status. Present only for binance_pay payouts.
meta.page
number
Current page number.
meta.per_page
number
Number of results per page.
meta.total
number
Total number of payouts matching the query.
included[].type(accounts).attributes
object
The account the payout was charged from. Includes standard account fields: currencyCode, balance, bankWithdrawalAvailable, bankDepositAvailable, transferAvailable, etc.
included[].type(apiKeys).attributes.name
string
Name of the API key that created the payout.
included[].type(apiKeys).attributes.createdAt
string
Timestamp when the API key was created.
Response
Last updated