Reading payout

GET /api/public/v1/payouts/:id

This endpoint returns details of a particular payout by its ID.

Headers

Name	Value
Content-Type	application/vnd.api+json
Authorization	Bearer <api_key>

Path Parameters

Name	Value
id	Payout ID.

Response Body

Name	Type	Description
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	Payout status. Refer to Payout Status Flow.
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.
data.attributes.currency	string	Payout amount currency code.
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	Refer to Supported Currencies.
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 processing fee amount taken from the merchant's account.
data.attributes.payoutFeeCurrency	string	Payout fee currency.
data.attributes.displayFee	string	Fee associated with the payout represented in data.attributes.currency. For example, if the payout currency is TRY, the fee is also expressed in TRY.
data.attributes.displayFeeCurrency	string	Fee associated with the payout represented in data.attributes.currency. For example, if the payout currency is TRY, the fee is also expressed in TRY.
data.attributes.amountCharged	string	The amount deducted from the merchant's account.
data.attributes.amountChargedCurrency	string	The amount deducted from the merchant's account.
data.attributes.payChargeRate	string	Pay currency to charge currency exchange rate applied by Txn. E.g., XRP/EUR.
data.attributes.payChargeRateCurrency	string	Pay currency to charge currency exchange rate applied by Txn.
data.attributes.exchangeRate	string	Pay currency to payout currency exchange rate applied by Txn. E.g., XRP/TRY.

Response

HTTP 200

{
  "data": {
    "id": "9b4317e2-f369-4e00-9e65-6ee7d59667a4",
    "type": "payouts",
    "attributes": {
      "address": "rLsBa2vWV2uuPx2UKbocAZG2WHXoaGyMPf?dt=61",
      "expiresAt": "2025-01-31T09:48:01.580Z",
      "createdAt": "2025-01-31T09:47:31.580Z",
      "absorbFees": true,
      "reference": "c2b091dc-d140-44fc-a9de-58c405a67af3",
      "status": "completed",
      "amount": "2000.00",
      "currency": "TRY",
      "payCurrency": "XRP",
      "payAmount": "17.901661",
      "payNetwork": "txrp",
      "payNetworkName": "Ripple",
      "txid": "5DC730018F5DF5F3AB28E1209061111B3737EFC369774FF04F22773ABFFE46A0",
      "networkFee": "1.000000",
      "networkFeeCurrency": "XRP",
      "payoutFee": "0.54",
      "payoutFeeCurrency": "EUR",
      "displayFee": "20.00",
      "displayFeeCurrency": "TRY",
      "exchangeRate": "111.72147825",
      "amountCharged": "57.16",
      "amountChargedCurrency": "EUR",
      "payChargeRate": "2.99537619",
      "payChargeRateCurrency": "EUR"
    }
  },
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}