NatWest Group Beneficiaries 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 Beneficiaries. 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 27 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 paths27 schemas2 GET
Metadata
The identity and technical contract details declared by the specification.
NatWest Group Beneficiaries 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 27 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress6 (10 properties), OBBeneficiary5 (7 properties), Links (5 properties), OBBranchAndFinancialInstitutionIdentification6_0 (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:…
Identification_1
string
Unique and unambiguous identification of the servicing institution.
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
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.
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.
OBBeneficiaryType1Code
string
Specifies the Beneficiary Type.
OBAddressTypeCode
string
Identifies the nature of the postal address.
OBReadBeneficiary5
object
3 properties1 required
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
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.
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OBBranchAndFinancialInstitutionIdentification6_0
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…
4 properties
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…
OBBeneficiary5
object
7 properties
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…
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
BeneficiaryId
string
A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBCashAccount5_0
object
Provides the details to identify the beneficiary account.
4 properties2 required
BuildingNumber
string
Number that identifies the position of a building on a street.
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…
Specification
The full machine-readable OpenAPI contract behind this narrative.
