Accounts

This API allows TPPs to retrieve account information such as balance, transaction history, and payment details for both primary and virtual accounts.

Get Accounts

get
Required scopes
This endpoint requires the following scopes:
  • : Ability to read Accounts information
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Header parameters
x-fapi-financial-idstringRequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestringOptional

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Pattern: ^(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)$
x-fapi-customer-ip-addressstringOptional

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstringOptional

An RFC4122 UID used as a correlation id.

AuthorizationstringOptional

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 - required for API calls but may be ommited when using Swagger UI where the "Authorize" function has been operated

x-customer-user-agentstringOptional

Indicates the user-agent that the PSU is using.

Responses
200

Accounts Read

get
/accounts

No content

Get Accounts

get
Required scopes
This endpoint requires the following scopes:
  • : Ability to read Accounts information
Authorizations
OAuth2authorizationCodeRequired
Authorization URL: Token URL:
Path parameters
AccountIdstringRequired

AccountId

Header parameters
x-fapi-financial-idstringRequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestringOptional

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Pattern: ^(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)$
x-fapi-customer-ip-addressstringOptional

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstringOptional

An RFC4122 UID used as a correlation id.

AuthorizationstringOptional

An Authorisation Token as per https://tools.ietf.org/html/rfc6750 - required for API calls but may be ommited when using Swagger UI where the "Authorize" function has been operated

x-customer-user-agentstringOptional

Indicates the user-agent that the PSU is using.

Responses
200

Accounts Read

get
/accounts/{AccountId}

No content

Last updated