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

This parameter is deprecated. Use both absorbPayoutFees and absorbNetworkFee instead.

data.attributes.absorbPayoutFee

boolean

If false, the payout fee is deducted from the transaction amount. If true, the payout fee is deducted from the merchant account balance.

data.attributes.absorbNetworkFee

boolean

If false, the network fee is deducted from the transaction amount. If true, the network fee is deducted from the merchant 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

data.attributes.networkName

string

Network name. E.g. Tron (TRC20).

data.attributes.networkFee

string

Network fee amount.

data.attributes.networkFeeCurrency

string

Network fee currency.

data.attributes.payoutFee

string

Payout fee amount.

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 currency exchange rate applied by Txn. E.g., XRP/TRY.

Response

{
  "data": {
    "id": "e2be6c3c-75cc-4006-983a-afd4e83c7a4b",
    "type": "payouts",
    "attributes": {
      "address": "TTbGTMwUwA3mncLP7xqCZei1ekaNSgeAJe",
      "expiresAt": "2025-07-14T17:31:26.088Z",
      "createdAt": "2025-07-14T17:30:56.088Z",
      "absorbFees": null,
      "absorbPayoutFee": true,
      "absorbNetworkFee": false,
      "reference": "70327e5f-9a3e-4720-b2e4-e899fcbbb956",
      "status": "completed",
      "amount": "1000.00",
      "currency": "TRY",
      "payCurrency": "USDT",
      "payAmount": "22.608351",
      "payNetwork": "ttrx:usdt",
      "payNetworkName": "Tron (TRC20)",
      "txid": "632f5a2803e208f10cd21a780e2ab711e5c6d163d02ec9e578d0dccaf44f5a1c",
      "networkFee": "2.000000",
      "networkFeeCurrency": "USDT",
      "payoutFee": "0.22",
      "payoutFeeCurrency": "EUR",
      "displayFee": "10.00",
      "displayFeeCurrency": "TRY",
      "exchangeRate": "40.636611347206",
      "amountCharged": "21.77",
      "amountChargedCurrency": "EUR",
      "payChargeRate": "0.8755286",
      "payChargeRateCurrency": "EUR"
    },
    "relationships": {
      "author": {
        "data": {
          "type": "apiKeys",
          "id": "45550837-2dc6-4652-9cbf-bfbe4e16382e"
        }
      }
    }
  },
  "included": [
    {
      "id": "45550837-2dc6-4652-9cbf-bfbe4e16382e",
      "type": "apiKeys",
      "attributes": {
        "name": "Test Key",
        "createdAt": "2024-07-04T16:04:48.187Z"
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

Last updated