How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

zopa Statements API

The Statements API from zopa — 1 operation(s) for statements.

zopa Statements API is one of 12 APIs that zopa 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 and API documentation.

This API exposes 1 operation across 1 path, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against a single base URL, /open-banking/v4.0/aisp.

1 operations 1 paths 36 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://developer.openbanking-sandbox.zopa.com/open-banking/v4.0/aisp
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

zopa 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 ASPSP
  • PSUOAuth2Security — 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

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Statements 1
GET
/accounts/{AccountId}/statements
Get Statements
GetAccountsAccountIdStatements 8 params → 200400401403404405406429

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are OBStatement2 (13 properties), Links (5 properties), OBErrorResponse1 (4 properties), OBError1 (4 properties). Each schema is shown below with its type and property counts.

OBInternalStatementFeeFrequency1Code
string
How frequently the fee is applied to the Account. For a full list of values see OBInternalStatementFeeFrequency1Code in OBInternalCodeSet [here](https://github…
OBInternalStatementInterestFrequency1Code
string
Specifies the statement fee type requested. For a full list of values see OBInternalStatementInterestFrequency1Code in OBInternalCodeSet [here](https://github.…
OBStatement2
object
Provides further details on a statement resource.
13 properties 5 required
OBActiveOrHistoricCurrencyAndAmount_7
object
Amount of money associated with the statement interest amount type.
2 properties 2 required
OBInternalStatementFeeRateType1Code
string
Description that may be available for the statement fee rate type. For a full list of values see OBInternalStatementFeeRateType1Code in OBInternalCodeSet [here…
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 response…
StatementId
string
Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.
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:…
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.
OBReadDataStatement2
object
1 property
OBActiveOrHistoricCurrencyAndAmount_6
object
Amount of money associated with the statement fee type.
2 properties 2 required
OBInternalStatementValueType1Code
string
Statement value type, in a coded form. For a full list of values see OBInternalStatementValueType1Code in OBInternalCodeSet [here](https://github.com/OpenBanki…
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OBInternalStatementFeeType1Code
string
Fee type, in a coded form. For a full list of values see OBInternalStatementFeeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalI…
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 response…
OBCreditDebitCode_0
string
Indicates whether the amount is a credit or a debit. For a full list of values see OBInternalCreditDebitCode in OBInternalCodeSet [here](https://github.com/Ope…
Description_1
string
Description that may be available for the statement fee.
Description_2
string
Description that may be available for the statement interest.
Rate
string
Rate associated with the statement rate type.
Links
object
Links relevant to the payload
5 properties 1 required
Value
string
Value associated with the statement value type.
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 respon…
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…
OBRate1_0
number
Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see ExternalReason1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
Meta
object
Meta Data relevant to the payload
3 properties
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…
OBRate1_1
number
Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount)
OBInternalStatementType1Code
string
Statement type, in a coded form. For a full list of values see OBInternalStatementType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
OBInternalStatementInterestType1Code
string
Interest amount type, in a coded form. For a full list of values see OBInternalStatementInterestType1Code in OBInternalCodeSet [here](https://github.com/OpenBa…
OBError1
object
4 properties 1 required
OBReadStatement2
object
3 properties 1 required
OBInternalStatementAmountType1Code
string
Amount type, in a coded form.
OBInternalStatementRateType1Code
string
Statement rate type, in a coded form. For a full list of values see OBInternalStatementRateType1Code in OBInternalCodeSet [here](https://github.com/OpenBanking…
OBInternalStatementDateTimeType1Code
string
Date time type, in a coded form. For a full list of values see OBInternalStatementDateTimeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingU…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zopa-statements-api-openapi.yml Raw ↑

Other APIs zopa publishes across the network.

zopa Account Access API
zopa Accounts API
zopa Balances API
zopa Beneficiaries API
zopa Direct Debits API
zopa Domestic Payments API
zopa Domestic Standing Orders API
zopa Offers API
zopa Parties API
zopa Standing Orders API
zopa Transactions API
Where this information came from

This is an independent, third-party profile of zopa Statements API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.