VA - Retrieve Account Details and Balances

When an End User signs is registered in your Exchange or Application, you should keep track of all new accounts.

You can retrieve all Accounts and balances from an End User or a specific Virtual Account. The account's balance is available in the accounts list by default and does not have to be queried separately.

There are two types of balances:

  • Account balance is the total balance of the account without any pending deposits or other trade blockages.
  • Available balance is the balance that can be used on a trade or other types of transactions.

List all End User Accounts by CustomerId

Request Example:

curl --location --request GET 'https://api.tatum.io/v3/ledger/account/customer/5fb7bdf6e96d9ab593e191a6?pageSize=50' \
--header 'x-api-key: {YOUR_API_KEY}'
//Response:
[
  {
    "currency": "BTC",
    "active": true,
    "balance": {
        "accountBalance": "0.001",
        "availableBalance": "0.001"
    },
    "frozen": false,
    "accountingCurrency": "EUR",
    "xpub": "tpubDE8GQ9vAXpwkp37PCCRUpCoeShpC4WiCcACxh8r3nnKjfRPRqw3w58EgkfNiBy1MaRqX1oAAxwAxauEUG7vWupSh5m15znGy7vE7aE6CWzb",
    "customerId": "5fb7bdf6e96d9ab593e191a6"
    "id": "5fb7bdf6e96d9ab593e191a5"
  }
]

List all details from a Virtual Account ID

List all Accounts within the VA ledger

List all Deposit Addresses from an Account