Withdrawal

Broadcast signed transaction and complete withdrawal

/v3/offchain/withdrawal/broadcast

2 credits per API call.

Broadcast signed raw transaction end complete withdrawal associated with it. When broadcast succeeded but it is impossible to complete withdrawal, transaction id of transaction is returned and withdrawal must be completed manually.

post/v3/offchain/withdrawal/broadcast

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/offchain/withdrawal/broadcast
  • Auth
    API key in header x-api-key

Request body

currencystring required

Currency of signed transaction to be broadcast, BTC, LTC, DOGE, BNB, XLM, TRX, BCH, ETH, XRP, ERC20, TRC20

txDatastring required

Raw signed transaction to be published to network.

withdrawalIdstring

Withdrawal ID to be completed by transaction broadcast

signatureIdstring uuid

ID of prepared payment template to sign. This is should be stored on a client side to retrieve ID of the blockchain transaction, when signing application signs the transaction and broadcasts it to the blockchain.

Example request

{
  "currency": "BTC",
  "txData": "62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D",
  "withdrawalId": "5e68c66581f2ee32bc354087",
  "signatureId": "1f7f7c0c-3906-4aa1-9dfe-4b67c43918f6"
}

Response

OK

completedboolean

Flag, if withdrawal is successfully completed within Tatum systems.

txIdstring

Transaction ID of broadcast transaction and status

Example response

{
  "completed": true,
  "txId": "62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D"
}

Changes

No recorded changes to this operation across all 1 revision of this API.