Confirming payout draft (Optional)

PUT /api/public/v1/payouts/:id

Confirms a payout draft and queues it for broadcast. The draft transitions from draft to processing — the same end state as the direct create endpoint. Once confirmed, the payout cannot be recalled.

The txid field is null immediately after confirmation and is populated once the transaction is broadcast. Poll Read Payout to track progress.

cURL

curl -X "PUT" "https://api.sandbox.txn.io/api/public/v1/payouts/6ecebf80-b210-413b-b396-df4760d142c5" \
     -H 'Content-Type: application/vnd.api+json' \
     -H 'Authorization: Bearer <api_key>'

Headers

Name

Value

Content-Type

application/vnd.api+json

Authorization

Bearer <api_key>

Response Body

Name

Type

Description

data.id

string

Payout ID.

data.type

string

Always payouts.

data.attributes.reference

string

Your internal correlation key, as set at creation.

data.attributes.status

string

Always processing after confirmation. See Payout Status Flow.

data.attributes.address

string

Recipient's wallet address.

data.attributes.createdAt

string

ISO 8601 timestamp of when the draft was created.

data.attributes.expiresAt

string

ISO 8601 timestamp of when the draft rate lock expired.

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 immediately after confirmation — populated once 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. Ripple.

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. Always null for API-created payouts.

data.attributes.binanceStatus

string

Binance Pay processing status. Present only for binance_pay payouts.

Response

{
  "data": {
    "id": "6ecebf80-b210-413b-b396-df4760d142c5",
    "type": "payouts",
    "attributes": {
      "absorbFees": null,
      "absorbNetworkFee": false,
      "absorbPayoutFee": true,
      "address": "rLsBa2vWV2uuPx2UKbocAZG2WHXoaGyMPf?dt=61",
      "amount": "1000.00",
      "amountCharged": "22.70",
      "amountChargedCurrency": "USD",
      "approvalStatus": null,
      "binanceStatus": null,
      "createdAt": "2026-04-01T06:59:51.932Z",
      "currency": "TRY",
      "displayFee": "10.00",
      "displayFeeCurrency": "TRY",
      "exchangeRate": "62.412880924926",
      "expiresAt": "2026-04-01T07:00:21.932Z",
      "networkFee": "1.000000",
      "networkFeeCurrency": "XRP",
      "payAmount": "15.022334",
      "payChargeRate": "1.403066",
      "payChargeRateCurrency": "USD",
      "payCurrency": "XRP",
      "payNetwork": "txrp",
      "payNetworkName": "Ripple",
      "paymentMethod": "on_chain",
      "payoutFee": "0.22",
      "payoutFeeCurrency": "USD",
      "receiverBinanceId": null,
      "reference": "c5d423bb-3b08-44ba-9816-0ac633ef6081",
      "status": "processing",
      "txid": null
    },
    "relationships": {
      "accountCharged": {
        "data": {
          "id": "80b8dd61-35bc-49cc-9e04-f2c0f741a096",
          "type": "accounts"
        }
      },
      "author": {
        "data": {
          "id": "b56961f4-46cf-4e60-bb32-b36addb09f66",
          "type": "apiKeys"
        }
      }
    }
  },
  "included": [
    {
      "id": "80b8dd61-35bc-49cc-9e04-f2c0f741a096",
      "type": "accounts",
      "attributes": {
        "balance": "423.98",
        "bankDepositAvailable": true,
        "bankReference": "BDR3455470827278341",
        "bankWithdrawalAvailable": false,
        "currencyCode": "USD",
        "currencyType": "fiat",
        "label": "master",
        "master": true,
        "totalBalance": null,
        "transferAvailable": true
      },
      "relationships": {
        "company": { "meta": { "included": false } },
        "networks": { "meta": { "included": false } },
        "txnBankCredentials": { "meta": { "included": false } }
      }
    },
    {
      "id": "b56961f4-46cf-4e60-bb32-b36addb09f66",
      "type": "apiKeys",
      "attributes": {
        "createdAt": "2024-06-17T19:41:33.398Z",
        "name": "Test API key"
      }
    }
  ],
  "meta": {},
  "jsonapi": {
    "version": "1.0"
  }
}

{
  "errors": [
    {
      "status": 422,
      "title": "amount is below minimum",
      "detail": "amount: 10.0, minimum: 50.00",
      "code": "amount_below_minimum"
    }
  ]
}

Amount too low.

{
  "errors": [
    {
      "status": 422,
      "title": "amount is above maximum",
      "detail": "amount: 500000.0, maximum: 100000.00",
      "code": "amount_above_maximum"
    }
  ]
}

Amount too high.

{
  "errors": [
    {
      "status": 422,
      "title": "Invalid attribute",
      "detail": "Reference has already been taken",
      "code": "payout_invalid",
      "source": {
        "pointer": "/data/attributes/externalId"
      }
    }
  ]
}

Duplicate reference.

{
  "errors": [
    {
      "status": 422,
      "title": "account has insufficient balance",
      "code": "account_has_insufficient_balance"
    }
  ]
}

Your source account has insufficient funds.

{
  "errors": [
    {
      "status": 422,
      "title": "We couldn't send funds to this address, please try another address",
      "code": "address_has_high_risk_score"
    }
  ]
}

Destination wallet address risk profile is too high.

PreviousDrafting payout (Optional)NextReading payout

Last updated 5 days ago