How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UK Open Banking Products API

The Products API from UK Open Banking — 2 operation(s) for products.

UK Open Banking Products API is one of 42 APIs that UK Open Banking publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Product. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and rate-limit docs.

This API exposes 2 operations across 2 paths, and defines 47 schemas. It is described by OpenAPI 3.0.0, at version 4.0.1.

Requests are made against a single base URL, /open-banking/v4.0/aisp.

2 operations 2 paths 47 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.1
Base URL
https://{aspsp-host}/open-banking/v4.0
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

UK Open Banking Products API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (TPPOAuth2Security) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (PSUOAuth2Security) using the authorizationCode flow, exposing 1 scope.

  • TPPOAuth2Security — TPP client credential authorisation flow with the ASPSP
  • PSUOAuth2Security — 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

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Products 2
GET
/accounts/{AccountId}/product
Get Product for an AccountId
GetAccountsAccountIdProduct 7 params → 200400401403404405406429
GET
/products
Get Products
GetProducts 6 params → 200400401403404405406429

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are Links (5 properties), OBErrorResponse1 (4 properties), OBPCAData1 (4 properties), OBBCAData1 (4 properties). Each schema is shown below with its type and property counts.

OB_FeeFrequency1Code_3
string
How frequently the fee/charge is calculated
OB_InterestRateType1Code_1
string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
OB_OverdraftFeeType1Code
string
Overdraft fee type
OB_Amount1_0
string
Cap amount charged for a fee/charge
Meta
object
Meta Data relevant to the payload
3 properties
OB_Period1Code
string
Period e.g. day, week, month etc. for which the fee/charge is capped
OB_Amount1_1
string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
OB_InterestCalculationMethod1Code
string
Methods of calculating interest
OBError1
object
4 properties 1 required
OB_FeeFrequency1Code_4
string
Period e.g. day, week, month etc. for which the fee/charge is capped
OBBCAData1
object
4 properties
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OB_OtherCodeType1_5
object
Other fee rate type which is not in the standard rate type list
3 properties 2 required
OB_Rate1_1
string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
OB_MinMaxType1Code
string
Min Max type
OB_OtherCodeType1_7
object
Other calculation frequency which is not available in standard code set.
3 properties 2 required
OB_FeeCategory1Code
string
Categorisation of fees and charges into standard categories.
OB_FeeFrequency1Code_2
string
How frequently the fee/charge is applied to the account
Number_0
integer
Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it s part of a government scheme, or whether the…
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
OB_Amount1_2
string
Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)
OB_OtherCodeType1_2
object
Other calculation frequency which is not available in the standard code set.
3 properties 2 required
OB_OtherCodeType1_1
object
Other application frequencies that are not available in the standard code list
3 properties 2 required
OB_Amount1_3
string
Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
OB_OtherCodeType1_8
object
Other fee rate type which is not available in the standard code set
3 properties 2 required
OB_InterestRateType1Code_0
string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
OBReadProduct2
object
Product details of Other Product which is not available in the standard list
3 properties 1 required
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
object
Links relevant to the payload
5 properties 1 required
OB_OtherFeeChargeDetailType
object
Other Fee/charge type which is not available in the standard code set
4 properties 3 required
OB_Rate1_0
string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
Number_1
integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
OB_CodeMnemonic
string
The four letter Mnemonic used within an XML file to identify a code
ISODateTime
string
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below:…
OB_InterestFixedVariableType1Code
string
Type of interest rate, Fixed or Variable
Name_4
string
Long name associated with the code
OB_FeeType1Code
string
Fee/Charge Type
OB_OtherCodeType1_3
object
Other Fee type which is not available in the standard code set
3 properties 2 required
Description_3
string
Description to describe the purpose of the code
OB_OtherCodeType1_6
object
Other application frequencies not covered in the standard code list
3 properties 2 required
OB_FeeFrequency1Code_1
string
How often is the overdraft fee/charge calculated for the account.
OB_OtherCodeType1_4
object
Other fee rate type code which is not available in the standard code set
3 properties 2 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
OB_OtherCodeType1_0
object
3 properties 2 required
OBPCAData1
object
4 properties
OB_FeeFrequency1Code_0
string
Frequency at which the overdraft charge is applied to the account
OB_Amount1_4
string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-banking-uk-products-api-openapi.yml Raw ↑

Other APIs UK Open Banking publishes across the network.

UK Open Banking Open Data API
UK Open Banking Dynamic Client Registration API
UK Open Banking Directory API
UK Open Banking Account Access Consents API
UK Open Banking Accounts API
UK Open Banking ATM API
UK Open Banking Balances API
UK Open Banking BCA API
UK Open Banking Beneficiaries API
UK Open Banking Branch API
UK Open Banking CCC API
UK Open Banking Direct Debits API
Where this information came from

This is an independent, third-party profile of UK Open Banking Products API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.