UK Open Banking · Schema
Payment Initiation API
Swagger for Payment Initiation API Specification. **Please Note**: There are no optional fields, if a field is not marked as “Required” it is a Conditional field.
Open BankingFinancial ServicesPaymentsAccount InformationPSD2UKBankingFintechRegulated
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/open-banking-uk/refs/heads/main/json-schema/payment-initiation.json",
"title": "Payment Initiation API",
"description": "Swagger for Payment Initiation API Specification.\n\n**Please Note**: There are no optional fields, if a field is not marked as \u201cRequired\u201d it is a Conditional field.\n",
"version": "4.0.1",
"$defs": {
"OBDomesticRefundAccount1": {
"description": "Unambiguous identification of the refund account to which a refund will be made as a result of the transaction.",
"type": "object",
"additionalProperties": false,
"required": [
"Account"
],
"properties": {
"Account": {
"type": "object",
"additionalProperties": false,
"required": [
"SchemeName",
"Identification",
"Name"
],
"description": "Provides the details to identify an account.",
"properties": {
"SchemeName": {
"$ref": "#/components/schemas/OBInternalAccountIdentification4Code"
},
"Identification": {
"$ref": "#/components/schemas/Identification_0"
},
"Name": {
"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. 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.",
"type": "string",
"minLength": 1,
"maxLength": 350
},
"SecondaryIdentification": {
"$ref": "#/components/schemas/SecondaryIdentification"
}
}
}
}
},
"NumberOfPayments": {
"description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Frequency_1": {
"description": "Individual Definitions:\nNotKnown - Not Known\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlDay - An interval specified in number of calendar days (02 to 31)\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-05 to -01, 01 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED)\nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.\nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December.\nIndividual Patterns:\nNotKnown (ScheduleCode)\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlDay:NoOfDay (ScheduleCode + NoOfDay)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nNotKnown\nEvryDay\nEvryWorkgDay\nIntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1])\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$",
"type": "string",
"pattern": "^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$"
},
"OBUltimateCreditor1": {
"description": "Ultimate party to which an amount of money is due.",
"type": "object",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Identification": {
"description": "Identification assigned by an institution.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"LEI": {
"$ref": "#/components/schemas/LEI"
},
"SchemeName": {
"$ref": "#/components/schemas/OBInternalAccountIdentification4Code"
},
"PostalAddress": {
"$ref": "#/components/schemas/OBPostalAddress7"
}
}
},
"OBUltimateDebtor1": {
"description": "Ultimate party that owes an amount of money to the (ultimate) creditor.",
"type": "object",
"properties": {
"Name": {
"description": "Name by which a party is known and which is usually used to identify that party.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Identification": {
"description": "Identification assigned by an institution.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"LEI": {
"$ref": "#/components/schemas/LEI"
},
"SchemeName": {
"$ref": "#/components/schemas/OBInternalAccountIdentification4Code"
},
"PostalAddress": {
"$ref": "#/components/schemas/OBPostalAddress7"
}
}
},
"OBFrequency6": {
"description": "Regularity with which credit transfer instructions are to be created and processed",
"type": "object",
"required": [
"Type"
],
"properties": {
"Type": {
"oneOf": [
{
"$ref": "#/components/schemas/OBFrequency6Code"
},
{
"$ref": "#/components/schemas/Frequency_1"
}
]
},
"CountPerPeriod": {
"description": "Number of instructions to be created and processed during the specified period .Specifies a frequency in terms of a count per period within a specified frequency type. Note: should not be used alongside `PointInTime`",
"type": "integer",
"example": 1,
"format": "int32"
},
"PointInTime": {
"$ref": "#/components/schemas/PointInTime"
}
}
},
"PointInTime": {
"description": "Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside `CountPerPeriod`.",
"type": "string",
"example": "00",
"maxLength": 2
},
"ActiveOrHistoricCurrencyCode": {
"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\".",
"type": "string",
"pattern": "^[A-Z]{3,3}$"
},
"BuildingName": {
"description": "Name of a referenced building.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"BuildingNumber": {
"description": "Number that identifies the position of a building on a street.",
"type": "string",
"minLength": 1,
"maxLength": 16
},
"Date": {
"description": "Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date format. \n An example is below:\n2017-04-05",
"type": "string",
"format": "date"
},
"ExternalCategoryPurpose1Code": {
"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)",
"type": "string",
"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"
]
},
"CareOf": {
"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.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"CountryCode": {
"description": "Nation with its own government.",
"type": "string",
"pattern": "^[A-Z]{2,2}$"
},
"CountrySubDivision": {
"description": "Identifies a subdivision of a country such as state, region, county.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"DistrictName": {
"description": "Number that of the regional area, known as a district, which forms part of an address",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"Department": {
"description": "Identification of a division of a large organisation or building.",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"File": {
"type": "object",
"additionalProperties": false,
"properties": {}
},
"Floor": {
"description": "Number that identifies the level within a building",
"type": "string",
"minLength": 1,
"maxLength": 70
},
"ISODateTime": {
"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",
"type": "string",
"format": "date-time"
},
"Identification_0": {
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Identification_1": {
"description": "Unique identification, as assigned by the creditor, to unambiguously identify the mandate.",
"type": "string",
"minLength": 1,
"maxLength": 35
},
"Identification_3": {
"description": "Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor",
"type": "string",
"example": "80200112344562",
"minLength": 1,
"maxLength": 256
},
"Identification_4": {
"description": "Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.",
"type": "string",
"example": "80200112344562",
"minLength": 1,
"maxLength": 256
},
"LEI": {
"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)\".",
"type": "string",
"example": "IZ9Q00LZEVUKWCQY6X15",
"minLength": 1,
"maxLength": 20,
"pattern": "^[A-Z0-9]{18,18}[0-9]{2,2}$"
},
"Links": {
"type": "object",
"additionalProperties": false,
"description": "Links relevant to the payload",
"properties": {
"Self": {
"type": "string",
"format": "uri"
},
"First": {
"type": "string",
"format": "uri"
},
"Prev": {
"type": "string",
"format": "uri"
},
"Next": {
"type": "string",
"format": "uri"
},
"Last": {
"type": "string",
"format": "uri"
}
},
"required": [
"Self"
]
},
"Meta": {
"title": "MetaData",
"type": "object",
"additionalProperties": false,
"description": "Meta Data relevant to the payload",
"properties": {
"TotalPages": {
"type": "integer",
"format": "int32"
},
"FirstAvailableDateTime": {
"$ref": "#/components/schemas/ISODateTime"
},
"LastAvailableDateTime": {
"$ref": "#/components/schemas/ISODateTime"
}
}
},
"Name": {
"description": "Name by which an agent is known and which is usually used to identify that agent.",
"type": "string",
"minLength": 1,
"maxLength": 140
},
"OBActiveCurrencyAndAmount_SimpleType": {
"description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.",
"type": "string",
"pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$"
},
"OBActiveOrHistoricCurrencyAndAmount": {
"type": "object",
"additionalProperties": false,
"required": [
"Amount",
"Currency"
],
"description": "Amount of money associated with the charge type.",
"properties": {
"Amount": {
"$ref": "#/components/schemas/OBActiveCurrencyAndAmount_SimpleType"
},
"Currency": {
"$ref": "#/components/schemas/ActiveOrHistoricCurrencyCode"
}
}
},
"OBAddressTypeCode": {
"description": "Identifies the nature of the postal address.",
"type": "string",
"enum": [
"Business",
"Correspondence",
"DeliveryTo",
"MailTo",
"POBox",
"Postal",
"Residential",
"Statement"
]
},
"OBAddressType2Code": {
"description": "Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).",
"type": "string",
"enum": [
"BIZZ",
"DLVY",
"MLTO",
"PBOX",
"ADDR",
"HOME",
"CORR",
"STAT"
]
},
"OBBranchAndFinancialInstitutionIdentification6_0": {
"type": "object",
"description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.\nThis is the servicer of the beneficiary account.",
"properties": {
"SchemeName": {
"$ref": "#/components/schemas/OBInternalFinancialInstitutionIdentification4Code"
},
"Identification": {
"$ref": "#/components/schemas/Identification_1"
},
"Name": {
"$ref": "#/components/schemas/Name"
},
"PostalAddress": {
"$ref": "#/components/schemas/OBPostalAddress7"
},
"LEI": {
"$ref": "#/components/schemas/LEI"
}
}
},
"OBInternalChargeBearerType1Code": {
"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)",
"type": "string",
"enum": [
"BorneByCreditor",
"BorneByDebtor",
"FollowingServiceLevel",
"Shared"
]
},
"OBCashAccountCreditor3": {
"type": "object",
"properties": {
"SchemeName": {
"$ref": "#/components/schemas/OBInternalAccountIdentification4Code"
},
"Identification": {
"type": "string",
"description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
"maxLength": 256
},
"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."
},
"SecondaryIdentification": {
"type": "string",
"description": "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
},
"LEI": {
"$ref": "#/components/schemas/LEI"
},
"Proxy": {
"$ref": "#/components/schemas/OBProxy1"
}
},
"required": [
"SchemeName",
"Identification",
"Name"
]
},
"OBCashAccountDebtor4": {
"type": "object",
"description": "^ Only included in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent.",
"properties": {
"SchemeName": {
"type": "string",
"description": "^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code"
},
"Identification": {
"type": "string",
"description": "^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text"
},
"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."
},
"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) | Max34Text"
},
"LEI": {
"$ref": "#/components/schemas/LEI"
}
}
},
"OBExternalMandateClassification1Code": {
"type": "string",
"enum": [
"FIXE",
"USGB",
"VARI"
]
},
"OBError1": {
"type": "object",
"properties": {
"ErrorCode": {
"$ref": "#/components/schemas/OBExternalStatusReason1Code"
},
"Message": {
"description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBL doesn't standardise this field",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Path": {
"description": "Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"Url": {
"description": "URL to help remediate the problem, or provide more information, or to API Reference, or help etc",
"type": "string"
}
},
"required": [
"ErrorCode"
],
"additionalProperties": false,
"minProperties": 1
},
"OBErrorResponse1": {
"description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.",
"type": "object",
"additionalProperties": false,
"properties": {
"Id": {
"description": "A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"Code": {
"description": "Deprecated <br>High level textual error code, to help categorise the errors.",
"type": "string",
"minLength": 1,
"example": "400 BadRequest",
"maxLength": 40
},
"Message": {
"description": "Deprecated <br>Brief Error message",
"type": "string",
"minLength": 1,
"example": "There is something wrong with the request parameters provided",
"maxLength": 500
},
"Errors": {
"items": {
"$ref": "#/components/schemas/OBError1"
},
"type": "array",
"minItems": 1
}
},
"required": [
"Errors"
]
},
"OBInternalAccountIdentification4Code": {
"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)",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.BBAN",
"UK.OBIE.IBAN",
"UK.OBIE.PAN",
"UK.OBIE.Paym",
"UK.OBIE.SortCodeAccountNumber",
"UK.OBIE.Wallet"
]
},
"ExternalCreditorReferenceType1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4,
"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",
"minLength": 1,
"maxLength": 4,
"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",
"CONT",
"CREN",
"DEBN",
"DISP",
"DNFA",
"HIRI",
"INVS",
"MSIN",
"PROF",
"PUOR",
"QUOT",
"SBIN",
"SPRR",
"TISH"
]
},
"OBInternalFinancialInstitutionIdentification4Code": {
"description": "Name of the identification scheme, in a coded form as published in an external list.",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.BICFI"
]
},
"OBInternalExtendedAccountType1Code": {
"description": "Specifies the extended type of account.",
"type": "string",
"enum": [
"Business",
"BusinessSavingsAccount",
"Charity",
"Collection",
"Corporate",
"Ewallet",
"Government",
"Investment",
"ISA",
"JointPersonal",
"Pension",
"Personal",
"PersonalSavingsAccount",
"Premier",
"Wealth"
]
},
"OBInternalLocalInstrument1Code": {
"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)",
"type": "string",
"x-namespaced-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"
]
},
"OBInternalPaymentChargeType1Code": {
"description": "Charge type, in a coded form. For a full list of values refer to `OBInternalPaymentChargeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"type": "string",
"x-namespaced-enum": [
"UK.OBIE.CHAPSOut"
]
},
"ExternalPurpose1Code": {
"type": "string",
"minLength": 1,
"maxLength": 4,
"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"
]
},
"OBExternalStatusReason1Code": {
"description": "Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"type": "string",
"minLength": 4,
"maxLength": 4,
"example": "U001"
},
"OBFrequency6Code": {
"description": "For a full list of values see `OBFrequency6Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)",
"type": "string",
"enum": [
"ADHO",
"YEAR",
"DAIL",
"FRTN",
"INDA",
"MNTH",
"QURT",
"MIAN",
"WEEK",
"WODL",
"FOWK",
"TWMH",
"FOMH",
"FIMH",
"ALMH",
"NONE",
"LWMH",
"LXMH",
"TWYR"
]
},
"OBMandateRelatedInformation1": {
"type": "object",
"required": [
"Frequency"
],
"properties": {
"MandateIdentification": {
"$ref": "#/components/schemas/Identification_1"
},
"Classification": {
"$ref": "#/components/schemas/OBExternalMandateClassification1Code"
},
"CategoryPurposeCode": {
"$ref": "#/components/schemas/ExternalCategoryPurpose1Code"
},
"FirstPaymentDateTime": {
"type": "string",
"format": "date-time"
},
"RecurringPaymentDateTime": {
"description": "The date on which the first recurring payment for a Standing Order schedule will be made. \nUsage: This must
# --- truncated at 32 KB (394 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/open-banking-uk/refs/heads/main/json-schema/payment-initiation.json