TAtatum
Virtual Currency

Destroy supply of virtual currency

/v3/ledger/virtualCurrency/revoke

2 credits per API call.

Destroy supply of virtual currency linked on the given accountId. Method decreases the total supply of the currency.
This method creates Ledger transaction with operationType REVOKE with undefined counterAccountId.

put/v3/ledger/virtualCurrency/revoke

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/ledger/virtualCurrency/revoke
  • Auth
    API key in header x-api-key

Request body

accountIdstring required

Ledger account with currency of the virtual currency, on which the operation will be performed.

amountstring required

Amount of virtual currency to operate within this operation.

paymentIdstring

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

referencestring

Reference of the payment.

transactionCodestring

For bookkeeping to distinct transaction purpose.

recipientNotestring

Note visible to both, sender and recipient. Available for both Mint and Revoke operations

counterAccountstring

External account identifier. By default, there is no counterAccount present in the transaction.

senderNotestring

Note visible to sender. Available in Revoke operation.

Example request

{
  "accountId": "5e68c66581f2ee32bc354087",
  "amount": "1.5",
  "paymentId": "My Payment",
  "reference": "akjsndakjsdn-asd-kjasnd-asdkn-asdjnasjkdn",
  "transactionCode": "1_01_EXTERNAL_CODE",
  "recipientNote": "Private note",
  "counterAccount": "5e6645712b55823de7ea82f1",
  "senderNote": "Sender note"
}

Response

OK

referencestring

The internal reference to the transaction (a unique identifier of the transaction within the virtual account); if the transaction fails, use this reference to search through the logs

Example response

{
  "reference": "0c64cc04-5412-4e57-a51c-ee5727939bcb"
}

Changes

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