Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NatWest Group Direct Debits API

The Direct Debits API from NatWest Group — 2 operation(s) for direct debits.

NatWest Group Direct Debits 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 Direct Debits. 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 15 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 operations 2 paths 15 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.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
Terms of Service
Resource Areas
1

Authentication & Security 2

NatWest Group Direct Debits 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.

Direct Debits 2
GET
/accounts/{AccountId}/direct-debits
Get Direct Debits
GetAccountsAccountIdDirectDebits 6 params → 200400401403404405406429
GET
/direct-debits
Get Direct Debits
GetDirectDebits 5 params → 200400401403404405406429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are Links (5 properties), OBError1 (4 properties), OBErrorResponse1 (4 properties), OBReadDirectDebit2 (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:…
DirectDebitId
string
A unique and immutable identifier used to identify the direct debit 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 properties 3 required
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties 2 required
Links
object
Links relevant to the payload
5 properties 1 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.
MandateIdentification
string
Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
Name_2
string
Name of Service User.
OBActiveOrHistoricCurrencyAndAmount_0
object
The amount of the most recent direct debit collection.
2 properties 2 required
OBExternalDirectDebitStatus1Code
string
Specifies the status of the direct debit in code form.
OBReadDirectDebit2
object
3 properties 1 required
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…
PreviousPaymentDateTime
string
Date of most recent direct debit collection.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

natwest-direct-debits-api-openapi.yml Raw ↑

Other APIs NatWest Group publishes across the network.

NatWest Group Account Access API
NatWest Group Accounts API
NatWest Group Balances API
NatWest Group Beneficiaries API
NatWest Group Domestic Payments API
NatWest Group Domestic Scheduled Payments API
NatWest Group Domestic Standing Orders API
NatWest Group File Payments API
NatWest Group Funds Confirmations API
NatWest Group International Payments API
NatWest Group International Scheduled Payments API
NatWest Group International Standing Orders API