TAtatum
Transaction

Find transactions with a given reference across all accounts.

/v3/ledger/transaction/reference/{reference}

1 credit per API call.

Finds transactions for all accounts with the given reference.

get/v3/ledger/transaction/reference/{reference}

Request

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

Path parameters

referencestring required

Response

OK

accountIdstring required

Source account - source of transaction(s)

counterAccountIdstring

Counter account - transaction(s) destination account. In case of blockchain recipient, this is addess of blockchain account.

currencystring required

Transaction currency

amountstring required

Amount in account's currency

anonymousboolean required

Whether the transaction is anonymous. If true, counter account owner does not see source account.

creatednumber required

Time in UTC of transaction.

operationType'PAYMENT' | 'WITHDRAWAL' | 'BLOCKCHAIN_TRANSACTION' | 'EXCHANGE' | 'FAILED' | 'DEPOSIT' | 'MINT' | 'REVOKE' required

Type of operation.

transactionType'FAILED' | 'DEBIT_PAYMENT' | 'CREDIT_PAYMENT' | 'CREDIT_DEPOSIT' | 'DEBIT_WITHDRAWAL' | 'CANCEL_WITHDRAWAL' | 'DEBIT_OUTGOING_PAYMENT' | 'CREDIT_INCOMING_PAYMENT' | 'EXCHANGE_BUY' | 'EXCHANGE_SELL' required

Type of payment.

referencestring required

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

transactionCodestring

For bookkeeping to distinct transaction purpose.

senderNotestring

Note visible for sender.

recipientNotestring

Note visible for both sender and recipient.

paymentIdstring

Payment ID defined in payment order by sender.

attrstring

Present only for operationType WITHDRAWAL and XLM / XRP based accounts it represents message or destinationTag of the recipient, if present.

addressstring

For operationType DEPOSIT it represents address, on which was deposit credited for the account.

txIdstring

For operationType DEPOSIT, BLOCKCHAIN_TRANSACTION it represents transaction id, for which deposit occured.

Example response

[
  {
    "accountId": "5e6645712b55823de7ea82f1",
    "counterAccountId": "5e6645712b55823de7ea82f1",
    "currency": "BTC",
    "amount": "0.1",
    "created": 1572031674384,
    "marketValue": {
      "amount": "1235.56",
      "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"
  }
]

Changes

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