Transactions v3.1.2
- 1 Version Control
- 2 Endpoints
- 3 Data Model
- 3.1 Resource Definition
- 3.2 UML Diagram
- 3.3 Filtering
- 3.3.1 Filtering Examples
- 3.4 Permission Codes
- 3.5 Data Dictionary
- 4 Usage Examples
Version Control
Version | Date | Author | Comments |
|---|---|---|---|
3.1 | Dec 3, 2018 | OB R/W API Team | This is the baseline version. |
4.0-draft1 | Dec 18, 2018 | OB R/W API Team | No changes. |
4.0-draft2 | Dec 31, 2018 | OB R/W API Team | Filtering Parameters presented in a Table to provide more detail |
4.0-draft6 | Feb 22, 2019 | OB R/W API Team | v4.0-draft6 changes:
|
4.0-draft7 | Mar 18, 2019 | OB R/W API Team |
|
3.1.2-RC1 | Apr 10, 2019 | OB R/W API Team | v3.1.2-RC1 changes
|
Endpoints
Endpoints for the resource - and available methods.
Resource | HTTP Operation | Endpoint | Mandatory? | Scope | Grant Type | Idempotency Key | Parameters | Request Object | Response Object | |
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | transactions | GET | GET /accounts/{AccountId}/transactions | Mandatory | accounts | Authorization Code | No | Pagination Filtering |
| OBReadTransaction5 |
| 2 | transactions | GET | GET /transactions | Optional | accounts | Authorization Code | No | Pagination Filtering |
| OBReadTransaction5 |
GET /accounts/{AccountId}/transactions
An AISP may retrieve the transaction resource for a specific AccountId (which is retrieved in the call to GET /accounts).
GET /transactions
If an ASPSP has implemented the bulk retrieval endpoints, an AISP may optionally retrieve the transactions in bulk.
This will retrieve the resources for all authorised accounts linked to the account-request.
Data Model
The OBReadTransaction5 object will be used for the call to:
GET /accounts/{AccountId}/transactions
GET /transactions
GET /accounts/{AccountId}/statements/{StatementId}transactions
Resource Definition
A resource that describes a posting to an account that results in an increase or decrease to a balance.
For a specific date range, an account (AccountId) may have no transactions booked, or may have multiple transactions booked.
UML Diagram
Notes:
The use of the term "Transaction" has been made consistently in the Transaction endpoint payload (instead of "Entry" which is the ISO20022 element name).
A DateTime element has been used instead of a complex choice element of Date and DateTime. Where time elements do not exist in ASPSP systems, the time portion of the DateTime element will be defaulted to 00:00:00+00:00.
The BookingDateTime has been set to mandatory as all ASPSPs must provide this field for pagination and filtering. The BookingDateTime is the date the transaction is booked (or posted) and becomes immutable, which is not the date the transaction took place.
Either the BankTransactionCode (which is the ISO transaction code list), or ProprietaryBankTransactionCode, or both may be populated. While the expectation is that at least one of BankTransactionCode. or ProprietaryBankTransactionCode are populated, we have decided not to enforce this behaviour in the payload structure as this would require nesting elements and introducing complex choice elements.
The BankTransactionCode (ISO) code-list is documented on the ISO20022 website: https://www.iso20022.org/external_code_list.page; and External Code Sets spreadsheet.
The ISO 20022 BankTransactionCode Code and SubCode are specified as 4 letter codes. However, the principle we have applied for the code lists is to have longer more descriptive codes.
The BankTransactionCode Code and SubCode will be populated with the long form description of the ISO 20022 code, with delimiters removed. E.g., the Family Code "CNTR" has a description of "Counter Transactions" which is populated as "CounterTransactions"
ASPSPs must have the ability to provide transactions through APIs for a period that at least equals the period provided through their online channels.
Filtering
Limited support for filtering is provided on the transactions resource.
Name | Occurrence | Enhanced Definition | Class |
|---|---|---|---|
fromBookingDateTime | 0..1 | Specifies start date and time for filtering of the Transaction records on the Transaction/BookingDateTime field | ISODateTime |
toBookingDateTime | 0..1 | Specifies end date and time for filtering of the Transaction records on the Transaction/BookingDateTime field. | ISODateTime |
The ASPSP must treat the following as valid input:
Non-working days (e.g. a Sunday or a Bank holiday) or any other days on which no transactions are recorded.
Dates that fall outside the range for which transaction information is provided through APIs.
Dates that fall outside the range for which a consent authorisation is available.
Timezone may be included in the filter request, but must be ignored by the ASPSP.
In the above situations, the ASPSP must return data for the remaining valid period specified by the filter.
Filtering Examples
// All transactions from 1st Jan, 2015
GET /transactions?fromBookingDateTime=2015-01-01T00:00:00
// All transactions in 2016
GET /transactions?fromBookingDateTime=2016-01-01T00:00:00&toBookingDateTime=2016-12-31T23:59:59
// All transactions in a specific account up to 31-Mar-2017
GET /accounts/1/transactions?toBookingDateTime=2017-03-31T23:59:59
Permission Codes
The resource differs depending on the permissions (ReadTransactionsBasic and ReadTransactionsDetail) used to access resource. In the event the resource is accessed with both ReadTransactionsBasic and ReadTransactionsDetail, the most detailed level (ReadTransactionsDetail) must be used.
These objects must not be returned without the ReadTransactionsDetail permission:
OBReadTransaction5/Data/Transaction/TransactionInformation
OBReadTransaction5/Data/Transaction/Balance
OBReadTransaction5/Data/Transaction/MerchantDetails
OBReadTransaction5/Data/Transaction/CreditorAgent
OBReadTransaction5/Data/Transaction/CreditorAccount
OBReadTransaction5/Data/Transaction/DebtorAgent
OBReadTransaction5/Data/Transaction/DebtorAccount
If the ReadTransactionsDetail is granted by the PSU:
OBReadTransaction5/Data/Transaction/TransactionInformation may be returned if applicable to the transaction and ASPSP (0..1)
OBReadTransaction5/Data/Transaction/Balance may be returned if applicable to the transaction and ASPSP (0..1)
OBReadTransaction5/Data/Transaction/MerchantDetails may be returned if applicable to the transaction and ASPSP (0..1)
OBReadTransaction5/Data/Transaction/CreditorAgent may be returned if applicable to the transaction and ASPSP (0..1)
OBReadTransaction5/Data/Transaction/CreditorAccount may be returned if applicable to the transaction and ASPSP (0..1)
OBReadTransaction5/Data/Transaction/DebtorAgent may be returned if applicable to the transaction and ASPSP (0..1)
OBReadTransaction5/Data/Transaction/DebtorAccount may be returned if applicable to the transaction and ASPSP (0..1)
If the ReadPAN permission is granted by the PSU - the ASPSP may choose to populate the unmasked PAN - if the PAN is being populated in the response for these fields:
OBReadTransaction5/Data/Transaction/CreditorAccount/Identification
OBReadTransaction5/Data/Transaction/DebtorAccount/Identification
OBReadTransaction5/Data/Transaction/CardInstrument/Identification
Data Dictionary
Name | Occurrence | XPath | EnhancedDefinition | Class | Codes | Pattern |
|---|---|---|---|---|---|---|
OBReadTransaction5 |
| OBReadTransaction5 |
| OBReadTransaction5 |
|
|
Data | 1..1 | OBReadTransaction5/Data |
| OBReadDataTransaction5 |
|
|
Transaction | 0..n | OBReadTransaction5/Data/Transaction | Provides further details on an entry in the report. | OBTransaction5 |
|
|
AccountId | 1..1 | OBReadTransaction5/Data/Transaction/AccountId | A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. | Max40Text |
|
|
TransactionId | 0..1 | OBReadTransaction5/Data/Transaction/TransactionId | Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable. | Max210Text |
|
|
TransactionReference | 0..1 | OBReadTransaction5/Data/Transaction/TransactionReference | Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context. | Max35Text |
|
|
StatementReference | 0..n | OBReadTransaction5/Data/Transaction/StatementReference | Unique reference for the statement. This reference may be optionally populated if available. | Max35Text |
|
|
CreditDebitIndicator | 1..1 | OBReadTransaction5/Data/Transaction/CreditDebitIndicator | Indicates whether the transaction is a credit or a debit entry. | OBCreditDebitCode | Credit Debit |
|
Status | 1..1 | OBReadTransaction5/Data/Transaction/Status | Status of a transaction entry on the books of the account servicer. | OBEntryStatus1Code | Booked Pending |
|
BookingDateTime | 1..1 | OBReadTransaction5/Data/Transaction/BookingDateTime | 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 status is booked, in which case it is the actual booking date. | ISODateTime |
|
|
ValueDateTime | 0..1 | OBReadTransaction5/Data/Transaction/ValueDateTime | 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 transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. | ISODateTime |
|
|
TransactionInformation | 0..1 | OBReadTransaction5/Data/Transaction/TransactionInformation | Further details of the transaction. This is the transaction narrative, which is unstructured text. | Max500Text |
|
|
AddressLine | 0..1 | OBReadTransaction5/Data/Transaction/AddressLine | Information that locates and identifies a specific address for a transaction entry, that is presented in free format text. | Max70Text |
|
|
Amount | 1..1 | OBReadTransaction5/Data/Transaction/Amount | Amount of money in the cash transaction entry. | OBActiveOrHistoricCurrencyAndAmount |
|
|
Amount | 1..1 | OBReadTransaction5/Data/Transaction/Amount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | OBActiveCurrencyAndAmount_SimpleType |
| ^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBReadTransaction5/Data/Transaction/Amount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". | ActiveOrHistoricCurrencyCode |
| ^[A-Z]{3,3}$ |
ChargeAmount | 0..1 | OBReadTransaction5/Data/Transaction/ChargeAmount | Transaction charges to be paid by the charge bearer. | OBActiveOrHistoricCurrencyAndAmount |
|
|
Amount | 1..1 | OBReadTransaction5/Data/Transaction/ChargeAmount/Amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. | OBActiveCurrencyAndAmount_SimpleType |
| ^\d{1,13}\.\d{1,5}$ |
Currency | 1..1 | OBReadTransaction5/Data/Transaction/ChargeAmount/Currency | A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". | ActiveOrHistoricCurrencyCode |
| ^[A-Z]{3,3}$ |
CurrencyExchange | 0..1 | OBReadTransaction5/Data/Transaction/CurrencyExchange | Set of elements used to provide details on the currency exchange. | OBCurrencyExchange5 |
|
|
SourceCurrency |