Send payment

post

https://api.tatum.io/v3/ledger/transaction

/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

senderAccountId

string

required

length between 24 and 24

Internal sender account ID within Tatum platform

recipientAccountId

string

required

length between 24 and 24

Internal recipient account ID within Tatum platform

amount

string

required

length ≤ 38

Amount to be sent.

anonymous

boolean

Defaults to false

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

compliant

boolean

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

transactionCode

string

length between 1 and 100

For bookkeeping to distinct transaction purpose.

paymentId

string

length between 1 and 100

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

recipientNote

string

length between 1 and 500

Note visible to both, sender and recipient

baseRate

number

≥ 0

Defaults to 1

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

senderNote

string

length between 1 and 500

Note visible to sender

Responses

200OK

400Bad Request

401Unauthorized. Not valid or inactive subscription key present in the HTTP Header.

403Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.

500Internal server error. There was an error on the server during the processing of the request.