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 API Provider) must return all statements within the requested date range for all accounts selected during the authorisation of the account-access-consent.

If a Third Party would like to access a specific statement (StatementId) to retrieve a formal statement download or transactions for a specific statement - the Third Party 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

The API endpoint allows a Third Party to retrieve the statements for a specific account identified by AccountId.

• The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow). 

The API endpoint allows a Third Party to retrieve a specific statement identified by StatementId and specific account identified by AccountId.

• The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow). 

The API endpoint allows a Third Party to retrieve a non-json representation of a specific statement identified by StatementId for a specific account identified by AccountId.

• The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow). 

The API endpoint allows a Third Party to retrieve the transactions for a specific statement identified by StatementId and specific account identified by AccountId.

• The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow). 

• This retrieves the transactions that appear on the selected statement identified by StatementId.

• The data model for the returned objects is documented in the transactions resource.

The API endpoint allows a Third Party to retrieve statements in bulk, if an API Provider has implemented the bulk retrieval endpoints.

• The Third Party must have an access token issued by the API Provider using an authorization flow (either redirect flow or decoupled flow). 

• This will retrieve the statements for all accounts linked to the account-access-consent.

The OBReadStatement1 object will be used for the call to:

• GET /statements

• GET /accounts/{AccountId}/statements

The OBReadStatement2 object will be used for the call to:

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

Both OBReadStatement1 and OBReadStatement2 use the OBStatement1 class. However, the OBReadStatement2 has a single OBStatement1 object within the Data object; whereas the OBReadStatement1 object allows for an array of OBStatement1 objects.

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. The format of the data will be specified in the Accept header by the Third Party.

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

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

Open

Open

Open

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

Limited support for filtering is provided on the statements and statements/{StatementId}/transactions resources.

The API Provider must treat the following as valid input:

• Non-working days (e.g. a Sunday or a Public 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 API Provider

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

Additionally, when filtering Transactions for a Statement, the API Provider must treat the following as valid input:

• Transaction filter dates that fall outside the Statement as defined by StartDateTime and EndDateTime

The resource response 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:

• OBStatement1/StatementAmount

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

If the ReadStatementsDetail is granted by the Customer:

• OBStatement1/StatementAmount may be returned if applicable to the statement and API Provider (0..n)

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

• TheReadTransactionsBasic or ReadTransactionsDetail (in addition to the appropriate ReadTransactionsCredits and/or ReadTransactionsDebits) permission codes will be required. The API Provider must apply the same access to GET /accounts/{AccountId}/statements/{StatementId}/transactions as GET /accounts/{AccountId}/transactions