NatWest Group Products API is one of 21 APIs that NatWest Group publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Products. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
2 operations
across 2 paths,
and defines 46 schemas.
It is described by OpenAPI 3.0.0, at version 3.1.11.
Requests are made against a single base URL, /open-banking/v3.1/aisp.
The identity and technical contract details declared by the specification.
NatWest Group 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 ASPSPPSUOAuth2Security — 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
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_InterestRateType1Code_0
string
Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
OB_Amount1_4
string
Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)
OB_FeeFrequency1Code_0
string
Frequency at which the overdraft charge is applied to the account
OB_OtherCodeType1_6
object
Other application frequencies not covered in the standard code list
3 properties
2 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
3 required
Number_1
integer
fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
OB_OtherCodeType1_5
object
Other fee rate type which is not in the standard rate type list
3 properties
2 required
Meta
object
Meta Data relevant to the payload
3 properties
OB_InterestCalculationMethod1Code
string
Methods of calculating interest
OB_InterestRateType1Code_1
string
Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)
OB_Period1Code
string
Period e.g. day, week, month etc. for which the fee/charge is capped
OBError1
object
4 properties
2 required
Links
object
Links relevant to the payload
5 properties
1 required
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OB_OtherCodeType1_8
object
Other fee rate type which is not available in the standard code set
3 properties
2 required
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…
OB_OtherCodeType1_2
object
Other calculation frequency which is not available in the standard code set.
3 properties
2 required
OB_MinMaxType1Code
string
Min Max type
OB_InterestFixedVariableType1Code
string
Type of interest rate, Fixed or Variable
OB_FeeFrequency1Code_1
string
How often is the overdraft fee/charge calculated for the account.
OB_Rate1_0
string
Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)
OB_FeeFrequency1Code_4
string
Period e.g. day, week, month etc. for which the fee/charge is capped
OBBCAData1
object
4 properties
OB_Amount1_1
string
Every additional tranche of an overdraft balance to which an overdraft fee is applied
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OB_OtherFeeChargeDetailType
object
Other Fee/charge type which is not available in the standard code set
4 properties
3 required
OBPCAData1
object
4 properties
OB_FeeFrequency1Code_2
string
How frequently the fee/charge is applied to the account
OB_Rate1_1
string
Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)
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_4
object
Other fee rate type code which is not available in the standard code set
3 properties
2 required
OBReadProduct2
object
Product details of Other Product which is not avaiable in the standard list
3 properties
1 required
Description_3
string
Description to describe the purpose of the code
OB_FeeFrequency1Code_3
string
How frequently the fee/charge is calculated
OB_OtherCodeType1_1
object
Other application frequencies that are not available in the standard code list
3 properties
2 required
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_FeeType1Code
string
Fee/Charge Type
OB_CodeMnemonic
string
The four letter Mnemonic used within an XML file to identify a code
OB_OtherCodeType1_3
object
Other Fee type which is not available in the standard code set
3 properties
2 required
Name_4
string
Long name associated with the code
OB_FeeCategory1Code
string
Categorisation of fees and charges into standard categories.
OB_OtherCodeType1_0
object
3 properties
2 required
OB_OtherCodeType1_7
object
Other calculation frequency which is not available in standard code set.
3 properties
2 required
OB_OverdraftFeeType1Code
string
Overdraft fee type
OB_Amount1_0
string
Cap amount charged for a fee/charge
The full machine-readable OpenAPI contract behind this narrative.
Other APIs NatWest Group publishes across the network.
