How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Barclays

Barclays Domestic VRPs API

Domestic VRP

Documentation Provider Profile APIs.io OpenAPI GitHub

Barclays Domestic VRPs 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 VRPs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 63 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.

3 operations 3 paths 63 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v4.0
Base URL
https://telesto.api.barclays/open-banking/v3.1
Authentication
OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Barclays Domestic VRPs 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 ASPSP
  • PSUOAuth2Security — 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 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Domestic VRPs 3

Domestic VRP

POST
/domestic-vrps
Create a domestic VRP
domesticVrpPost 8 params body → 201400422401500403415405
GET
/domestic-vrps/{domesticVRPId}
Retrieve a domestic VRP
domesticVrpGet 6 params → 200400401500403415405406
GET
/domestic-vrps/{domesticVRPId}/payment-details
Retrieve a domestic VRP
domesticVrpPaymentDetailsGet 6 params → 200400401500403415405406

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), OBDomesticVRPInstruction (9 properties), OBRemittanceInformationStructured (7 properties). Each schema is shown below with its type and property counts.

OBReferredDocumentInformation
object
5 properties
OBDomesticVRPDetails
object
1 property 1 required
OBInternalPaymentChargeType1Code
string
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…
Identification_0
string
Identification assigned by an institution to identify an account. This identification is known by the account owner.
OBInternalExtendedAccountType1Code
string
Specifies the extended type of account if known. For a full set of values refer to OBInternalExtendedAccountType1Code in OBInternalCodeSet [here](https://githu…
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…
OBVRPAuthenticationMethods
string
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
OBDomesticVRPInstruction
object
9 properties 4 required
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
BuildingName
string
Name of a referenced building.
OBStructuredRegulatoryReporting3
object
Set of elements used to provide details on the regulatory reporting information.
5 properties
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
OBInternalChargeBearerType1Code
string
Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
OBDomesticVRPResponse
object
4 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.
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…
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…
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…
ExternalPaymentTransactionStatus5Code
string
Specifies the status of the payment information group. For a full list of values refer to ExternalPaymentTransactionStatus5Code in OBInternalCodeSet [here](htt…
CountrySubDivision
string
Identifies a subdivision of a country such as state, region, county.
OBDomesticVRPRequest
object
2 properties 2 required
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.
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.
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
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
ExternalPaymentTransactionStatus1Code
string
The current status of the payment resource. For a full list of values see ExternalPaymentTransactionStatus1Code in OBInternalCodeSet [here](https://github.com/…
OBVRPConsentType
string
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

barclays-domestic-vrps-api-openapi.yml Raw ↑

Other APIs Barclays publishes across the network.

Barclays Smartpay Web Payment API
AE Profile APIs.io
Barclaycard Smartpay Connect API
AE Profile APIs.io
Barclays Corporate Payment Initiation API
AE Profile APIs.io
Barclays Balances and Transactions Reporting API
AE Profile APIs.io
Barclays Account Access Consents API
AE Profile APIs.io
Barclays Accounts API
AE Profile APIs.io
Barclays Apply Product External API OAS API
AE Profile APIs.io
Barclays Atms API
AE Profile APIs.io
Barclays Balances API
AE Profile APIs.io
Barclays Beneficiaries API
AE Profile APIs.io
Barclays Branches API
AE Profile APIs.io
Barclays Business Current Accounts API
AE Profile APIs.io
#Domestic VRPs
← Back to B APIs
API Details
ID
barclays:barclays-domestic-vrps-api
Base URL
https://telesto.api.barclays/open-banking/v3.1
Docs
https://developer.barclays.com/apis/barclaycard-smartpay-web-payment/b82fda37-a434-4cc3-abde-0c6ba126fd2e.bdn/documentation
Provider
Barclays
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=barclays-domestic-vrps-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/barclays-domestic-vrps-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Barclays Domestic VRPs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.