zopa Domestic Payments API
The Domestic Payments API from zopa — 5 operation(s) for domestic payments.
zopa Domestic Payments API is one of 12 APIs that zopa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Domestic Payments. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 5 paths, and defines 63 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.
5 operations
5 paths
63 schemas
3 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
zopa Domestic Payments 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 5
Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Domestic Payments 5
POST
/domestic-payment-consents
Create Domestic Payment Consents
GET
/domestic-payment-consents/{ConsentId}
Get Domestic Payment Consents
GET
/domestic-payment-consents/{ConsentId}/funds-confirmation
Get Domestic Payment Consents Funds Confirmation
POST
/domestic-payments
Create Domestic Payments
GET
/domestic-payments/{DomesticPaymentId}
Get Domestic Payments
Schemas 63
The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are OBPostalAddress7 (18 properties), OBRisk1 (9 properties), OBRemittanceInformationStructured (7 properties), OBCashAccountDebtor4 (5 properties). Each schema is shown below with its type and property counts.
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 a financial institution or a branch of a financial institution.
OBWriteDomestic2
object
2 properties
2 required
OBWriteDomesticResponse5
object
3 properties
1 required
UnitNumber
string
Number that identifies the unit of a specific address .
OBRegulatoryAuthority2
object
Entity requiring the regulatory reporting information.
2 properties
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…
OBUltimateCreditor1
object
Ultimate party to which an amount of money is due.
5 properties
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
Identification_3
string
Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
Department
string
Identification of a division of a large organisation or building.
Floor
string
Number that identifies the level within a building
Meta
object
Meta Data relevant to the payload
3 properties
ExternalProxyAccountType1Code
string
Specifies the external proxy account type code, as published in the proxy account type external code set. For a full list of values see ExternalProxyAccountTyp…
ExternalDocumentType1Code
string
Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISOExternalCodeSet [here…
OBCashAccountDebtor4
object
^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.
5 properties
OBRegulatoryReporting1
object
Information needed due to regulatory and statutory requirements
3 properties
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
CountryCode
string
Nation with its own government.
StreetName
string
Name of a street or thoroughfare.
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…
Links
object
Links relevant to the payload
5 properties
1 required
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets).
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
1 required
OBSCASupportData1
object
Supporting Data provided by TPP, when requesting SCA Exemption.
3 properties
SubDepartment
string
Identification of a sub-division of a large organisation or building.
OBInternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
OBInternalLocalInstrument1Code
string
User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or serv…
ExternalPurpose1Code
string
This is a partial list, For a full list see ExternalPurpose1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
Room
string
Information that locates and identifies a room to form part of an address
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
OBInternalAccountIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to OBInternalAccountIdentification4Code in…
OBStatusReason
object
3 properties
Identification_4
string
Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money associated with the charge type.
2 properties
2 required
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
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:…
OBInternalChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to OBInternalCha…
OBRemittanceInformationStructured
object
7 properties
OBWriteFundsConfirmationResponse1
object
3 properties
1 required
OBInternalErrorResponseError1Code
string
Low level textual error code, for all enum values see OBInternalErrorResponseError1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
BuildingNumber
string
Number that identifies the position of a building on a street.
OBError1
object
4 properties
1 required
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
OBWriteDomesticConsent4
object
2 properties
2 required
OBInternalPaymentChargeType1Code
string
Charge type, in a coded form. For a full list of values refer to OBInternalPaymentChargeType1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/…
Name
string
Name by which an agent is known and which is usually used to identify that agent.
OBWriteDomesticConsentResponse5
object
4 properties
2 required
OBRisk1
object
The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.
9 properties
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
OBStructuredRegulatoryReporting3
object
Set of elements used to provide details on the regulatory reporting information.
5 properties
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.
ExternalCategoryPurpose1Code
string
Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see ExternalCategoryPurpose1Code [here](https…
OBProxy1
object
Specifies an alternate assumed name for the identification of the account.
3 properties
2 required
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
ActiveOrHistoricCurrencyCode
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…
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.
OBInternalExtendedAccountType1Code
string
Specifies the extended type of account.
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 Standing Orders API
zopa Offers API
zopa Parties API
zopa Standing Orders API
zopa Statements API
zopa Transactions API
#Domestic Payments