TAtatum
Withdrawal

Get withdrawals

/v3/offchain/withdrawal

1 credit per API call.

Get withdrawals.

get/v3/offchain/withdrawal

Request

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

Query parameters

currencystring
Example:BTC

Currency of the withdrawal

status'InProgress' | 'Done' | 'Cancelled'
Example:Done

Status of the withdrawal

pageSizenumber required
Example:10

Max number of items per page is 50.

offsetnumber

Offset to obtain next page of the data.

Response

OK

idstring required

ID of the withdrawal

txIdstring

Transaction ID of broadcast transaction

accountIdstring required

Sender account ID

status'InProgress' | 'Done' | 'Cancelled'

Status of the withdrawal

addressstring required

Blockchain address to send assets to. For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain addresses as a comma separated string.

referencestring required

Transaction internal reference - unique identifier within Tatum ledger. In order of failure, use this value to search for problems.

amountstring required

Amount to be withdrawn to blockchain.

attrstring
<p>Used to parametrize withdrawal. Used for XRP withdrawal to define destination tag of recipient, or XLM memo of the recipient, if needed.<br/> For Bitcoin, Litecoin, Bitcoin Cash, used as a change address for left coins from transaction.</p>
currencystring

Currency of the withdrawal.

feestring required

Fee to be submitted as a transaction fee to blockchain.

multipleAmountsstring[]

For BTC, LTC, DOGE and BCH, it is possible to enter list of multiple recipient blockchain amounts. List of recipient addresses must be present in the address field and total sum of amounts must be equal to the amount field.

paymentIdstring

Identifier of the payment, shown for created Transaction within Tatum sender account.

senderNotestring

Note visible to owner of withdrawing account

Example response

[
  {
    "id": "5e68c66581f2ee32bc354088",
    "txId": "62BD544D1B9031EFC330A3E855CC3A0D51CA5131455C1AB3BCAC6D243F65460D",
    "accountId": "5e68c66581f2ee32bc354087",
    "status": "InProgress",
    "address": "mpTwPdF8up9kidgcAStriUPwRdnE9MRAg7",
    "reference": "0c64cc04-5412-4e57-a51c-ee5727939bcb",
    "amount": "0.001",
    "attr": "12345",
    "currency": "BTC",
    "fee": "0.0005",
    "multipleAmounts": [
      "0.1"
    ],
    "paymentId": "12345",
    "senderNote": "Sender note"
  }
]

Changes

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