...
for a specific account identified by AccountId or retrieve statement information for all accounts that the PSU customer has consented to.
This resource description should be read in conjunction with a compatible Account Information Services API Profile.
...
S.No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Idempotency Key | Parameter | Request Object | Response Object |
2.1 | statements | GET | GET /accounts/{AccountId}/statements | Conditional | accounts | Authorization Authorisation Code | No | Pagination Filtering |
| OBReadStatement |
2.2 | statements | GET | GET /accounts/{AccountId}/statements/{StatementId} | Conditional | accounts | Authorization Authorisation Code | No |
|
| OBReadStatement |
2.3 | statements | GET | GET /accounts/{AccountId}/statements/{StatementId}/file | Optional | accounts | Authorization Authorisation Code | No |
|
| File |
2.4 | transactions | GET | GET /accounts/{AccountId}/statements/{StatementId}/transactions
| Conditional | accounts | Authorization Authorisation Code | No | Pagination |
| OBReadTransaction |
2.5 | statements | GET | GET /statements | Optional | accounts | Authorization Authorisation Code | No | Pagination Filtering |
| OBReadStatement |
...
An ASPSP may provide this endpoint for AISPs to retrieve transactions that appear on the selected statement. The data model for the returned objects is documented in the transactions resource.
2.5. GET /statements
An ASPSP may provide this endpoint for AISPs to retrieve statement information for all accounts that the PSU customer has consented to. This will retrieve the statement resources for all authorised accounts linked to the account-request.
3. Data Models
3.1. OBReadStatement
...
Name | Occurrence | Enhanced Definition | Class |
fromStatementDateTime | 0..1 | Specifies start date and time for filtering of the Statements on the Statement/StartDateTime field. If this is not populated, the start date will be open ended | DateTime |
fromStatementDateTimetoStatementDateTime | 0..1 | Specifies start end date and time for filtering of the Statements on the Statement/StartDateTime field. If this is not populated, the start end date will be open ended | DateTime |
...
The ReadTransactionsBasic or ReadTransactionsDetail (in addition to the appropriate ReadTransactionsCredits and/or ReadTransactionsDebits ) permission codes will be required. The ASPSP must apply the same access to GET /accounts/{AccountId}/statements/{StatementId}/transactions as GET /accounts/{AccountId}/transactions
If the ReadPAN permission is granted by the PSU customer - the ASPSP may choose to populate the unmasked PAN - if the PAN is being populated in the response for these fields
OBReadTransaction/Data/Transaction/CreditorAgent/Identification
OBReadTransaction/Data/Transaction/DebtorAccount/Identification
OBReadTransaction /Data/Transaction/CardInstrument/Identification
...
4.1.1 Get Statements Request
|
...
|
4.2. Specific Account
...
|
...
|