NatWest Group Statements 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 Statements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
4 operations
across 4 paths,
and defines 40 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.
The identity and technical contract details declared by the specification.
NatWest Group Statements 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
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:…
OBReadDataStatement2
object
1 property
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
3 required
OBStatement2
object
Provides further details on a statement resource.
16 properties
5 required
Meta
object
Meta Data relevant to the payload
3 properties
DateTime
string
Date and time associated with the date time type.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses…
OBRate1_1
number
field representing a percentage (e.g. 0.05 represents 5% and 0.9525 represents 95.25%). Note the number of decimal places may vary.
OBError1
object
4 properties
2 required
Links
object
Links relevant to the payload
5 properties
1 required
OBExternalStatementRateType1Code
string
Statement rate type, in a coded form.
Rate
string
Rate associated with the statement rate type.
CreationDateTime
string
Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses…
OBExternalStatementFeeRateType1Code
string
Description that may be available for the statement fee rate type.
OBExternalStatementInterestRateType1Code
string
Description that may be available for the statement Interest rate type.
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.
OBActiveOrHistoricCurrencyAndAmount_7
object
Amount of money associated with the statement interest amount type.
2 properties
2 required
EndDateTime
string
Date and time at which the statement period ends.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses…
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.
Value
string
Value associated with the statement value type.
OBExternalStatementValueType1Code
string
Statement value type, in a coded form.
OBExternalStatementBenefitType1Code
string
Benefit type, in a coded form.
OBReadStatement2
object
3 properties
1 required
OBExternalStatementType1Code
string
Statement type, in a coded form.
Description_2
string
Description that may be available for the statement interest.
OBRate1_0
number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
Description_1
string
Description that may be available for the statement fee.
OBCreditDebitCode_0
string
Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount.
OBExternalStatementFeeType1Code
string
Fee type, in a coded form.
OBExternalStatementInterestFrequency1Code
string
Specifies the statement fee type requested
OBExternalStatementAmountType1Code
string
Amount type, in a coded form.
OBExternalStatementFeeFrequency1Code
string
How frequently the fee is applied to the Account.
OBExternalStatementInterestType1Code
string
Interest amount type, in a coded form.
OBActiveOrHistoricCurrencyAndAmount_6
object
Amount of money associated with the statement fee type.
2 properties
2 required
StatementId
string
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
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…
OBExternalStatementDateTimeType1Code
string
Date time type, in a coded form.
OBActiveOrHistoricCurrencyAndAmount_5
object
Amount of money associated with the statement benefit type.
2 properties
2 required
StartDateTime
string
Date and time at which the statement period starts.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in respons…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs NatWest Group publishes across the network.
