UK Open Banking Domestic VRPs 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 Domestic VRPs. 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 63 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.
OBVRPInteractionTypes
string
Indicates interaction type, currently if customer is present or not present. If not provided the default is OffSession (customer is not present) when the indiv…
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 a full list of values refer to ExternalCategoryPurpose1Code i…
StreetName
string
Name of a street or thoroughfare.
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
OBDomesticVRPDetails
object
1 property
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…
OBCashAccountCreditor3
object
5 properties
3 required
CountryCode
string
Nation with its own government.
ExternalPaymentTransactionStatus5Code
string
Specifies the status of the payment information group. For a full list of values refer to ExternalPaymentTransactionStatus5Code in OBInternalCodeSet [here](htt…
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…
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.
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…
OBInternalChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
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
2 properties
2 required
OBDomesticVRPResponse
object
4 properties
2 required
OBExternalPurpose1Code
string
For a full set of values refer to ExternalPurpose1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
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 in OBInternalCodeSet [here](https://github.com/OpenBankingUK/Extern…
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 amount type, as published in an external referred amount code set. For a full list of values refer to ExternalCreditorReferenceType1Code in ISOEx…
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
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see OBExternalStatusReason1Code in OBInternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternal…
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…
OBStatusReason
object
3 properties
OBDomesticVRPRequest
object
2 properties
2 required
OBDomesticVRPInstruction
object
9 properties
4 required
OBPostalAddress7
object
Information that locates and identifies a specific address, as defined by postal services.
18 properties
OBVRPAuthenticationMethods
string
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
OBInternalExtendedAccountType1Code
string
Specifies the extended type of account if known. For a full set of values refer to OBInternalExtendedAccountType1Code in OBInternalCodeSet [here](https://githu…
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. At present no fields are used for VRP.
OBDomesticVRPInitiation
object
7 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.
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
ExternalDocumentType1Code
string
Specifies the document type as published in an external document type code list. For a full list of values refer to ExternalDocumentType1Code in ISOExternalCod…
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
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
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
OBCashAccountDebtorWithName
object
5 properties
2 required
OBErrorResponse1
object
An array of detail error codes, and messages, and URLs to documentation to help remediation.
4 properties
1 required
OBInternalPaymentChargeType1Code
string
OBError1
object
4 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs UK Open Banking publishes across the network.
