Creating payout

POST /api/public/v1/payouts

This endpoint creates payouts.

Headers

NameValue

Content-Type

application/vnd.api+json

Authorization

Bearer <api_key>

Request Body

NameTypeRequiredDescription

data.type

string

Yes

Can only be payouts.

data.attributes.reference

string

Yes

The custom reference ID to tie the payout to end-user who gets paid. This can be anything you choose. Must be a unique value for each pyout you create.

data.attributes.amount

number

Yes

Payout amount. This is the amount that Txn will debit from your account on the Txn platform. Refer to Payout Limitations.

data.attributes.currency

string

Yes

Payout amount currency code. This is effectively the currency account which Txn will take the payout amount from. Refer to Supported Currencies.

data.attributes.payNetwork

string

Yes

data.attributes.address

string

Yes

Wallet address of a payout recipient.

Response Body

NameTypeDescription

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.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

{
  "data": {
    "id": "1c70d7c8-69bc-430c-a70b-5ae154b83902",
    "type": "payouts",
    "attributes": {
      "reference": "c8bef462-903e-4523-92f5-de1157c00173",
      "status": "created",
      "address": "TTbGTMwUwA3mncLP7xqCZei1ekaNSgeAJe",
      "createdAt": "2024-07-05T12:53:11.979Z",
      "amount": "20.00",
      "currency": "USD",
      "payCurrency": "USDT",
      "payAmount": "15.094163",
      "payNetwork": "ttrx:usdt",
      "networkName": "Tron (TRC20)"
      "txid": null,
      "networkFee": "4.500000",
      "networkFeeCurrency": "USDT",
      "payoutFee": "0.20",
      "payoutFeeCurrency": "USD",
      "exchangeRate": "1.010505"
    }
  },
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

Last updated