Retrieve an account balance

Get the balance of an account.

See also Tutorials: Get account and transaction information.

Request​

Path parameters

Path parameters

The ID of the account.

Header parameters

Header parameters

The unique ID of the ASPSP that the request is issued to. The ID of Revolut is 001580000103UAvAAM.

Pattern: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

The date and time when the PSU last logged in with the TPP.

All dates in the HTTP headers are represented as RFC 7231 Full Dates. For example: Sun, 10 Sep 2017 19:43:31 UTC.

The IP address of the PSU if the PSU is logged in with the TPP.

An RFC4122 UUID used as a correlation ID.

The access token that you've generated. For more information, see Generate an access token.

The user agent that the PSU is using.

Response​

Balances Read

HTTP headers

HTTP headers

An RFC4122 UUID used as a correlation ID.

Response body

Body object

The balance details.

Possible number of items: non-empty

A list of elements to define the balance details.

Possible length: non-empty and <= 40 characters

The unique and immutable ID to identify the account resource. This ID has no meaning to the account owner.

Possible values: [Credit, Debit]

Indicates whether the balance is a credit or a debit balance.

Note

A zero balance is considered a credit balance.

Possible values: [InterimAvailable, InterimBooked, ClosingAvailable, ClosingBooked, ClosingCleared, Expected, ForwardAvailable, Information, InterimAvailable, InterimBooked, InterimCleared, OpeningAvailable, OpeningBooked, OpeningCleared, PreviouslyClosedBooked]

The balance type.

The date and time for the balance.

All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone.

For example: 2017-04-05T10:43:07+00:00.

The amount of the cash balance after a transaction entry is applied to the account.

Pattern: Value must match regular expression ^\d{1,13}\.\d{1,5}$

The amount of money where the unit of currency is explicit and compliant with ISO 4217.

Pattern: Value must match regular expression ^[A-Z]{3,3}$

ISO 4217 currency code in upper case.

A list of elements to provide details on the credit line.

Indicates whether the credit line is included in the balance of the account.

Note

If set to false, credit line is not included in the account balance.

Possible values: [Available]

The limit type.

The amount of the cash balance after a transaction entry is applied to the account.

Pattern: Value must match regular expression ^\d{1,13}\.\d{1,5}$

The amount of money where the unit of currency is explicit and compliant with ISO 4217.

Pattern: Value must match regular expression ^[A-Z]{3,3}$

ISO 4217 currency code in upper case.

Links relevant to the payload.

The absolute URI to the resource.

The absolute URI to the next pagination resource.

The absolute URI to the previous pagination resource.

Meta data relevant to the payload.

Used for pagination. Indicates how many pages of results are available.