NatWest Group Transactions API
The Transactions API from NatWest Group — 3 operation(s) for transactions.
NatWest Group Transactions 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 Transactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 3 operations across 3 paths, and defines 49 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.
3 operations
3 paths
49 schemas
3 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
NatWest Group Transactions 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 ASPSPPSUOAuth2Security— 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 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
Transactions 3
GET
/accounts/{AccountId}/statements/{StatementId}/transactions
Get Transactions
GET
/accounts/{AccountId}/transactions
Get Transactions
GET
/transactions
Get Transactions
Schemas 49
The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are OBTransaction6 (24 properties), OBPostalAddress6 (10 properties), OBCurrencyExchange5 (7 properties), Links (5 properties). Each schema is shown below with its type and property counts.
OBEntryStatus1Code
string
Status of a transaction entry on the books of the account servicer.
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:…
OBReadTransaction6
object
3 properties
1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
3 required
OBCreditDebitCode_2
string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance.
OBTransactionCashBalance
object
Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied…
3 properties
3 required
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties
2 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.
OBTransactionMutability1Code
string
Specifies the Mutability of the Transaction record.
OBActiveOrHistoricCurrencyAndAmount_10
object
Transaction charges to be paid by the charge bearer.
2 properties
2 required
TransactionId
string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBBankTransactionCodeStructure1
object
Set of elements used to fully identify the type of underlying transaction resulting in an entry.
2 properties
2 required
Links
object
Links relevant to the payload
5 properties
1 required
OBCashAccount6_0
object
Unambiguous identification of the account of the creditor, in the case of a debit transaction.
4 properties
OBAddressTypeCode
string
Identifies the nature of the postal address.
OBActiveOrHistoricCurrencyAndAmount_9
object
Amount of money in the cash transaction entry.
2 properties
2 required
BookingDateTime
string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the st…
TransactionReference
string
Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
2 properties
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.
ProprietaryBankTransactionCodeStructure1
object
Set of elements to fully identify a proprietary bank transaction code.
2 properties
1 required
AddressLine
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
OBCashAccount6_1
object
Unambiguous identification of the account of the debtor, in the case of a crebit transaction.
4 properties
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.
StatementReference
string
Unique reference for the statement. This reference may be optionally populated if available.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
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…
OBTransaction6
object
Provides further details on an entry in the report.
24 properties
5 required
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
7 properties
2 required
OBCreditDebitCode_1
string
Indicates whether the transaction is a credit or a debit entry.
OBExternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBReadDataTransaction6
object
1 property
OBBranchAndFinancialInstitutionIdentification6_1
object
Financial institution servicing an account for the creditor.
4 properties
Identification_2
string
Unique and unambiguous identification of a financial institution or a branch of a financial institution.
OBExternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
OBTransactionCardInstrument1
object
Set of elements to describe the card instrument used in the transaction.
4 properties
1 required
OBBranchAndFinancialInstitutionIdentification6_2
object
Financial institution servicing an account for the debtor.
4 properties
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…
OBBalanceType1Code
string
Balance type, in a coded form.
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…
ValueDateTime
string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NatWest Group 12
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 Direct Debits 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
#Transactions