How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
NatWest Group

NatWest Group International Payments API

The International Payments API from NatWest Group — 5 operation(s) for international payments.

Documentation Provider Profile APIs.io OpenAPI GitHub

NatWest Group International 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 International 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 37 schemas. It is described by OpenAPI 3.2.0, at version 3.1.11.

Requests are made against a single base URL, /open-banking/v3.1/aisp.

5 operations 5 paths 37 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.1.11
Base URL
https://api.sandbox.natwest.com/open-banking/v3.1/aisp
Authentication
OAuth 2.0, OAuth 2.0
Contact
Service Desk
License
open-licence
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

NatWest Group International 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.

International Payments 5
POST
/international-payment-consents
Create International Payment Consents
CreateInternationalPaymentConsents 7 params body → 201400401403404405406415
GET
/international-payment-consents/{ConsentId}
Get International Payment Consents
GetInternationalPaymentConsentsConsentId 6 params → 200400401403404405406429
GET
/international-payment-consents/{ConsentId}/funds-confirmation
Get International Payment Consents Funds Confirmation
GetInternationalPaymentConsentsConsentIdFundsConfirmation 6 params → 200400401403404405406429
POST
/international-payments
Create International Payments
CreateInternationalPayments 7 params body → 201400401403404405406415
GET
/international-payments/{InternationalPaymentId}
Get International Payments
GetInternationalPaymentsInternationalPaymentId 6 params → 200400401403404405406429

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress6 (10 properties), OBRisk1 (8 properties), Links (5 properties), OBCashAccountDebtor4 (4 properties). Each schema is shown below with its type and property counts.

OBWriteInternationalResponse5
object
3 properties 1 required
OBWriteFundsConfirmationResponse1
object
3 properties 1 required
OBExternalExtendedAccountType1Code
string
Specifies the extended type of account.
OBExternalPaymentChargeType1Code
string
Charge type, in a coded form.
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
Department
string
Identification of a division of a large organisation or building.
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money associated with the charge type.
2 properties 2 required
BuildingNumber
string
Number that identifies the position of a building on a street.
StreetName
string
Name of a street or thoroughfare.
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
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…
Name
string
Name by which an agent is known and which is usually used to identify that agent.
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
Links
object
Links relevant to the payload
5 properties 1 required
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBError1
object
4 properties 2 required
OBCashAccountDebtor4
object
^ Only incuded in the response if Data. ReadRefundAccount is set to Yes in the consent.
4 properties
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…
OBWriteInternationalConsent5
object
2 properties 2 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:…
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.
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
OBWriteInternationalConsentResponse6
object
4 properties 2 required
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 3 required
OBAddressTypeCode
string
Identifies the nature of the postal address.
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBWriteInternational3
object
2 properties 2 required
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.
Identification_1
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
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.
CountryCode
string
Nation with its own government.
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
Meta
object
Meta Data relevant to the payload
3 properties
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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

natwest-international-payments-api-openapi.yml Raw ↑

Other APIs NatWest Group publishes across the network.

NatWest Group Account Access API
AE Profile APIs.io
NatWest Group Accounts API
AE Profile APIs.io
NatWest Group Balances API
AE Profile APIs.io
NatWest Group Beneficiaries API
AE Profile APIs.io
NatWest Group Direct Debits API
AE Profile APIs.io
NatWest Group Domestic Payments API
AE Profile APIs.io
NatWest Group Domestic Scheduled Payments API
AE Profile APIs.io
NatWest Group Domestic Standing Orders API
AE Profile APIs.io
NatWest Group File Payments API
AE Profile APIs.io
NatWest Group Funds Confirmations API
AE Profile APIs.io
NatWest Group International Scheduled Payments API
AE Profile APIs.io
NatWest Group International Standing Orders API
AE Profile APIs.io
#International Payments
← Back to N APIs
API Details
ID
natwest:natwest-international-payments-api
Base URL
https://api.sandbox.natwest.com/open-banking/v3.1/aisp
Docs
https://www.bankofapis.com/products/natwest-group-open-banking/accounts/documentation/nwb
Provider
NatWest Group
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=natwest-international-payments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/natwest-international-payments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NatWest Group International Payments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.