Barclays Domestic VRP Consents API is one of 64 APIs that Barclays publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Domestic VRP Consents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 3 paths,
and defines 58 schemas.
It is described by OpenAPI 3.2.0, at version v4.0.
Requests are made against the base URL https://telesto.api.barclays/open-banking/v3.1.
The identity and technical contract details declared by the specification.
OBReferredDocumentInformation
object
5 properties
Room
string
Information that locates and identifies a room to form part of an address
OBRemittanceInformationStructured
object
7 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…
OBInternalExtendedAccountType1Code
string
Specifies the extended type of account if known. For a full set of values refer to OBInternalExtendedAccountType1Code in OBInternalCodeSet [here](https://githu…
OBVRPAuthenticationMethods
string
OBDomesticVRPConsentRequest
object
2 properties
2 required
OBVRPFundsConfirmationRequest
object
The OBVRPFundsConfirmationRequest object must be used to request funds availability for a specific amount in the Debtor Account included in the VRP consents.
1 property
1 required
BuildingNumber
string
Number that identifies the position of a building on a street.
DistrictName
string
Number that of the regional area, known as a district, which forms part of an address
OBRegulatoryReporting1
object
Information needed due to regulatory and statutory requirements
3 properties
OBRegulatoryAuthority2
object
Entity requiring the regulatory reporting information.
2 properties
OBExternalPurpose1Code
string
For a full set of values refer to ExternalPurpose1Code in ISOExternalCodeSet [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
Floor
string
Number that identifies the level within a building
OBDomesticVRPControlParameters
object
8 properties
4 required
BuildingName
string
Name of a referenced building.
OBStructuredRegulatoryReporting3
object
Set of elements used to provide details on the regulatory reporting information.
5 properties
OBInternalConsentStatus1Code
string
Specifies the status of consent resource in code form. AWAU and RJCT only can returned on initial submission. For a full list of values see OBInternalConsentSt…
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…
Links
object
Links relevant to the payload
5 properties
1 required
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…
SubDepartment
string
Identification of a sub-division of a large organisation or building.
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
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…
OBUltimateDebtor1
object
Ultimate party that owes an amount of money to the (ultimate) creditor.
5 properties
OBPAFundsAvailableResult1
object
Availability result, clearly indicating the availability of funds given the Amount in the request.
2 properties
2 required
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.
OBCashAccountDebtorWithName
object
5 properties
2 required
TownName
string
Name of a built-up area, with defined boundaries, and a local government.
OBExternalStatusReason1Code
string
Low level textual error code, for all enum values see ExternalReturnReason1Code [here](https://github.com/OpenBankingUK/ExternalInternalCodeSets)
Department
string
Identification of a division of a large organisation or building.
OBVRPFundsConfirmationResponse
object
The confirmation of funds response contains the result of a funds availability check.
1 property
1 required
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…
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:…
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
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…
ExternalCreditorReferenceType1Code
string
Specifies the amount type, as published in an external referred amount code set. For a full lust of values refer to ExternalCreditorReferenceType1Code in ISOEx…
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
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…
OBCashAccountCreditor3
object
5 properties
3 required
Meta
object
Meta Data relevant to the payload. At present no fields are used for VRP.
OBDomesticVRPConsentResponse
object
4 properties
2 required
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.
UnitNumber
string
Number that identifies the unit of a specific address .
CountryCode
string
Nation with its own government.
StreetName
string
Name of a street or thoroughfare.
OBStatusReason
object
3 properties
OBDomesticVRPInitiation
object
7 properties
OBError1
object
4 properties
1 required
OBActiveOrHistoricCurrencyAndAmount
object
2 properties
2 required
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…
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
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.
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…
OBUltimateCreditor1
object
Ultimate party to which an amount of money is due.
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Barclays publishes across the network.
