Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

zopa Balances API

The Balances API from zopa — 1 operation(s) for balances.

zopa Balances API is one of 12 APIs that zopa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Balances. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

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

1 operations 1 paths 12 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.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 Balances 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.

Balances 1
GET
/accounts/{AccountId}/balances
Get Balances
GetAccountsAccountIdBalances 6 params → 200400401403405406429500

Schemas 12

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

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.
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…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
OBCreditDebitCode_2
string
Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. For a full list of enumeration values…
OBBalanceType1Code
string
Balance type, in a coded form. For a full list of enumeration values refer to ExternalBalanceType1Code in ISOExternalCodeSet [here](https://github.com/OpenBank…
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties 1 required
OBReadBalance1
object
3 properties 1 required
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see ExternalReason1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
Links
object
Links relevant to the payload
5 properties 1 required
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:…
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zopa-balances-api-openapi.yml Raw ↑

Other APIs zopa publishes across the network.

zopa Account Access API
zopa Accounts 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 Statements API
zopa Transactions API