An endpoint used to create and list transactions within Tatum Private Ledger. A transaction is performed between 2 accounts with the same currency. To perform an exchange operation between accounts with different currencies, API calls from Order Book sections are available. Transactions in the ledger are instant, with a settlement time of below 200ms.
Tatum Private Ledger supports microtransactions - a transaction of an amount as little as 1e-30 (30 decimal places). Transactions are atomic.
When there is an insufficient balance in the sender account, or recipient account cannot receive funds, the transaction is not settled.
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.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
{- "senderAccountId": "5e6645712b55823de7ea82f1",
- "recipientAccountId": "5e6645712b55823de7ea82f2",
- "amount": "5",
- "anonymous": false,
- "compliant": false,
- "transactionCode": "1_01_EXTERNAL_CODE",
- "paymentId": "9625",
- "recipientNote": "Private note",
- "baseRate": 1,
- "senderNote": "Sender note"
}
{- "reference": "0c64cc04-5412-4e57-a51c-ee5727939bcb"
}
Sends the N payments 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.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to perform the required operation due to a logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
{- "senderAccountId": "5e6645712b55823de7ea82f1",
- "transaction": [
- {
- "recipientAccountId": "5e6645712b55823de7ea82f2",
- "amount": "5",
- "anonymous": false,
- "compliant": false,
- "transactionCode": "1_01_EXTERNAL_CODE",
- "paymentId": "9625",
- "recipientNote": "Private note",
- "baseRate": 1,
- "senderNote": "Sender note"
}
]
}
[- {
- "reference": "0c64cc04-5412-4e57-a51c-ee5727939bcb"
}
]
Finds transactions for the account identified by the given account ID.
pageSize | number [ 1 .. 50 ] Max number of items per page is 50. Either count or pageSize is accepted. Example: pageSize=10 |
offset | number Offset to obtain the next page of data. Example: offset=0 |
count | boolean Get the total transaction count based on the filter. Either count or pageSize is accepted. Example: count=true |
id required | string = 24 characters Account ID - source of transaction(s). | ||||
counterAccount | string = 24 characters Counter account - transaction(s) destination account. | ||||
from | integer <int64> >= 0 Starting date to search for transactions from in UTC millis. If not present, search all history. | ||||
to | integer <int64> >= 0 Date until to search for transactions in UTC millis. If not present, search up till now. | ||||
currency | string [ 1 .. 50 ] characters Currency of the transactions. | ||||
Array of objects Amount of the transaction. AND is used between filter options. | |||||
Array
| |||||
currencies | Array of strings List of currencies of the transactions. | ||||
transactionType | any Type of payment | ||||
transactionTypes | Array of strings Types of payment | ||||
opType | string Type of operation | ||||
transactionCode | string [ 1 .. 100 ] characters For bookkeeping to distinct transaction purpose. | ||||
paymentId | string [ 1 .. 100 ] characters Payment ID defined in payment order by sender. | ||||
recipientNote | string [ 1 .. 500 ] characters Recipient note defined in payment order by sender. | ||||
senderNote | string [ 1 .. 500 ] characters Sender note defined in payment order by sender. |
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Internal server error. There was an error on the server while processing the request.
{- "id": "5e6be8e9e6aa436299950c41",
- "counterAccount": "5e6be8e9e6aa436299950c41",
- "from": 1571833231000,
- "to": 1571833231000,
- "currency": "BTC",
- "amount": [
- {
- "op": "gte",
- "value": "1.5"
}
], - "currencies": [
- "BTC"
], - "transactionType": "FAILED",
- "transactionTypes": [
- "CREDIT_PAYMENT"
], - "opType": "PAYMENT",
- "transactionCode": "1_01_EXTERNAL_CODE",
- "paymentId": "65426",
- "recipientNote": "65426",
- "senderNote": "65426"
}
[ ]
Finds transactions for all accounts of the customer identified by the given internal customer ID.
pageSize | number [ 1 .. 50 ] Max number of items per page is 50. Either count or pageSize is accepted. Example: pageSize=10 |
offset | number Offset to obtain the next page of data. Example: offset=0 |
count | boolean Get total transaction count based on the filter. Either count or pageSize is accepted. Example: count=true |
id required | string = 24 characters Customer internal ID to search for. | ||||
account | string = 24 characters Source account - source of transaction(s). | ||||
counterAccount | string = 24 characters Counter account - transaction(s) destination account. | ||||
currency | string [ 1 .. 50 ] characters Currency of the transactions. | ||||
from | integer <int64> >= 0 Starting date to search for transactions from in UTC millis. If not present, search all history. | ||||
to | integer <int64> >= 0 Date until to search for transactions in UTC millis. If not present, search up till now. | ||||
Array of objects Amount of the transaction. AND is used between filter options. | |||||
Array
| |||||
currencies | Array of strings List of currencies of the transactions. | ||||
transactionType | any Type of payment | ||||
transactionTypes | Array of strings Types of payment | ||||
opType | string Type of operation. | ||||
transactionCode | string [ 1 .. 100 ] characters For bookkeeping to distinct transaction purpose. | ||||
paymentId | string [ 1 .. 100 ] characters Payment ID defined in payment order by sender. | ||||
recipientNote | string [ 1 .. 500 ] characters Recipient note defined in payment order by sender. | ||||
senderNote | string [ 1 .. 500 ] characters Sender note defined in payment order by sender. |
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Internal server error. There was an error on the server while processing the request.
{- "id": "5e6be8e9e6aa436299950c41",
- "account": "5e6be8e9e6aa436299950c41",
- "counterAccount": "5e6be8e9e6aa436299950c41",
- "currency": "BTC",
- "from": 1571833231000,
- "to": 1571833231000,
- "amount": [
- {
- "op": "gte",
- "value": "1.5"
}
], - "currencies": [
- "BTC"
], - "transactionType": "FAILED",
- "transactionTypes": [
- "CREDIT_PAYMENT"
], - "opType": "PAYMENT",
- "transactionCode": "1_01_EXTERNAL_CODE",
- "paymentId": "65426",
- "recipientNote": "65426",
- "senderNote": "65426"
}
[ ]
Find transactions across whole ledger.
pageSize | number [ 1 .. 50 ] Max number of items per page is 50. Either count or pageSize is accepted. Example: pageSize=10 |
offset | number Offset to obtain the next page of data. Example: offset=0 |
count | boolean Get the total transaction count based on the filter. Either count or pageSize is accepted. Example: count=true |
account | string = 24 characters Source account - source of transaction(s). | ||||
counterAccount | string = 24 characters Counter account - transaction(s) destination account. | ||||
currency | string [ 1 .. 50 ] characters Currency of the transactions. | ||||
from | integer <int64> >= 0 Starting date to search for transactions from in UTC millis. If not present, search all history. | ||||
Array of objects Amount of the transaction. AND is used between filter options. | |||||
Array
| |||||
currencies | Array of strings List of currencies of the transactions. | ||||
transactionType | any Type of payment | ||||
transactionTypes | Array of strings Types of payment | ||||
opType | string Type of operation. | ||||
transactionCode | string [ 1 .. 100 ] characters For bookkeeping to distinct transaction purpose. | ||||
paymentId | string [ 1 .. 100 ] characters Payment ID defined in payment order by sender. | ||||
recipientNote | string [ 1 .. 500 ] characters Recipient note defined in payment order by sender. | ||||
senderNote | string [ 1 .. 500 ] characters Sender note defined in payment order by sender. | ||||
to | integer <int64> >= 0 Date until to search for transactions in UTC millis. If not present, search up till now. |
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Internal server error. There was an error on the server while processing the request.
{- "account": "5e6be8e9e6aa436299950c41",
- "counterAccount": "5e6be8e9e6aa436299950c41",
- "currency": "BTC",
- "from": 1571833231000,
- "amount": [
- {
- "op": "gte",
- "value": "1.5"
}
], - "currencies": [
- "BTC"
], - "transactionType": "FAILED",
- "transactionTypes": [
- "CREDIT_PAYMENT"
], - "opType": "PAYMENT",
- "transactionCode": "1_01_EXTERNAL_CODE",
- "paymentId": "65426",
- "recipientNote": "65426",
- "senderNote": "65426",
- "to": 1571833231000
}
[ ]
Finds transactions for all accounts with the given reference.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Internal server error. There was an error on the server while processing the request.
curl -i -X GET \ 'https://api-eu1.tatum.io/v3/ledger/transaction/reference/{reference}' \ -H 'x-api-key: YOUR_API_KEY_HERE'
[- {
- "accountId": "5e6645712b55823de7ea82f1",
- "counterAccountId": "5e6645712b55823de7ea82f1",
- "currency": "BTC",
- "amount": "0.1",
- "anonymous": false,
- "created": 1572031674384,
- "marketValue": {
- "amount": "1235.56",
- "currency": "EUR",
- "sourceDate": 1572031674384,
- "source": "fixer.io"
}, - "operationType": "PAYMENT",
- "transactionType": "CREDIT_PAYMENT",
- "reference": "5e6be8e9e6aa436299950c41",
- "transactionCode": "1_01_EXTERNAL_CODE",
- "senderNote": "Sender note",
- "recipientNote": "Private note",
- "paymentId": "65426",
- "attr": "123",
- "address": "qrppgud79n5h5ehqt9s7x8uc82pcag82es0w9tada0",
- "txId": "c6c176e3f6705596d58963f0ca79b34ffa5b78874a65df9c974e22cf86a7ba67"
}
]