UK Open Banking International Payments API is one of 42 APIs that UK Open Banking publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include International Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and rate-limit docs.
This API exposes
3 operations
across 3 paths,
and defines 64 schemas.
It is described by OpenAPI 3.0.0, at version 4.0.1.
Requests are made against a single base URL, /open-banking/v4.0/aisp.
The identity and technical contract details declared by the specification.
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
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…
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…
StreetName
string
Name of a street or thoroughfare.
OBCashAccountDebtor4
object
^ Only included in the response if Data. ReadRefundAccount is set to Yes in the consent.
5 properties
OBUltimateCreditor1
object
Ultimate party to which an amount of money is due.
5 properties
Links
object
Links relevant to the payload
5 properties
1 required
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…
CountryCode
string
Nation with its own government.
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…
ExternalPaymentTransactionStatus3Code
string
Specifies the status of the payment information group. For a full list of values refer to ExternalPaymentTransactionStatus3Code in OBInternalCodeSet [here](htt…
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
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.
Department
string
Identification of a division of a large organisation or building.
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.
Identification_4
string
Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
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…
OBInternalFinancialInstitutionIdentification4Code
string
Name of the identification scheme, in a coded form as published in an external list.
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…
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…
OBActiveOrHistoricCurrencyAndAmount
object
Amount of money associated with the charge type.
2 properties
2 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:…
OBAddressType2Code
string
Identifies the nature of the postal address. For a full set of codes see OBAddressType2Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets).
BuildingName
string
Name of a referenced building.
BuildingNumber
string
Number that identifies the position of a building on a street.
Floor
string
Number that identifies the level within a building
OBReferredDocumentInformation
object
5 properties
ExternalCreditorReferenceType1Code
string
Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see ExternalCreditorReferenceType1C…
OBWriteInternationalResponse5
object
3 properties
1 required
SubDepartment
string
Identification of a sub-division of a large organisation or building.
OBRegulatoryReporting1
object
Information needed due to regulatory and statutory requirements
3 properties
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…
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
OBStatusReason
object
3 properties
OBSupplementaryData1
object
Additional information that can not be captured in the structured fields and/or any other specific block.
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
OBDomesticRefundAccount1
object
Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.
1 property
1 required
OBWritePaymentDetailsResponse1
object
3 properties
1 required
OBInternalExtendedAccountType1Code
string
Specifies the extended type of account.
ExternalPaymentTransactionStatus1Code
string
The current status of the payment resource. For a full list of values see ExternalPaymentTransactionStatus1Code in OBInternalCodeSet [here](https://github.com/…
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
OBRegulatoryAuthority2
object
Entity requiring the regulatory reporting information.
2 properties
Meta
object
Meta Data relevant to the payload
3 properties
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.
OBWriteInternational3
object
2 properties
2 required
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
ExternalPurpose1Code
string
This is a partial list, For a full list see ExternalPurpose1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
ExternalDocumentType1Code
string
Specifies the document type as published in an external document type code list. For more information see ExternalDocumentType1Code in ISOExternalCodeSet [here…
OBWritePaymentDetails1
object
4 properties
3 required
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
Name
string
Name by which an agent is known and which is usually used to identify that agent.
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…
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
OBStructuredRegulatoryReporting3
object
Set of elements used to provide details on the regulatory reporting information.
5 properties
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
OBRemittanceInformationStructured
object
7 properties
Room
string
Information that locates and identifies a room to form part of an address
Identification_1
string
Unique identification, as assigned by the creditor, to unambiguously identify the mandate.
Identification_3
string
Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
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
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
1 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/…
OBError1
object
4 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs UK Open Banking publishes across the network.
