TAtatum
Transaction

Send payment

/v3/ledger/transaction

4 credits per API call.

Sends a payment within Tatum Private Ledger. All assets are settled instantly.
When a transaction is settled, 2 transaction records are created, 1 for each of the participants. These 2 records are connected via a transaction reference, which is the same for both of them.
This method is only used for transferring assets between accounts within Tatum and will not send any funds to blockchain addresses.
If there is an insufficient balance in the sender account, no transaction is recorded.
It is possible to perform an anonymous transaction where the sender account is not visible for the recipient.
The FIAT currency value of every transaction is calculated automatically. The FIAT value is based on the accountingCurrency of the account connected to the transaction and is available in the marketValue parameter of the transaction.

post/v3/ledger/transaction

Request

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

Request body

senderAccountIdstring required

Internal sender account ID within Tatum platform

recipientAccountIdstring required

Internal recipient account ID within Tatum platform

amountstring required

Amount to be sent.

anonymousboolean

Anonymous transaction does not show sender account to recipient, default is false

compliantboolean

Enable compliant checks. Transaction will not be processed, if compliant check fails.

transactionCodestring

For bookkeeping to distinct transaction purpose.

paymentIdstring

Payment ID, External identifier of the payment, which can be used to pair transactions within Tatum accounts.

recipientNotestring

Note visible to both, sender and recipient

baseRatenumber

Exchange rate of the base pair. Only applicable for Tatum's Virtual currencies Ledger transactions. Override default exchange rate for the Virtual Currency.

senderNotestring

Note visible to sender

Example request

{
  "senderAccountId": "5e6645712b55823de7ea82f1",
  "recipientAccountId": "5e6645712b55823de7ea82f2",
  "amount": "5",
  "transactionCode": "1_01_EXTERNAL_CODE",
  "paymentId": "9625",
  "recipientNote": "Private note",
  "baseRate": 1,
  "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.