Version Control

Endpoints

Endpoints for the resource and available methods.

GET /accounts/{AccountId}/statements

An ASPSP may provide this endpoint for AISPs to retrieve the statements information resource for the AccountId (which is retrieved in the call to GET /accounts).

GET /accounts/{AccountId}/statements/{StatementId}

An ASPSP may provide this endpoint for AISPs to retrieve the statement information resource for a specific statement in the AccountId (which is retrieved in the call to GET /accounts).

GET /accounts/{AccountId}/statements/{StatementId}/file

An ASPSP may provide this endpoint for AISPs to retrieve a non-json representation of a specific statement.

GET /accounts/{AccountId}/statements/{StatementId}/transactions

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.

GET /statements

An ASPSP may provide this endpoint for AISPs to retrieve statement information for all accounts that the PSU has consented to. This will retrieve the statement resources for all authorised accounts linked to the account-request.

Data Model

The OBReadStatement1 object will be used for the call to:

• GET /statements

• GET /accounts/{AccountId}/statements

• GET /accounts/{AccountId}/statements/{StatementId}

The call to

• GET /accounts/{AccountId}/statements/{StatementId}/file

will return unstructured data in binary (e.g., pdf, doc) or text (e.g., csv) formats. This will be specified in the Accept header by the AISP.

The OBReadTransaction3 object (documented in the transactions resource) will be used the call to:

• GET /accounts/{AccountId}/statements/{StatementId}/transactions

Resource Definition

A resource that describes summary details for an account statement period.

For a specific date range, an account (AccountId) may have no statements, or may have multiple statements.

The /statements endpoint (if implemented by the ASPSP) must return all statements within the requested date range for all accounts selected during the authorisation of the account-request.

If an AISP would like to access a specific statement (StatementId) to retrieve a formal statement download or transactions for a specific statement - the AISP must specify the account (the AccountId) via the URI request path i.e., via:

• GET /accounts/{AccountId}/statements/{StatementId}/file - to download the statement.

• GET /accounts/{AccountId}/statements/{StatementId}/transactions - to return the transactions relating to a statement.

UML Diagram

Open

Notes:

• The statements resource must only be used for data that can be returned for a statement period.

• StartDateTime, EndDateTime and CreationDateTime are mandatory for the statements resource. If an ASPSP does not display these dates in an online channel, the ASPSP must populate these dates with sensible values. E.g., the StartDateTime could be the day after the previous statement EndDateTime, and the CreationDateTime could be the day after the EndDateTime.

Filtering

Limited support for filtering is provided on the statements resource.

Statements may be filtered based on their StartDateTime and EndDateTime using the fromStatementDateTime and toStatementDateTime parameters.

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.

In the above situations, the ASPSP must return statements where the StartDateTime and EndDateTime are both between the fromStatementDateTime and toStatementDateTime parameters.

Filtering Examples

Permission Codes

The resource differs depending on the permissions (ReadStatementsBasic and ReadStatementsDetail) used to access resource (the OBReadStatement1 object). In the event the resource is accessed with both ReadStatementsBasic and ReadStatementsDetail, the most detailed level (ReadStatementsDetail) must be used.

• These objects must not be returned without the ReadStatementsDetail permission:

• OBReadStatement1/Data/Statement/StatementAmount

• Calls to GET /accounts/{AccountId}/statements/{StatementId}/file

• If the ReadStatementsDetail is granted by the PSU:

  • OBReadStatement1/Data/Statement/StatementAmount may be returned if applicable to the statement and ASPSP (0..n)

For the call to GET /accounts/{AccountId}/statements/{StatementId}/transactions:

• 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 - the ASPSP may choose to populate the unmasked PAN - if the PAN is being populated in the response for these fields:

  • OBReadTransaction3/Data/Transaction/CreditorAgent/Identification

  • OBReadTransaction3/Data/Transaction/DebtorAccount/Identification

  • OBReadTransaction3/Data/Transaction/CardInstrument/Identification

Data Dictionary