{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/barclays/main/json-schema/barclays-obwrite-international-scheduled-consent5-schema.json",
"title": "OBWriteInternationalScheduledConsent5",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/barclays-international-scheduled-payments-api-openapi.yml#/components/schemas/OBWriteInternationalScheduledConsent5",
"type": "object",
"additionalProperties": false,
"deprecated": false,
"properties": {
"Data": {
"type": "object",
"additionalProperties": false,
"properties": {
"Permission": {
"type": "string",
"description": "Specifies the Open Banking service request types.",
"enum": [
"Create"
]
},
"ReadRefundAccount": {
"type": "string",
"description": "Specifies to share the refund account details with PISP",
"enum": [
"No",
"Yes"
]
},
"Initiation": {
"type": "object",
"additionalProperties": false,
"description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment.",
"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. It 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. This 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. It 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})$"
},
"LocalInstrument": {
"$ref": "#/$defs/OBInternalLocalInstrument1Code"
},
"InstructionPriority": {
"type": "string",
"description": "Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.",
"enum": [
"Normal",
"Urgent"
]
},
"ExtendedPurpose": {
"type": "string",
"description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_\\-]{1,140})$"
},
"ChargeBearer": {
"$ref": "#/$defs/OBInternalChargeBearerType1Code"
},
"RequestedExecutionDateTime": {
"type": "string",
"format": "date-time",
"description": "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited. 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"
},
"CurrencyOfTransfer": {
"type": "string",
"description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3,3}$"
},
"DestinationCountryCode": {
"type": "string",
"description": "Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).",
"maxLength": 2,
"minLength": 2,
"pattern": "^[A-Z]{2,2}$"
},
"InstructedAmount": {
"type": "object",
"additionalProperties": false,
"description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\nUsage: This amount has to be transported unchanged through the transaction chain.",
"properties": {
"Amount": {
"$ref": "#/$defs/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/$defs/ActiveOrHistoricCurrencyCode"
}
},
"required": [
"Amount",
"Currency"
]
},
"ExchangeRateInformation": {
"type": "object",
"additionalProperties": false,
"description": "Provides details on the currency exchange rate and contract.",
"properties": {
"UnitCurrency": {
"type": "string",
"description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3,3}$"
},
"ExchangeRate": {
"type": "number",
"description": "The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.",
"maximum": 99999999,
"minimum": 0
},
"RateType": {
"type": "string",
"description": "Specifies the type used to complete the currency exchange.",
"enum": [
"Actual",
"Agreed",
"Indicative"
]
},
"ContractIdentification": {
"type": "string",
"description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.",
"maxLength": 256,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_-]{1,256})$"
}
},
"required": [
"RateType",
"UnitCurrency"
]
},
"DebtorAccount": {
"type": "object",
"additionalProperties": false,
"description": "Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction.",
"properties": {
"SchemeName": {
"$ref": "#/$defs/OBInternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/$defs/Identification_0"
},
"Name": {
"type": "string",
"description": "The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.\nNote, 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": {
"$ref": "#/$defs/SecondaryIdentification"
},
"Proxy": {
"$ref": "#/$defs/OBProxy1"
}
},
"required": [
"Identification",
"SchemeName"
]
},
"Creditor": {
"type": "object",
"additionalProperties": false,
"description": "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})$"
},
"LEI": {
"$ref": "#/$defs/LEI"
},
"PostalAddress": {
"$ref": "#/$defs/OBPostalAddress7"
}
}
},
"CreditorAgent": {
"type": "object",
"additionalProperties": false,
"description": "Financial institution servicing an account for the creditor.",
"properties": {
"SchemeName": {
"$ref": "#/$defs/OBInternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#/$defs/Identification_1"
},
"LEI": {
"$ref": "#/$defs/LEI"
},
"Name": {
"$ref": "#/$defs/Name"
},
"PostalAddress": {
"$ref": "#/$defs/OBPostalAddress7"
}
}
},
"CreditorAccount": {
"type": "object",
"additionalProperties": false,
"description": "Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.",
"properties": {
"SchemeName": {
"$ref": "#/$defs/OBInternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/$defs/Identification_0"
},
"Name": {
"type": "string",
"description": "The account name is the name or names of the account owner(s) represented at an account level.\nNote, the account name is not the product name or the nickname of the account.\nOB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.",
"maxLength": 70,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '()£=\"_,&@#\\/;+]{1,70})$"
},
"SecondaryIdentification": {
"$ref": "#/$defs/SecondaryIdentification"
},
"Proxy": {
"$ref": "#/$defs/OBProxy1"
}
},
"required": [
"Identification",
"Name",
"SchemeName"
]
},
"UltimateCreditor": {
"$ref": "#/$defs/OBUltimateCreditor1"
},
"UltimateDebtor": {
"$ref": "#/$defs/OBUltimateDebtor1"
},
"RegulatoryReporting": {
"type": "array",
"items": {
"$ref": "#/$defs/OBRegulatoryReporting1"
},
"maxItems": 3,
"minItems": 0
},
"RemittanceInformation": {
"$ref": "#/$defs/OBRemittanceInformation2"
},
"SupplementaryData": {
"$ref": "#/$defs/OBSupplementaryData1"
}
},
"required": [
"CreditorAccount",
"CurrencyOfTransfer",
"InstructedAmount",
"InstructionIdentification",
"RequestedExecutionDateTime"
]
},
"Authorisation": {
"type": "object",
"additionalProperties": false,
"description": "The authorisation type request from the TPP.",
"properties": {
"AuthorisationType": {
"type": "string",
"description": "Type of authorisation flow requested.",
"enum": [
"Any",
"Single"
]
},
"CompletionDateTime": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the requested authorisation flow must be completed. 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"
}
},
"required": [
"AuthorisationType"
]
},
"SCASupportData": {
"$ref": "#/$defs/OBSCASupportData1"
}
},
"required": [
"Initiation",
"Permission"
]
},
"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": "^[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. \n For all enum values see `ExternalCategoryPurpose1Code` [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 type of creditor reference as published in an external creditor reference type code set. For more information see `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 more information see `ExternalDocumentType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"CINV",
"CNFA",
"CREN",
"DEBN",
"DISP",
"DNFA",
"HIRI",
"MSIN",
"PUOR",
"SBIN",
"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"
]
},
"ExternalPurpose1Code": {
"type": "string",
"description": "This is a partial list, For a full list see `ExternalPurpose1Code` [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"
]
},
"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"
},
"Identification_0": {
"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": "^[a-zA-Z0-9]{1,256}$"
},
"Identification_1": {
"type": "string",
"description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.",
"maxLength": 35,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,35}$"
},
"Identification_3": {
"type": "string",
"description": "Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor",
"maxLength": 256,
"minLength": 1,
"pattern": "^[a-zA-Z0-9]{1,256}$"
},
"Identification_4": {
"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": 1,
"pattern": "^[a-zA-Z0-9]{1,256}$"
},
"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}$"
},
"Name": {
"type": "string",
"description": "Name by which an agent is known and which is usually used to identify that agent.",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9-. '()£=\"_,&@#\\/;+]{1,140})$"
},
"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": 1,
"pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$"
},
"OBActiveOrHistoricCurrencyAndAmount": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"description": "Amount of money associated with the charge type.",
"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` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).",
"enum": [
"BIZZ",
"DLVY",
"MLTO",
"PBOX",
"ADDR",
"HOME",
"CORR",
"STAT"
]
},
"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"
]
},
"OBInternalChargeBearerType1Code": {
"type": "string",
"description": "Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to `OBInternalChargeBearerType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"BorneByCreditor",
"BorneByDebtor",
"FollowingServiceLevel",
"Shared"
]
},
"OBInternalExtendedAccountType1Code": {
"type": "string",
"description": "Specifies the extended type of account.",
"enum": [
"Business",
"BusinessSavingsAccount",
"Charity",
"Collection",
"Corporate",
"Ewallet",
"Government",
"Investment",
"ISA",
"JointPersonal",
"Pension",
"Personal",
"PersonalSavingsAccount",
"Premier",
"Wealth"
]
},
"OBInternalFinancialInstitutionIdentification4Code": {
"type": "string",
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"enum": [
"UK.OBIE.BICFI",
"UK.OBIE.NCC.GB"
]
},
"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. For 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,
"deprecated": 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"
],
"nullable": false
},
"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": {
"type": "string",
"format": "date-time",
"description": "Date associated with the referred document line."
},
"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": 0
}
},
"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 reefer 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",
"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",
"items": {
"$ref": "#/$defs/OBReferredDocumentInformation"
},
"maxItems": 3,
"minItems": 1
},
"ReferredDocumentAmount": {
"$ref": "#/$defs/OBActiveCurrencyAndAmount_SimpleType"
},
"CreditorReferenceInformation": {
"type": "object",
"additionalProperties": false,
"deprecated": 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})$"
}
},
"nullable": false
},
"Invoicer": {
"$ref": "#/$defs/Identification_3"
},
"Invoicee": {
"$ref": "#/$defs/Identification_4"
},
"TaxRemittance": {
"type": "string",
"description": "Provides remittance information about a payment made for tax-related purposes.",
"maxLength": 140,
"minLength": 1,
"pattern": "^(?!\\s)([A-Za-z0-9!+\\/\\= '.,@#()_-]{1,140})$"
},
"AdditionalRemittanceInformation": {
"type": "array",
"description": "Additional information, in free text form, to complement the structured remittance information.",
"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, `OBInternalPaymentContext1Code`\nThe following values are deprecated and **must not** be used in a new consent or payment. They may optionally be returned for a hstorical 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/ExternalPurpose1Code"
},
"CategoryPurposeCode": {
"$ref": "#/$defs/ExternalCategoryPurpose1Code"
},
"BeneficiaryAccountType": {
"$ref": "#/$defs/OBInternalExtendedAccountType1Code"
},
"DeliveryAddress": {
"$ref": "#/$defs/OBPostalAddress7"
}
},
"nullable": false
},
"OBSCASupportData1": {
"type": "object",
"additionalProperties": false,
"deprecated": false,
"description": "Supporting Data provided by TPP, when requesting SCA Exemption.",
"properties": {
"RequestedSCAExemptionType": {
"type": "string",
"description": "This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to `OBInternalSCAExemptionType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"BillPayment",
"ContactlessTravel",
"EcommerceGoods",
"EcommerceServices",
"Kiosk",
"Parking",
"PartyToParty"
]
},
"AppliedAuthenticationApproach": {
"type": "string",
"description": "Specifies a character string with a maximum length of 40 characters.\nUsage: This field indicates whether the PSU was subject to SCA performed by the TPP\nFor a full list of values refer to `OBInternalAppliedAuthenticationApproach1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"enum": [
"CA",
"SCA"
]
},
"ReferencePaymentOrderId": {
"type": "string",
"description": "If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId",
"maxLength": 40,
"minLength": 1,
"pattern": "^(?!\\s)([a-zA-Z0-9\\-. '()£=\"_,&@#\\/&+]{1,40})$"
}
},
"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
},
"OBSupplementaryData1": {
"type": "object",
"additionalProperties": true,
"description": "Additional information that can not be captured in the structured fields and/or any other specific block."
},
"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"
}
}
},
"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})$"
},
"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})$"
},
"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})$"
}
}
}