TRtruelayer
Accounts

Get Account Balance

Fetches the balance of a connected account.

This API must be called using a client_credentials bearer token.

get/v3/connected-accounts/{account_id}/balance

Request

  • Base URL
    https://api.truelayer-sandbox.com
  • URL
    https://api.truelayer-sandbox.com/v3/connected-accounts/{account_id}/balance
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://auth.truelayer.com/connect/token scopes: data

Path parameters

account_idstring required

The unique identifier of the account.

Headers

Connection-Idstring required

The unique identifier of the data connection.

Tl-User-IPstring

Used to collect and record the end-user's IP address. The first IP address in the list will be used as the end-user IP address. Necessary to overcome 4 calls per day rate limits.

Response

Balance

currencystring required

Specified as a 3-letter ISO 4217 currency code.

current_balance_in_minorinteger required

The amount of funds within the account, expressed in the smallest denomination of the account's currency. This does not include any pending transactions.

available_balance_in_minorinteger

The amount of funds available to the account holder, expressed in the smallest denomination of the account's currency. This takes into account any pending transactions and includes any overdraft facility.

overdraft_in_minorinteger

The pre-arranged overdraft limit on the account, expressed in the smallest denomination of the account's currency.

Example response

{
  "currency": "GBP",
  "current_balance_in_minor": 125050,
  "available_balance_in_minor": 172550,
  "overdraft_in_minor": 50000
}

Changes

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