zopa Standing Orders API
The Standing Orders API from zopa — 1 operation(s) for standing orders.
zopa Standing Orders API is one of 12 APIs that zopa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Standing Orders. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 1 operation across 1 path, and defines 57 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
57 schemas
1 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
zopa Standing Orders 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 ASPSPPSUOAuth2Security— 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.
Standing Orders 1
GET
/accounts/{AccountId}/standing-orders
Get Standing Orders
Schemas 57
The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress7 (18 properties), OBStandingOrder6 (14 properties), OBMandateRelatedInformation1 (8 properties), OBRemittanceInformationStructured (7 properties). Each schema is shown below with its type and property counts.
ExternalMandateStatus1Code
string
Specifies the status of the standing order in code form. For a full list of enumeration values refer to 'ExternalMandateStatus1Code' in ISOExternalCodeset [her…
PostBox
string
Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for.
Identification_1
string
Unique and unambiguous identification of the servicing institution.
AccountId
string
A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
OBFrequency6
object
Regularity with which credit transfer instructions are to be created and processed
3 properties
1 required
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.
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
ExternalCategoryPurpose1Code
string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code in ISOExtern…
UnitNumber
string
Number that identifies the unit of a specific address .
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties
2 required
OBRemittanceInformationStructured
object
7 properties
OBActiveOrHistoricCurrencyAndAmount_3
object
The amount of the next Standing Order.
2 properties
2 required
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…
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
LEI
string
Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Finan…
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
1 required
LastPaymentDateTime
string
The date on which the last (most recent) payment for a Standing Order schedule was made. All dates in the JSON payloads are represented in ISO 8601 date-time f…
OBFrequency6Code
string
For a full list of values see OBFrequency6Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
OBInternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalFinancialInstitut…
StandingOrderId
string
A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.
PointInTime
string
Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or mom…
OBActiveOrHistoricCurrencyAndAmount_11
object
The amount of the last (most recent) Standing Order instruction.
2 properties
2 required
BuildingNumber
string
Number that identifies the position of a building on a street.
Identification_3
string
Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
OBMandateRelatedInformation1
object
Provides further details of the mandate signed between the creditor and the debtor.
8 properties
1 required
Floor
string
Number that identifies the level within a building
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For more information and a full list of values see Ex…
Meta
object
Meta Data relevant to the payload
3 properties
OBError1
object
4 properties
1 required
ExternalDocumentType1Code
string
Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISOExternalCodeSet [here…
Room
string
Information that locates and identifies a room to form part of an address
Name_0
string
The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account n…
NextPaymentDateTime
string
The date on which the next payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All…
CareOf
string
The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail f…
OBReferredDocumentInformation
object
5 properties
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see ExternalReason1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
OBInternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to OBInternalAccountIdentifica…
OBActiveOrHistoricCurrencyAndAmount_4
object
The amount of the final Standing Order
2 properties
2 required
StreetName
string
Name of a street or thoroughfare.
Name_1
string
Name by which an agent is known and which is usually used to identify that agent.
Identification_4
string
dentification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
PostCode
string
Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
BuildingName
string
Name of a referenced building.
OBExternalMandateClassification1Code
string
Type of mandate instruction. For a full list of values see OBExternalClassification1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalI…
SecondaryIdentification
string
This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally ident…
ExternalCreditorReferenceType1Code
string
Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see ExternalCreditorReferenceType1C…
OBBranchAndFinancialInstitutionIdentification5_1
object
Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on t…
5 properties
2 required
OBStandingOrder6
object
14 properties
1 required
OBCashAccount5_1
object
Provides the details to identify the beneficiary account.
5 properties
2 required
Links
object
Links relevant to the payload
5 properties
1 required
OBRemittanceInformation2
object
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' rec…
2 properties
OBReadStandingOrder6
object
3 properties
1 required
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
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:…
OBActiveOrHistoricCurrencyAndAmount_2
object
The amount of the first Standing Order
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from zopa 11
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 Statements API
zopa Transactions API
#Standing Orders