NatWest Group Payment Details 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 Payment Details. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
7 operations
across 7 paths,
and defines 7 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.
7 operations7 paths7 schemas7 GET
Metadata
The identity and technical contract details declared by the specification.
NatWest Group Payment Details 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 7
Across 7 paths, the API surfaces 7 operations — 7 GET. Each is listed below with its method, path, parameters, and response codes.
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Links (5 properties), OBError1 (4 properties), OBErrorResponse1 (4 properties), Meta (3 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:…
OBWritePaymentDetailsResponse1
object
3 properties1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties3 required
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…
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties2 required
Links
object
Links relevant to the payload
5 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
