Listing payouts
GET
/api/public/v1/payouts
This endpoint returns a list of payouts with pagination.
Headers
Content-Type
application/vnd.api+json
Authorization
Bearer <api_key>
URL Parameters
order
string
Order in which the list of transactions should be returned. Can be created_at
.
order_type
string
Order type. Can be either asc
or desc
.
page
number
Page for which you want to return transactions.
per_page
number
Number of transactions per page to return.
reference
number
Payout reference
.
Response Body
data.id
string
Payout ID.
data.type
string
Aways payouts
.
data.attributes.reference
string
The custom reference ID to tie the payout to end-user who gets paid. This can be anything you choose.
data.attributes.status
string
data.attributes.address
string
Wallet address of a payout recipient.
data.attributes.createdAt
string
Payout creation timestamp.
data.attributes.absorbFees
boolean
If false or omitted, both service and network fees are deducted from the transaction amount. If true, both fees are deducted from your account balance.
data.attributes.amount
number
Payout amount. This is the amount that Txn debited from your account on the Txn platform.
data.attributes.currency
string
Payout amount currency code. This is effectively the currency account which Txn took the payout amount from.
data.attributes.payCurrency
string
The code of a token or cryptocurrency transferred to the receiving address.
data.attributes.payAmount
string
The amount of tokens or cryptocurrency transferred to the receiving address.
data.attributes.txid
string
The token or cryptocurrency transaction hash. This is effectively a unique identifier of a transaction on a relevant blockchain. You can share it with the receipient as a proof of payment.
data.attributes.payNetwork
string
data.attributes.networkName
string
Network name. E.g. Tron (TRC20).
data.attributes.networkFee
string
The network fee amount Txn took to cover blockchain fees.
data.attributes.networkFeeCurrency
string
Network fee currency.
data.attributes.payoutFee
string
Payout fee amount. This is the Txn's processing fee.
data.attributes.payoutFeeCurrency
string
Payout fee currency.
data.attributes.exchangeRate
string
Exchange rate.
Response
Last updated