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 Transactions API

The Transactions API from zopa — 1 operation(s) for transactions.

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

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

This API exposes 1 operation across 1 path, and defines 23 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 23 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 Transactions 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.

Transactions 1
GET
/accounts/{AccountId}/transactions
Get Transactions
GetAccountsAccountIdTransactions 8 params → 200400401403405406429500

Schemas 23

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

TransactionInformation
string
Further details of the transaction. This is the transaction narrative, which is unstructured text.
BookingDateTime
string
Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the st…
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.
ExternalEntryStatus1Code
string
Status of a transaction entry on the books of the account servicer. For a full list of enumeration values refer to ExternalEntryStatus1Code in ISOExternalCodeS…
OBMerchantDetails1
object
Details of the merchant involved in the transaction.
1 property
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…
ProprietaryBankTransactionCodeStructure1
object
Set of elements to fully identify a proprietary bank transaction code.
2 properties 1 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties 1 required
TransactionId
string
Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.
OBReadTransaction6
object
3 properties 1 required
ValueDateTime
string
Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit…
OBActiveOrHistoricCurrencyAndAmount_9
object
Amount of money in the cash transaction entry.
2 properties 2 required
AddressLine
string
Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
OBCreditDebitCode_1
string
Indicates whether the transaction is a credit or a debit entry. For a full list of enumeration values refer to OBInternalCreditDebitCode in OBInternalCodeSet […
Meta
object
Meta Data relevant to the payload
3 properties
OBCurrencyExchange5
object
Set of elements used to provide details on the currency exchange.
5 properties 2 required
OBTransaction6
object
Provides further details on an entry in the report.
12 properties 5 required
OBError1
object
4 properties 1 required
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see ExternalReason1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBReadDataTransaction6
object
1 property
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-transactions-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 Statements API