NatWest Group Scheduled 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 Scheduled Payments. 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 23 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.
2 operations2 paths23 schemas2 GET
Metadata
The identity and technical contract details declared by the specification.
NatWest Group Scheduled 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 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are OBScheduledPayment3 (9 properties), Links (5 properties), OBErrorResponse1 (4 properties), OBCashAccount5_1 (4 properties). Each schema is shown below with its type and property counts.
OBCashAccount5_1
object
Provides the details to identify the beneficiary account.
4 properties2 required
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:…
OBScheduledPayment3
object
9 properties4 required
Identification_1
string
Unique and unambiguous identification of the servicing institution.
ScheduledPaymentId
string
A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties3 required
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
OBReadScheduledPayment3
object
3 properties1 required
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.
DebtorReference
string
A reference value provided by the PSU to the PISP while setting up the scheduled payment.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OBExternalScheduleType1Code
string
Specifies the scheduled payment date type requested
Name_0
string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account n…
Reference
string
Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this…
OBActiveOrHistoricCurrencyAndAmount_1
object
Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage:…
2 properties2 required
ScheduledPaymentDateTime
string
The date on which the scheduled payment will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in respo…
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBBranchAndFinancialInstitutionIdentification5_1
object
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on t…
2 properties2 required
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
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…
ActiveOrHistoricCurrencyCode_1
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…
Specification
The full machine-readable OpenAPI contract behind this narrative.
