NatWest Group Domestic Payments 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 Domestic Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
5 operations
across 5 paths,
and defines 34 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.
5 operations5 paths34 schemas3 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
NatWest Group Domestic Payments 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 5
Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress6 (10 properties), OBRisk1 (8 properties), Links (5 properties), OBErrorResponse1 (4 properties). Each schema is shown below with its type and property counts.
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:…
OBChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
OBSCASupportData1
object
Supporting Data provided by TPP, when requesting SCA Exemption.
3 properties
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties3 required
OBCashAccountDebtor4
object
^ Only incuded in the response if Data. ReadRefundAccount is set to Yes in the consent.
4 properties
OBExternalLocalInstrument1Code
string
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or serv…
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
Meta
object
Meta Data relevant to the payload
3 properties
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
OBExternalExtendedAccountType1Code
string
Specifies the extended type of account.
OBError1
object
4 properties2 required
Links
object
Links relevant to the payload
5 properties1 required
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBWriteDomesticResponse5
object
3 properties1 required
OBAddressTypeCode
string
Identifies the nature of the postal address.
OBActiveCurrencyAndAmount_SimpleType
string
A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money associated with the charge type.
2 properties2 required
StreetName
string
Name of a street or thoroughfare.
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
OBPostalAddress6
object
Information that locates and identifies a specific address, as defined by postal services.
10 properties
SubDepartment
string
Identification of a sub-division of a large organisation or building.
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBWriteDomestic2
object
2 properties2 required
ActiveOrHistoricCurrencyCode
string
A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international st…
OBRisk1
object
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
8 properties
OBWriteDomesticConsentResponse5
object
4 properties2 required
OBWriteFundsConfirmationResponse1
object
3 properties1 required
CountryCode
string
Nation with its own government.
OBExternalPaymentChargeType1Code
string
Charge type, in a coded form.
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
BuildingNumber
string
Number that identifies the position of a building on a street.
OBWriteDomesticConsent4
object
2 properties2 required
Department
string
Identification of a division of a large organisation or building.
Specification
The full machine-readable OpenAPI contract behind this narrative.
