I am developing for the

market, looking for the

API Documentation.

Home

>

API Products

>

United Kingdom - Accounts and Transactions PSD2 API Documentation

Accounts and Transactions PSD2

Summary

The Account and Transaction API allows a TPP to retrieve account and transaction data for CPB Customers through a secure interface.

The sandbox provides synthetic data to enable a TPP to explore the API and perform preliminary functional testing on a simulated environment. The calls to the API will be validated for correctness and compliance with the API specification to help the TPP uncover issues early when integrating with the API.

Below are some sample test data and unique identifiers that can be used for invoking the APIs and for recreating specific scenarios for validation and testing by the TPP. Some of the characteristics of the sandbox are listed below:

  • It uses a primarily stateless interaction model where some states such as the account balance is kept constant.
  • In the case of the Account & Transaction API, the invocations to retrieve the account information and balances will assume that a consent has been authorized for the list of accounts below for the purpose of demonstration. However, if the user wishes to test out the full end-to-end consent authorization flow, the user is free to do so by invoking the Authorize API or using the API Playground's 3-Legged Authentication Flow. In the fully functional market integrated version of the API, the consent context will be bound to the access token so that no additional changes would need to be done by the TPP to transfer the consent context to the API, and everything works seamlessly.
  • The sandbox implements an OAuth 2.0 based Authentication and Authorization flow. In addition to using the API Playground to invoke the APIs, the API keys retrieved while registering an application can be used for calling the APIs from any REST client, such as curl, Postman, SoapUI, or programmatically through REST calls using access tokens retrieved either through a Client Credential or Authorization Code grant types depending on the API being invoked.
  • As the sandbox is open to both TPPs and the general public, the following validations will be deferred to the integration environments: verification of TPP identity, SSA, EIDAS, QSEAL, QWAC certificates, mutual TLS. These validations will be available in the fully functional market integrated interfaces with valid Competent Authority issued certificates.
  • 3-legged authentication requests for this API must be of the 'cpb_ob_accounts' scope.

To simulate the ReadAccountBasic and ReadAccountDetail permissions, the accounts have been mapped to the permissions as follows so that the Balances, Standing Order, Schedule Payments and Transactions APIs will return the required level of detail in the responses based on the account that is being queried:

Sample Account IDsPermission
111001ReadAccountDetail
111002ReadAccountBasic

The Accounts and Transactions PSD2 API uses the authorization_code grant type, for authorization details CLICK HERE

Want to try this API out on our Playground?

Go play now
Endpoints on this page
post /open-banking/v3.1/aisp/account-access-consents Creates an account access consent
get /open-banking/v3.1/aisp/account-access-consents/{ConsentId} Retrieve an account access consent
delete /open-banking/v3.1/aisp/account-access-consents/{ConsentId} Delete an account access consent
get /open-banking/v3.1/aisp/accounts Retrieve the list of accounts
get /open-banking/v3.1/aisp/accounts/{AccountId} Retrieve account information for a given account
get /open-banking/v3.1/aisp/accounts/{AccountId}/balances Retrieve balance information for a given account
get /open-banking/v3.1/aisp/accounts/{AccountId}/beneficiaries Get beneficiaries
get /open-banking/v3.1/aisp/accounts/{AccountId}/direct-debits Get direct debits
get /open-banking/v3.1/aisp/accounts/{AccountId}/offers Get offers
get /open-banking/v3.1/aisp/accounts/{AccountId}/party Get parties linked to the account
get /open-banking/v3.1/aisp/accounts/{AccountId}/product Get products
get /open-banking/v3.1/aisp/accounts/{AccountId}/scheduled-payments Retrieve scheduled payments
get /open-banking/v3.1/aisp/accounts/{AccountId}/standing-orders Retrieve standing orders for an account
get /open-banking/v3.1/aisp/accounts/{AccountId}/statements Get statements for an account
get /open-banking/v3.1/aisp/accounts/{AccountId}/statements/{StatementId} Get statement details
get /open-banking/v3.1/aisp/accounts/{AccountId}/statements/{StatementId}/file Get statement details in non-json format
get /open-banking/v3.1/aisp/accounts/{AccountId}/statements/{StatementId}/transactions Get transactions
get /open-banking/v3.1/aisp/accounts/{AccountId}/transactions Retrieve transactions for an account
get /open-banking/v3.1/aisp/balances Returns the account balances for all authorised accounts
get /open-banking/v3.1/aisp/beneficiaries Returns the list of beneficiaries
get /open-banking/v3.1/aisp/direct-debits Get direct debits
get /open-banking/v3.1/aisp/offers Get offers
get /open-banking/v3.1/aisp/party Get party
get /open-banking/v3.1/aisp/products Get products
get /open-banking/v3.1/aisp/scheduled-payments Retrieve the scheduled payments
get /open-banking/v3.1/aisp/standing-orders Retrieve the list of standing orders
get /open-banking/v3.1/aisp/statements Get statements
get /open-banking/v3.1/aisp/transactions Retrieve the transactions for all authorized accounts

Creates an account access consent

post /open-banking/v3.1/aisp/account-access-consents
Description

Request CPB to create a new account-access-consent resource and which effectively allows the TPP to send a copy of the consent to CPB to authorise access to account and transaction information. The TPP is not able to pre-select a set of accounts for account-access-consent authorization from CPB. CPB will create the account-access-consent resource and responds with a unique ConsentId to refer to the resource. Prior to calling the API, the TPP must have an access token issued by CPB using a client credential grant.

Body Parameters
OBReadConsent1Param
required
Default
Show schema
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
201

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
415

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Retrieve an account access consent

get /open-banking/v3.1/aisp/account-access-consents/{ConsentId}
Description

Retrieve an account-access-consent resource for a given ConsentId. Prior to calling the API, the TPP must have an access token issued by CPB using a client credentials grant.

Path Parameters
ConsentId
string required
ConsentId
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Delete an account access consent

delete /open-banking/v3.1/aisp/account-access-consents/{ConsentId}
Description

Request CPB to revoke a given account access consent for the TPP. TPP must delete the account-access-consent resource with the CPB after getting confirmation about consent revocation from the CPB client. This can be done by making a call to DELETE the account-access-consent-resource. Prior to calling the API, the TPP must have an access token issued by CPB using a client credentials grant.

Path Parameters
ConsentId
string required
ConsentId
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
204

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Retrieve the list of accounts

get /open-banking/v3.1/aisp/accounts
Description

TPP will be given the full list of accounts (the AccountId(s)) that the CPB Client has authorised the TPP to access. The AccountId(s) returned may then be used to retrieve other resources for a specific AccountId. The selection of accounts happens only on a CPB application.

Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Retrieve account information for a given account

get /open-banking/v3.1/aisp/accounts/{AccountId}
Description

Used by the TPP to retrieve the account details of the CPB Client for the given AccountId.

Path Parameters
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Retrieve balance information for a given account

get /open-banking/v3.1/aisp/accounts/{AccountId}/balances
Description

Used by the TPP to retrieve the account balance information for a specific authorized AccountId.

Path Parameters
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Get beneficiaries

get /open-banking/v3.1/aisp/accounts/{AccountId}/beneficiaries
Description

This operation is currently not implemented by CPB. Invoking this endpoint will result in an HTTP 404 (Not Found)

Path Parameters
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Get direct debits

get /open-banking/v3.1/aisp/accounts/{AccountId}/direct-debits
Description

This operation is currently not implemented by CPB. Invoking this endpoint will result in an HTTP 404 (Not Found)

Path Parameters
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Get offers

get /open-banking/v3.1/aisp/accounts/{AccountId}/offers
Description

This operation is currently not implemented by CPB. Invoking this endpoint will result in an HTTP 404 (Not Found)

Path Parameters
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Get parties linked to the account

get /open-banking/v3.1/aisp/accounts/{AccountId}/party
Description

This operation is currently not implemented by CPB. Invoking this endpoint will result in an HTTP 404 (Not Found)

Path Parameters
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Get products

get /open-banking/v3.1/aisp/accounts/{AccountId}/product
Description

This operation is currently not implemented by CPB. Invoking this endpoint will result in an HTTP 404 (Not Found)

Path Parameters
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Retrieve scheduled payments

get /open-banking/v3.1/aisp/accounts/{AccountId}/scheduled-payments
Description

Used by the TPP to get the scheduled payment details of the CPB Client for the provided AccountId.

Path Parameters
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Retrieve standing orders for an account

get /open-banking/v3.1/aisp/accounts/{AccountId}/standing-orders
Description

Used by the TPP to retrieve standing order details of the CPB Client for the provided AccountId.

Path Parameters
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Get statements for an account

get /open-banking/v3.1/aisp/accounts/{AccountId}/statements
Description

This operation is currently not implemented by CPB. Invoking this endpoint will result in an HTTP 404 (Not Found)

Path Parameters
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
Query Parameters
fromStatementDateTime
string Optional
The UTC ISO 8601 Date Time to filter statements FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, CPB will ignore the timezone component.
toStatementDateTime
string Optional
The UTC ISO 8601 Date Time to filter statements TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, CPB will ignore the timezone component.
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Get statement details

get /open-banking/v3.1/aisp/accounts/{AccountId}/statements/{StatementId}
Description

This operation is currently not implemented by CPB. Invoking this endpoint will result in an HTTP 404 (Not Found)

Path Parameters
StatementId
string required
StatementId
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
string required
Client Id generated during application registration
  • cURL
  • Ruby
  • Python
  • PHP
  • Java
  • Node
  • Go
  • Swift

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Example Request

Responses
200

This operation returns no content.
400

This operation returns no content.
401

This operation returns no content.
403

This operation returns no content.
404

This operation returns no content.
405

This operation returns no content.
406

This operation returns no content.
429

This operation returns no content.
500

This operation returns no content.

Get statement details in non-json format

get /open-banking/v3.1/aisp/accounts/{AccountId}/statements/{StatementId}/file
Description

This operation is currently not implemented by CPB. Invoking this endpoint will result in an HTTP 404 (Not Found)

Path Parameters
StatementId
string required
StatementId
AccountId
string required
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Header Parameters
Accept
string required
application/json
x-fapi-financial-id
string required
The unique id of CPB to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
string Optional
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
x-fapi-customer-ip-address
string Optional
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
string Optional
An RFC4122 UID used as a correlation id.
Authorization
string required
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
x-customer-user-agent
string Optional
Indicates the user-agent that the PSU is using.
client_id
<