TAtatum
Transaction

Find transactions for a customer across all of the customer's accounts.

/v3/ledger/transaction/customer

1 credit per API call.

Finds transactions for all accounts of the customer identified by the given internal customer ID.

post/v3/ledger/transaction/customer

Request

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

Query parameters

pageSizenumber
Example:10

Max number of items per page is 50. Either count or pageSize is accepted.

offsetnumber

Offset to obtain the next page of data.

countboolean

Get total transaction count based on the filter. Either count or pageSize is accepted.

Request body

idstring required

Customer internal ID to search for.

accountstring

Source account - source of transaction(s).

counterAccountstring

Counter account - transaction(s) destination account.

currencystring

Currency of the transactions.

frominteger

Starting date to search for transactions from in UTC millis. If not present, search all history.

tointeger

Date until to search for transactions in UTC millis. If not present, search up till now.

currenciesstring[]

List of currencies of the transactions.

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

Type of payment

transactionTypesstring[]

Types of payment

opType'PAYMENT' | 'WITHDRAWAL' | 'BLOCKCHAIN_TRANSACTION' | 'EXCHANGE' | 'FAILED' | 'DEPOSIT' | 'MINT' | 'REVOKE'

Type of operation.

transactionCodestring

For bookkeeping to distinct transaction purpose.

paymentIdstring

Payment ID defined in payment order by sender.

recipientNotestring

Recipient note defined in payment order by sender.

senderNotestring

Sender note defined in payment order by sender.

Example request

{
  "id": "5e6be8e9e6aa436299950c41",
  "account": "5e6be8e9e6aa436299950c41",
  "counterAccount": "5e6be8e9e6aa436299950c41",
  "currency": "BTC",
  "from": 1571833231000,
  "to": 1571833231000,
  "amount": [
    {
      "op": "gte",
      "value": "1.5"
    }
  ],
  "currencies": [
    "BTC"
  ],
  "transactionTypes": [
    "CREDIT_PAYMENT"
  ],
  "opType": "PAYMENT",
  "transactionCode": "1_01_EXTERNAL_CODE",
  "paymentId": "65426",
  "recipientNote": "65426",
  "senderNote": "65426"
}

Response

OK

OR
number required

Total transaction count.

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.