Barclays · Schema
OBDomesticVRPRequest
BankingCredit CardsFAPIFinanceOpen BankingOpen DataPSD2PaymentsUK BankingVariable Recurring Payments
Properties
| Name | Type | Description |
|---|---|---|
| Data | object | |
| Risk | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/barclays/main/json-schema/barclays-obdomestic-vrprequest-schema.json",
"title": "OBDomesticVRPRequest",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/barclays-domestic-vrps-api-openapi.yml#/components/schemas/OBDomesticVRPRequest",
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"properties": {
"ConsentId": {
"type": "string",
"description": "Identifier for the Domestic VRP Consent that this payment is made under.",
"maxLength": 25,
"minLength": 25,
"pattern": "^BARCLAYS-S-\\d{14}$"
},
"PSUAuthenticationMethod": {
"allOf": [
{
"$ref": "#/$defs/OBVRPAuthenticationMethods"
},
{
"type": "string",
"description": "The authentication method that was used to authenticate the PSU."
}
]
},
"PSUInteractionType": {
"allOf": [
{
"$ref": "#/$defs/OBVRPInteractionTypes"
},
{
"type": "string",
"description": "Indicates interaction type, currently if customer is present or not present. If not provided the default is `OffSession` (customer is not present) when the individual VRP payment is made."
}
]
},
"VRPType": {
"$ref": "#/$defs/OBVRPConsentType"
},
"Initiation": {
"$ref": "#/$defs/OBDomesticVRPInitiation"
},
"Instruction": {
"$ref": "#/$defs/OBDomesticVRPInstruction"
}
},
"required": [
"ConsentId",
"Initiation",
"Instruction",
"PSUAuthenticationMethod",
"VRPType"
]
},
"Risk": {
"$ref": "#/$defs/OBRisk1"
}
},
"required": [
"Data",
"Risk"
],
"nullable": false,
"$defs": {
"ActiveOrHistoricCurrencyCode": {
"type": "string",
"description": "A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\".",
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3,3}$"
},
"BuildingName": {
"type": "string",
"description": "Name of a referenced building.",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,\\/]{1,140})$"
},
"BuildingNumber": {
"type": "string",
"description": "Number that identifies the position of a building on a street.",
"maxLength": 16,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9 \\s]{1,16})$"
},
"CareOf": {
"type": "string",
"description": "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 for the individual.",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,\\/]{1,140})$"
},
"CountryCode": {
"type": "string",
"description": "Nation with its own government.",
"maxLength": 2,
"minLength": 2,
"pattern": "^(?!\\s)[A-Z]{2,2}$"
},
"CountrySubDivision": {
"type": "string",
"description": "Identifies a subdivision of a country such as state, region, county.",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,]){1,35}$"
},
"Department": {
"type": "string",
"description": "Identification of a division of a large organisation or building.",
"maxLength": 70,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,\\/]){1,70}$"
},
"DistrictName": {
"type": "string",
"description": "Number that of the regional area, known as a district, which forms part of an address",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,\\/]{1,140})$"
},
"ExternalCategoryPurpose1Code": {
"type": "string",
"description": "Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For a full list of values refer to `ExternalCategoryPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"BONU",
"CASH",
"CBLK",
"CCRD",
"CGWV",
"CIPC",
"CONC",
"CORT",
"DCRD",
"DIVI",
"DVPM",
"EPAY",
"FCDT",
"FCIN",
"FCOL",
"GOVT",
"GP2P",
"HEDG",
"ICCP",
"IDCP",
"INTC",
"INTE",
"LBOX",
"LOAN",
"MP2B",
"MP2P",
"OTHR",
"PENS",
"RPRE",
"RRCT",
"RVPM",
"SALA",
"SECU",
"SSBE",
"SUPP",
"SWEP",
"TAXS",
"TOPG",
"TRAD",
"TREA",
"VATX",
"VOST",
"WHLD",
"ZABA"
]
},
"ExternalCreditorReferenceType1Code": {
"type": "string",
"description": "Specifies the amount type, as published in an external referred amount code set. For a full lust of values refer to `ExternalCreditorReferenceType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"DISP",
"FXDR",
"PUOR",
"RPIN",
"RADM",
"SCOR"
]
},
"ExternalDocumentType1Code": {
"type": "string",
"description": "Specifies the document type as published in an external document type code list. For a full list of values refer to `ExternalDocumentType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"CINV",
"CNFA",
"CONT",
"CREN",
"DEBN",
"DISP",
"DNFA",
"HIRI",
"INVS",
"MSIN",
"PROF",
"PUOR",
"QUOT",
"SBIN",
"SPRR",
"TISH",
"USAR",
"AROI",
"BOLD",
"CMCN",
"SOAC",
"TSUT",
"VCHR"
]
},
"ExternalProxyAccountType1Code": {
"type": "string",
"description": "Specifies the external proxy account type code, as published in the proxy account type external code set.<br /> For a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"TELE",
"EMAL",
"DNAM",
"CINC",
"COTX",
"COID",
"CUST",
"DRLC",
"EIDN",
"EWAL",
"PVTX",
"LEIC",
"MBNO",
"NIDN",
"CCPT",
"SHID",
"SOSE",
"TOKN",
"UBIL",
"VIPN",
"BIID"
]
},
"Floor": {
"type": "string",
"description": "Number that identifies the level within a building",
"maxLength": 70,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,\\/]{1,70})$"
},
"ISODateTime": {
"type": "string",
"format": "date-time",
"description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
},
"LEI": {
"type": "string",
"description": "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 \"Financial Services - Legal Entity Identifier (LEI)\".",
"maxLength": 20,
"minLength": 20,
"pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$"
},
"OBActiveCurrencyAndAmount_SimpleType": {
"type": "string",
"description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.",
"maxLength": 19,
"minLength": 3,
"pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$"
},
"OBActiveOrHistoricCurrencyAndAmount": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"Amount": {
"$ref": "#/$defs/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
}
},
"required": [
"Amount",
"Currency"
],
"nullable": false
},
"OBAddressType2Code": {
"type": "string",
"description": "Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).",
"enum": [
"BIZZ",
"DLVY",
"MLTO",
"PBOX",
"ADDR",
"HOME",
"CORR",
"STAT"
]
},
"OBCashAccountCreditor3": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"SchemeName": {
"$ref": "#/$defs/OBInternalAccountIdentification4Code"
},
"Identification": {
"type": "string",
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"maxLength": 256,
"minLength": 1,
"pattern": "^\\d{14}$|^[A-Z]{2}\\d{2}[A-Z0-9]{1,30}$|^\\d{16}$"
},
"Name": {
"type": "string",
"description": "Name of the account, as assigned by the account servicing institution.\nUsage: the account name is the name or names of the account owner(s) represented at an account level.\nThe account name is not the product name or the nickname of the account.",
"maxLength": 70,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '()£=\"_,&@#\\/;+]{1,70})$"
},
"SecondaryIdentification": {
"type": "string",
"description": "This is secondary identification of the account, as assigned by the account servicing institution.\nThis can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)",
"maxLength": 34,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '()£=\"_,&@#\\/;+]{1,34})$"
},
"Proxy": {
"$ref": "#/$defs/OBProxy1"
}
},
"required": [
"Identification",
"Name",
"SchemeName"
],
"nullable": false
},
"OBCashAccountDebtorWithName": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"SchemeName": {
"$ref": "#/$defs/OBInternalAccountIdentification4Code"
},
"Identification": {
"type": "string",
"description": "^ Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"maxLength": 256,
"minLength": 1,
"pattern": "^\\d{14}$|^[A-Z]{2}\\d{2}[A-Z0-9]{1,30}$|^\\d{16}$"
},
"Name": {
"type": "string",
"description": "^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.",
"maxLength": 70,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '()£=\"_,&@#\\/;+]{1,70})$"
},
"SecondaryIdentification": {
"type": "string",
"description": "^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)",
"maxLength": 34,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '()£=\"_,&@#\\/;+]{1,34})$"
},
"Proxy": {
"$ref": "#/$defs/OBProxy1"
}
},
"required": [
"Identification",
"SchemeName"
],
"nullable": false
},
"OBDomesticVRPInitiation": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"DebtorAccount": {
"$ref": "#/$defs/OBCashAccountDebtorWithName"
},
"CreditorAccount": {
"$ref": "#/$defs/OBCashAccountCreditor3"
},
"CreditorPostalAddress": {
"$ref": "#/$defs/OBPostalAddress7"
},
"UltimateCreditor": {
"$ref": "#/$defs/OBUltimateCreditor1"
},
"UltimateDebtor": {
"$ref": "#/$defs/OBUltimateDebtor1"
},
"RemittanceInformation": {
"$ref": "#/$defs/OBRemittanceInformation2"
},
"RegulatoryReporting": {
"type": "array",
"items": {
"$ref": "#/$defs/OBRegulatoryReporting1"
},
"maxItems": 3,
"minItems": 0
}
},
"nullable": false
},
"OBDomesticVRPInstruction": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"InstructionIdentification": {
"type": "string",
"description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction.\nIt can be included in several messages related to the instruction.",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '()£=\"_]{1,35})$"
},
"EndToEndIdentification": {
"type": "string",
"description": "Unique identification assigned by the initiating party to unambiguously identify the transaction.\nThis identification is passed on, unchanged, throughout the entire end-to-end chain.\nUsage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction.\nIt can be included in several messages related to the transaction.\nOB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '()£=\"_]{1,35})$"
},
"RemittanceInformation": {
"$ref": "#/$defs/OBRemittanceInformation2"
},
"LocalInstrument": {
"$ref": "#/$defs/OBInternalLocalInstrument1Code"
},
"InstructedAmount": {
"$ref": "#/$defs/OBActiveOrHistoricCurrencyAndAmount"
},
"CreditorPostalAddress": {
"$ref": "#/$defs/OBPostalAddress7"
},
"CreditorAccount": {
"$ref": "#/$defs/OBCashAccountCreditor3"
},
"UltimateCreditor": {
"$ref": "#/$defs/OBUltimateCreditor1"
},
"SupplementaryData": {
"type": "object",
"additionalProperties": false,
"description": "Additional information that can not be captured in the structured fields and/or any other specific block.\n"
}
},
"required": [
"CreditorAccount",
"EndToEndIdentification",
"InstructedAmount",
"InstructionIdentification"
],
"nullable": false
},
"OBExternalPurpose1Code": {
"type": "string",
"description": "For a full set of values refer to `ExternalPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"BKDF",
"BKFE",
"BKFM",
"BKIP",
"BKPP",
"CBLK",
"CDCB",
"CDCD",
"CDCS",
"CDDP",
"CDOC",
"CDQC",
"ETUP",
"FCOL",
"MTUP",
"ACCT",
"CASH",
"COLL",
"CSDB",
"DEPT",
"INTC",
"INTP",
"LIMA",
"NETT",
"BFWD",
"CCIR",
"CCPC",
"CCPM",
"CCSM",
"CRDS",
"CRPR",
"CRSP",
"CRTL",
"EQPT",
"EQUS",
"EXPT",
"EXTD",
"FIXI",
"FWBC",
"FWCC",
"FWSB",
"FWSC",
"MARG",
"MBSB",
"MBSC",
"MGCC",
"MGSC",
"OCCC",
"OPBC",
"OPCC",
"OPSB",
"OPSC",
"OPTN",
"OTCD",
"REPO",
"RPBC",
"RPCC",
"RPSB",
"RPSC",
"RVPO",
"SBSC",
"SCIE",
"SCIR",
"SCRP",
"SHBC",
"SHCC",
"SHSL",
"SLEB",
"SLOA",
"SWBC",
"SWCC",
"SWPT",
"SWSB",
"SWSC",
"TBAS",
"TBBC",
"TBCC",
"TRCP",
"AGRT",
"AREN",
"BEXP",
"BOCE",
"COMC",
"CPYR",
"GDDS",
"GDSV",
"GSCB",
"LICF",
"MP2B",
"POPE",
"ROYA",
"SCVE",
"SERV",
"SUBS",
"SUPP",
"TRAD",
"CHAR",
"COMT",
"MP2P",
"ECPG",
"ECPR",
"ECPU",
"EPAY",
"CLPR",
"COMP",
"DBTC",
"GOVI",
"HLRP",
"HLST",
"INPC",
"INPR",
"INSC",
"INSU",
"INTE",
"LBRI",
"LIFI",
"LOAN",
"LOAR",
"PENO",
"PPTI",
"RELG",
"RINP",
"TRFD",
"FORW",
"FXNT",
"ADMG",
"ADVA",
"BCDM",
"BCFG",
"BLDM",
"BNET",
"CBFF",
"CBFR",
"CCRD",
"CDBL",
"CFEE",
"CGDD",
"CORT",
"COST",
"CPKC",
"DCRD",
"DSMT",
"DVPM",
"EDUC",
"FACT",
"FAND",
"FCPM",
"FEES",
"GIFT",
"GOVT",
"ICCP",
"IDCP",
"IHRP",
"INSM",
"IVPT",
"MCDM",
"MCFG",
"MSVC",
"NOWS",
"OCDM",
"OCFG",
"OFEE",
"OTHR",
"PADD",
"PTSP",
"RCKE",
"RCPT",
"REBT",
"REFU",
"RENT",
"REOD",
"RIMB",
"RPNT",
"RRBN",
"RRCT",
"RRTP",
"RVPM",
"SLPI",
"SPLT",
"STDY",
"TBAN",
"TBIL",
"TCSC",
"TELI",
"TMPG",
"TPRI",
"TPRP",
"TRNC",
"TRVC",
"WEBI",
"IPAY",
"IPCA",
"IPDO",
"IPEA",
"IPEC",
"IPEW",
"IPPS",
"IPRT",
"IPU2",
"IPUW",
"ANNI",
"CAFI",
"CFDI",
"CMDT",
"DERI",
"DIVD",
"FREX",
"HEDG",
"INVS",
"PRME",
"SAVG",
"SECU",
"SEPI",
"TREA",
"UNIT",
"FNET",
"FUTR",
"ANTS",
"CVCF",
"DMEQ",
"DNTS",
"HLTC",
"HLTI",
"HSPC",
"ICRF",
"LTCF",
"MAFC",
"MARF",
"MDCS",
"VIEW",
"CDEP",
"SWFP",
"SWPP",
"SWRS",
"SWUF",
"ADCS",
"AEMP",
"ALLW",
"ALMY",
"BBSC",
"BECH",
"BENE",
"BONU",
"CCHD",
"COMM",
"CSLP",
"GFRP",
"GVEA",
"GVEB",
"GVEC",
"GVED",
"GWLT",
"HREC",
"PAYR",
"PEFC",
"PENS",
"PRCP",
"RHBS",
"SALA",
"SPSP",
"SSBE",
"LBIN",
"LCOL",
"LFEE",
"LMEQ",
"LMFI",
"LMRK",
"LREB",
"LREV",
"LSFL",
"ESTX",
"FWLV",
"GSTX",
"HSTX",
"INTX",
"NITX",
"PTXP",
"RDTX",
"TAXS",
"VATX",
"WHLD",
"TAXR",
"B112",
"BR12",
"TLRF",
"TLRR",
"AIRB",
"BUSB",
"FERB",
"RLWY",
"TRPT",
"CBTV",
"ELEC",
"ENRG",
"GASB",
"NWCH",
"NWCM",
"OTLC",
"PHON",
"UBIL",
"WTER",
"BOND",
"CABD",
"CAEQ",
"CBCR",
"DBCR",
"DICL",
"EQTS",
"FLCR",
"EFTC",
"EFTD",
"MOMA",
"RAPI",
"GAMB",
"LOTT",
"AMEX",
"SASW",
"AUCO",
"PCOM",
"PDEP",
"PLDS",
"PLRF",
"GAFA",
"GAHO",
"CPEN",
"DEPD",
"RETL",
"DEBT",
"CRYP"
]
},
"OBInternalAccountIdentification4Code": {
"type": "string",
"description": "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 *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber",
"UK.OBIE.Wallet"
]
},
"OBInternalExtendedAccountType1Code": {
"type": "string",
"description": "Specifies the extended type of account if known. For a full set of values refer to `OBInternalExtendedAccountType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"Business",
"BusinessSavingsAccount",
"Charity",
"Collection",
"Corporate",
"Ewallet",
"Government",
"Investment",
"ISA",
"JointPersonal",
"Pension",
"Personal",
"PersonalSavingsAccount",
"Premier",
"Wealth"
]
},
"OBInternalLocalInstrument1Code": {
"type": "string",
"description": "User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.\nFor a full list of values refer to `OBInternalLocalInstrument1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"UK.OBIE.BACS",
"UK.OBIE.BalanceTransfer",
"UK.OBIE.CHAPS",
"UK.OBIE.Euro1",
"UK.OBIE.FPS",
"UK.OBIE.Link",
"UK.OBIE.MoneyTransfer",
"UK.OBIE.Paym",
"UK.OBIE.SEPACreditTransfer",
"UK.OBIE.SEPAInstantCreditTransfer",
"UK.OBIE.SWIFT",
"UK.OBIE.Target2"
]
},
"OBPostalAddress7": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"description": "Information that locates and identifies a specific address, as defined by postal services.",
"properties": {
"AddressType": {
"$ref": "#/$defs/OBAddressType2Code"
},
"Department": {
"$ref": "#/$defs/Department"
},
"SubDepartment": {
"$ref": "#/$defs/SubDepartment"
},
"StreetName": {
"$ref": "#/$defs/StreetName"
},
"BuildingNumber": {
"$ref": "#/$defs/BuildingNumber"
},
"BuildingName": {
"$ref": "#/$defs/BuildingName"
},
"Floor": {
"$ref": "#/$defs/Floor"
},
"UnitNumber": {
"$ref": "#/$defs/UnitNumber"
},
"Room": {
"$ref": "#/$defs/Room"
},
"PostBox": {
"$ref": "#/$defs/PostBox"
},
"TownLocationName": {
"$ref": "#/$defs/TownName"
},
"DistrictName": {
"$ref": "#/$defs/DistrictName"
},
"CareOf": {
"$ref": "#/$defs/CareOf"
},
"PostCode": {
"$ref": "#/$defs/PostCode"
},
"TownName": {
"$ref": "#/$defs/TownName"
},
"CountrySubDivision": {
"$ref": "#/$defs/CountrySubDivision"
},
"Country": {
"$ref": "#/$defs/CountryCode"
},
"AddressLine": {
"type": "array",
"items": {
"type": "string",
"description": "Information that locates and identifies a specific address, as defined by postal services, presented in free format text.",
"maxLength": 70,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '()£=\"_,&@#\\/]{1,70})$"
},
"maxItems": 7,
"minItems": 1
}
},
"nullable": false
},
"OBProxy1": {
"type": "object",
"additionalProperties": false,
"description": "Specifies an alternate assumed name for the identification of the account.",
"properties": {
"Identification": {
"type": "string",
"description": "Identification used to indicate the account identification under another specified name.",
"maxLength": 2048,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,2048})$"
},
"Code": {
"$ref": "#/$defs/ExternalProxyAccountType1Code"
},
"Type": {
"type": "string",
"description": "Type of the proxy identification.",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,35})$"
}
},
"required": [
"Code",
"Identification"
]
},
"OBReferredDocumentInformation": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"Code": {
"$ref": "#/$defs/ExternalDocumentType1Code"
},
"Issuer": {
"type": "string",
"description": "Identification of the issuer of the reference document type.",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,35})$"
},
"Number": {
"type": "string",
"description": "Identification of the type specified for the referred document line.",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,35})$"
},
"RelatedDate": {
"$ref": "#/$defs/ISODateTime"
},
"LineDetails": {
"type": "array",
"description": "Set of elements used to provide the content of the referred document line.",
"items": {
"type": "string",
"maxLength": 2048,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,2048})$"
},
"maxItems": 3,
"minItems": 1
}
},
"nullable": false
},
"OBRegulatoryAuthority2": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"description": "Entity requiring the regulatory reporting information. ",
"properties": {
"Name": {
"type": "string",
"description": "Name of the entity requiring the regulatory reporting information.",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,140})$"
},
"CountryCode": {
"$ref": "#/$defs/CountryCode"
}
},
"nullable": false
},
"OBRegulatoryReporting1": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"description": "Information needed due to regulatory and statutory requirements",
"properties": {
"DebitCreditReportingIndicator": {
"type": "string",
"description": "Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values refer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"CRED",
"DEBT",
"BOTH"
]
},
"Authority": {
"$ref": "#/$defs/OBRegulatoryAuthority2"
},
"Details": {
"type": "array",
"description": "Set of elements used to provide details on the regulatory reporting information.",
"items": {
"$ref": "#/$defs/OBStructuredRegulatoryReporting3"
},
"maxItems": 3,
"minItems": 1
}
},
"nullable": false
},
"OBRemittanceInformation2": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"description": "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' receivable system",
"properties": {
"Structured": {
"type": "array",
"items": {
"$ref": "#/$defs/OBRemittanceInformationStructured"
},
"maxItems": 5,
"minItems": 1
},
"Unstructured": {
"type": "array",
"description": "Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.",
"items": {
"type": "string",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9\\-. '()£=\"_,&@#\\/;&+:]{1,140})$"
},
"maxItems": 4,
"minItems": 1
}
},
"nullable": false
},
"OBRemittanceInformationStructured": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"ReferredDocumentInformation": {
"type": "array",
"description": "Provides the identification and the content of the referred document.",
"items": {
"$ref": "#/$defs/OBReferredDocumentInformation"
},
"maxItems": 3,
"minItems": 1
},
"ReferredDocumentAmount": {
"$ref": "#/$defs/OBActiveCurrencyAndAmount_SimpleType"
},
"CreditorReferenceInformation": {
"type": "object",
"additionalProperties": false,
"description": "Reference information provided by the creditor to allow the identification of the underlying documents.",
"properties": {
"Code": {
"$ref": "#/$defs/ExternalCreditorReferenceType1Code"
},
"Issuer": {
"type": "string",
"description": "Entity that assigns the identification.",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,35})$"
},
"Reference": {
"type": "string",
"description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,35})$"
}
}
},
"Invoicer": {
"type": "string",
"description": "Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor",
"maxLe
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/barclays/refs/heads/main/json-schema/barclays-obdomestic-vrprequest-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/barclays-obdomestic-vrprequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.