TRtruelayer
Accounts

Get account balance

Get balance for specified account

get/accounts/{account_id}/balance

Request

  • Base URL
    https://api.truelayer-sandbox.com/data/v1
  • URL
    https://api.truelayer-sandbox.com/data/v1/accounts/{account_id}/balance
  • Auth
    OAuth 2
    Authorization code: https://auth.truelayer.com/token/connect
    Token URL: https://auth.truelayer.com/token/connect scopes: accounts, balance

Path parameters

account_idstring required
Example:f1234560abf9f57287637624def390871

Unique ID for an account or card

Query parameters

async'true'

When set to true, data is fetched asynchronously. Expect 202 status code

webhook_uristring uri

When async is set to true, a webhook will be POSTed to the URI provided

Headers

X-Client-Correlation-Idstring

Client-specified ID used to debug requests

X-PSU-IPstring

IP address of the end user requesting data. Necessary to overcome 4 calls per day rate limits

Response

OK

status'Succeeded' | 'Queued' | 'Running' | 'Failed'

Indicates whether the request was successful. 'Queued', 'Running' and 'Failed' can be returned for async requests.

Example response

{
  "status": "Succeeded"
}

Changes

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