This API, provides the ability for approved/authorised account information providers (AISPs) to access a customer’s (payment service user, PSU) account and transaction information for domestic business current accounts (BCAs) and personal current accounts (PCAs), only when the PSU grants consent. This API is developed according to the Open Banking Read/Write API Specifications, see https://www.openbanking.org.uk
API Information
Title | Account and Transactions V3 Sandbox |
---|---|
Protocol | TLS-MA |
Open Banking Specification Version | 3.1 |
Access | Free to use but subscription is required |
Key Features:
- Transaction details: transactions in and out, description
- Account details: Account Type and Account Subtype, overdraft information
- Saved payees
- Recurring payments
- Product Details: Credit Interest rates, overdraft fees and charges and other fees and charges
New in ths version:
New end points added for
- Offers
- Party
- Scheduled Payments
- Statements
Product scope increased to include
- All GBP and non GBP banking and savings accounts
- Cahoot Accounts
- Corporate accounts regardless of turnover
- Credit Card (for the Offers end points only)
Account Details: Servicer Name and Identification added
Attachment | Size |
---|---|
![]() | 304.09 KB |
Paths
/account-access-consents
Create Account Access Consents
TPP client credential authorisation flow with the ASPSP
Default
{
"schema": {
"type": "object",
"properties": {
"Data": {
"$ref": "#\/definitions\/OBReadData1"
},
"Risk": {
"$ref": "#\/definitions\/OBRisk2"
}
},
"required": [
"Data",
"Risk"
],
"additionalProperties": false
}
}
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/account-access-consents/{ConsentId}
Get Account Access Consents
TPP client credential authorisation flow with the ASPSP
ConsentId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Delete Account Access Consents
TPP client credential authorisation flow with the ASPSP
ConsentId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts
Get Accounts
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}
Get Accounts
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/balances
Get Balances
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/beneficiaries
Get Beneficiaries
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/direct-debits
Get Direct Debits
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/offers
Get Offers
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/party
Get Party
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/product
Get Products
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/scheduled-payments
Get Scheduled Payments
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/standing-orders
Get Standing Orders
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/statements
Get Statements
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
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, the ASPSP must ignore the timezone component.
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, the ASPSP must ignore the timezone component.
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/statements/{StatementId}
Get Statements
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
StatementId
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/statements/{StatementId}/file
Get Statements
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
StatementId
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/statements/{StatementId}/transactions
Get Transactions
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
StatementId
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
Attribute description not found
/accounts/{AccountId}/transactions
Get Transactions
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
AccountId
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
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)$"
}
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component.
Indicates the user-agent that the PSU is using.
application/json; charset=utf-8
Attribute description not found
Attribute description not found
Attribute description not found