{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/barclays/main/json-schema/barclays-obdomestic-vrpconsent-request-schema.json",
"title": "OBDomesticVRPConsentRequest",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/barclays-domestic-vrp-consents-api-openapi.yml#/components/schemas/OBDomesticVRPConsentRequest",
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"ReadRefundAccount": {
"type": "string",
"description": "Indicates whether the `RefundAccount` object should be included in the response\n",
"enum": [
"Yes",
"No"
]
},
"ControlParameters": {
"$ref": "#/$defs/OBDomesticVRPControlParameters"
},
"Initiation": {
"$ref": "#/$defs/OBDomesticVRPInitiation"
}
},
"required": [
"ControlParameters",
"Initiation"
],
"nullable": false
},
"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.
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
},
"OBDomesticVRPControlParameters": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"ValidFromDateTime": {
"type": "string",
"format": "date-time",
"description": "^ Start date time for which the consent remains valid."
},
"ValidToDateTime": {
"type": "string",
"format": "date-time",
"description": "^ End date time for which the consent remains valid."
},
"MaximumIndividualAmount": {
"$ref": "#/$defs/OBActiveOrHistoricCurrencyAndAmount"
},
"PeriodicLimits": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"PeriodType": {
"type": "string",
"description": "^ Period type for this period limit",
"enum": [
"Day",
"Week",
"Fortnight",
"Month",
"Half-year",
"Year"
]
},
"PeriodAlignment": {
"type": "string",
"description": "Specifies whether the period starts on the date of consent creation or lines up with a calendar. As the ISO calendar does not support or provide any guidance on when a fortnight should start, a `PeriodType` of `Fortnight` the `PeriodAlignment` must be `Consent`.",
"enum": [
"Consent",
"Calendar"
]
},
"Amount": {
"$ref": "#/$defs/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
}
},
"required": [
"Amount",
"Currency",
"PeriodAlignment",
"PeriodType"
]
},
"maxItems": 99999,
"minItems": 1
},
"VRPType": {
"type": "array",
"description": "^ The types of payments that can be made under this VRP consent. This can be used to indicate whether this include sweeping payment or other ecommerce payments.",
"items": {
"$ref": "#/$defs/OBVRPConsentType"
},
"maxItems": 99999,
"minItems": 1
},
"PSUAuthenticationMethods": {
"type": "array",
"description": "^ Indicates that the PSU authentication methods supported.",
"items": {
"$ref": "#/$defs/OBVRPAuthenticationMethods"
},
"maxItems": 99999,
"minItems": 1
},
"PSUInteractionTypes": {
"type": "array",
"description": "Indicates interaction type, currently if customer is present or not present. If not provided the default is `OffSession` (the customer is not present) when the individual VRP payment is made.",
"items": {
"$ref": "#/$defs/OBVRPInteractionTypes"
},
"maxItems": 99999,
"minItems": 0
},
"SupplementaryData": {
"type": "object",
"additionalProperties": false,
"description": "^ Additional information that can not be captured in the structured fields and/or any other specific block"
}
},
"required": [
"MaximumIndividualAmount",
"PSUAuthenticationMethods",
"PeriodicLimits",
"VRPType"
],
"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
},
"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"
]
},
"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",
"maxLength": 256,
"minLength": 0,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{0,256})$"
},
"Invoicee": {
"type": "string",
"description": "Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.",
"maxLength": 256,
"minLength": 0,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{0,256})$"
},
"TaxRemittance": {
"type": "string",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,140})$"
},
"AdditionalRemittanceInformation": {
"type": "array",
"items": {
"type": "string",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,140})$"
},
"maxItems": 3,
"minItems": 0
}
},
"nullable": false
},
"OBRisk1": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"description": "The Risk section is sent by the initiating party to the ASPSP.\nIt is used to specify additional details for risk scoring for Payments.",
"properties": {
"PaymentContextCode": {
"type": "string",
"description": "Specifies the payment context, for a full list of values refer to `OBInternalPaymentContext1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)\nThe following values are deprecated and can only be used to make a payment on an existing v3 consent which used one of the deprecated values and has been migrated to v4. They **must not** be used in a new consent. They may optionally be returned for a historical payment/consent migrated to v4:
\n* BillPayment - @deprecated\n* EcommerceGoods - @deprecated\n* EcommerceServices - @deprecated\n* PartyToParty - @deprecated\n* PispPayee - @deprecated\n* Other - @deprecated\n",
"enum": [
"BillingGoodsAndServicesInAdvance",
"BillingGoodsAndServicesInArrears",
"EcommerceMerchantInitiatedPayment",
"FaceToFacePointOfSale",
"TransferToSelf",
"TransferToThirdParty",
"BillPayment",
"EcommerceGoods",
"EcommerceServices",
"PartyToParty",
"PispPayee",
"Other"
]
},
"MerchantCategoryCode": {
"type": "string",
"description": "Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.",
"maxLength": 4,
"minLength": 3,
"pattern": "^(?!\\s)[a-zA-Z0-9]{3,4}$"
},
"MerchantCustomerIdentification": {
"type": "string",
"description": "The unique customer identifier of the PSU with the merchant.",
"maxLength": 70,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '()@#£=\"_|]{1,70})$"
},
"ContractPresentIndicator": {
"type": "boolean",
"description": "Indicates if Payee has a contractual relationship with the PISP."
},
"BeneficiaryPrepopulatedIndicator": {
"type": "boolean",
"description": "Indicates if PISP has immutably prepopulated payment details in for the PSU."
},
"PaymentPurposeCode": {
"$ref": "#/$defs/OBExternalPurpose1Code"
},
"CategoryPurposeCode": {
"$ref": "#/$defs/ExternalCategoryPurpose1Code"
},
"BeneficiaryAccountType": {
"$ref": "#/$defs/OBInternalExtendedAccountType1Code"
},
"DeliveryAddress": {
"$ref": "#/$defs/OBPostalAddress7"
}
},
"nullable": false
},
"OBStructuredRegulatoryReporting3": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"description": "Set of elements used to provide details on the regulatory reporting information.",
"properties": {
"Type": {
"type": "string",
"description": "Specifies the type of the information supplied in the regulatory reporting details",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,35})$"
},
"Date": {
"$ref": "#/$defs/ISODateTime"
},
"Country": {
"$ref": "#/$defs/CountryCode"
},
"Amount": {
"$ref": "#/$defs/OBActiveOrHistoricCurrencyAndAmount"
},
"Information": {
"type": "array",
"description": "Additional details that cater for specific domestic regulatory requirements. ",
"items": {
"type": "string",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,35})$"
},
"maxItems": 3,
"minItems": 1
}
},
"nullable": false
},
"OBUltimateCreditor1": {
"type": "object",
"additionalProperties": false,
"description": "Ultimate party to which an amount of money is due.",
"properties": {
"Name": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_-]{1,140})$"
},
"Identification": {
"type": "string",
"description": "Identification assigned by an institution.",
"maxLength": 256,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '_]{1,256})$"
},
"LEI": {
"$ref": "#/$defs/LEI"
},
"SchemeName": {
"$ref": "#/$defs/OBInternalAccountIdentification4Code"
},
"PostalAddress": {
"$ref": "#/$defs/OBPostalAddress7"
}
}
},
"OBUltimateDebtor1": {
"type": "object",
"additionalProperties": false,
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor.",
"properties": {
"Name": {
"type": "string",
"description": "Name by which a party is known and which is usually used to identify that party.",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_-]{1,140})$"
},
"Identification": {
"type": "string",
"description": "Identification assigned by an institution.",
"maxLength": 256,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '_]{1,256})$"
},
"LEI": {
"$ref": "#/$defs/LEI"
},
"SchemeName": {
"$ref": "#/$defs/OBInternalAccountIdentification4Code"
},
"PostalAddress": {
"$ref": "#/$defs/OBPostalAddress7"
}
}
},
"OBVRPAuthenticationMethods": {
"type": "string",
"enum": [
"UK.OBIE.SCA",
"UK.OBIE.SCANotRequired"
]
},
"OBVRPConsentType": {
"type": "string",
"enum": [
"UK.OBIE.VRPType.Sweeping",
"UK.OBIE.VRPType.Other"
]
},
"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. ",
"enum": [
"InSession",
"OffSession"
]
},
"PostBox": {
"type": "string",
"description": "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.",
"maxLength": 16,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,\\/]{1,16})$"
},
"PostCode": {
"type": "string",
"description": "Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.",
"maxLength": 16,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9 ]){1,16}$"
},
"Room": {
"type": "string",
"description": "Information that locates and identifies a room to form part of an address",
"maxLength": 70,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,\\/]{1,70})$"
},
"StreetName": {
"type": "string",
"description": "Name of a street or thoroughfare.",
"maxLength": 70,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,\\/]{1,70})$"
},
"SubDepartment": {
"type": "string",
"description": "Identification of a sub-division of a large organisation or building.",
"maxLength": 70,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,\\/]){1,70}$"
},
"TownName": {
"type": "string",
"description": "Name of a built-up area, with defined boundaries, and a local government.",
"maxLength": 35,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z- '.,]){1,35}$"
},
"UnitNumber": {
"type": "string",
"description": "Number that identifies the unit of a specific address .",
"maxLength": 16,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9- '.,\\/]{1,16})$"
}
}
}