OBActiveCurrencyAndAmount_SimpleType

                    {
    "type": "string",
    "pattern": "^\\d{1,13}\\.\\d{1,5}$"
}
              

OBAddressTypeCode

                    {
    "type": "string",
    "enum": [
        "Business",
        "Correspondence",
        "DeliveryTo",
        "MailTo",
        "POBox",
        "Postal",
        "Residential",
        "Statement"
    ]
}
              

OBChargeBearerType1Code

                    {
    "type": "string",
    "enum": [
        "BorneByCreditor",
        "BorneByDebtor",
        "FollowingServiceLevel",
        "Shared"
    ]
}
              

OBDomesticScheduled2

                    {
    "type": "object",
    "properties": {
        "InstructionIdentification": {
            "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.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "EndToEndIdentification": {
            "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.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "LocalInstrument": {
            "$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
        },
        "RequestedExecutionDateTime": {
            "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.\nAll 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"
        },
        "InstructedAmount": {
            "type": "object",
            "properties": {
                "Amount": {
                    "$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
                },
                "Currency": {
                    "type": "string",
                    "pattern": "^[A-Z]{3,3}$"
                }
            },
            "required": [
                "Amount",
                "Currency"
            ],
            "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."
        },
        "DebtorAccount": {
            "$ref": "#\/definitions\/OBCashAccountDebtor4"
        },
        "CreditorAccount": {
            "$ref": "#\/definitions\/OBCashAccountCreditor3"
        },
        "CreditorPostalAddress": {
            "$ref": "#\/definitions\/OBPostalAddress6"
        },
        "RemittanceInformation": {
            "$ref": "#\/definitions\/OBRemittanceInformation1"
        },
        "SupplementaryData": {
            "$ref": "#\/definitions\/OBSupplementaryData1"
        }
    },
    "required": [
        "InstructionIdentification",
        "RequestedExecutionDateTime",
        "InstructedAmount",
        "CreditorAccount"
    ],
    "additionalProperties": false
}
              

OBDomesticStandingOrder2

                    {
    "type": "object",
    "properties": {
        "Frequency": {
            "description": "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\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 (-5 to -1, 1 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:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\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:\nEvryDay\nEvryWorkgDay\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^(EvryDay)$|^(EvryWorkgDay)$|^(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",
            "minLength": 1,
            "maxLength": 35,
            "pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(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))$"
        },
        "Reference": {
            "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "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
        },
        "FirstPaymentDateTime": {
            "description": "The date on which the first payment for a Standing Order schedule will be made.\nAll 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"
        },
        "RecurringPaymentDateTime": {
            "description": "The date on which the first recurring payment for a Standing Order schedule will be made. \nUsage: This must be populated only if the first recurring date is different to the first payment date.\nAll 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"
        },
        "FinalPaymentDateTime": {
            "description": "The date on which the final payment for a Standing Order schedule will be made.\nAll 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"
        },
        "FirstPaymentAmount": {
            "type": "object",
            "properties": {
                "Amount": {
                    "$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
                },
                "Currency": {
                    "type": "string",
                    "pattern": "^[A-Z]{3,3}$"
                }
            },
            "required": [
                "Amount",
                "Currency"
            ],
            "additionalProperties": false,
            "description": "The amount of the first Standing Order"
        },
        "RecurringPaymentAmount": {
            "type": "object",
            "properties": {
                "Amount": {
                    "$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
                },
                "Currency": {
                    "type": "string",
                    "pattern": "^[A-Z]{3,3}$"
                }
            },
            "required": [
                "Amount",
                "Currency"
            ],
            "additionalProperties": false,
            "description": "The amount of the recurring Standing Order"
        },
        "FinalPaymentAmount": {
            "type": "object",
            "properties": {
                "Amount": {
                    "$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
                },
                "Currency": {
                    "type": "string",
                    "pattern": "^[A-Z]{3,3}$"
                }
            },
            "required": [
                "Amount",
                "Currency"
            ],
            "additionalProperties": false,
            "description": "The amount of the final Standing Order"
        },
        "DebtorAccount": {
            "$ref": "#\/definitions\/OBCashAccountDebtor4"
        },
        "CreditorAccount": {
            "$ref": "#\/definitions\/OBCashAccountCreditor3"
        },
        "SupplementaryData": {
            "$ref": "#\/definitions\/OBSupplementaryData1"
        }
    },
    "required": [
        "Frequency",
        "FirstPaymentDateTime",
        "FirstPaymentAmount",
        "CreditorAccount"
    ],
    "additionalProperties": false
}
              

OBSupplementaryData1

                    {
    "type": "object",
    "properties": [],
    "additionalProperties": false
}
              

OBExternalAccountIdentification4Code

                    {
    "type": "string",
    "example": [
        "UK.OBIE.BBAN",
        "UK.OBIE.IBAN",
        "UK.OBIE.PAN",
        "UK.OBIE.Paym",
        "UK.OBIE.SortCodeAccountNumber"
    ],
    "minLength": 1,
    "maxLength": 40
}
              

OBCashAccountDebtor4

                    {
    "type": "object",
    "properties": {
        "SchemeName": {
            "$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
        },
        "Identification": {
            "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
        },
        "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.",
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "SecondaryIdentification": {
            "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).",
            "type": "string",
            "minLength": 1,
            "maxLength": 34
        }
    },
    "required": [
        "SchemeName",
        "Identification"
    ],
    "additionalProperties": false
}
              

OBCashAccountCreditor3

                    {
    "type": "object",
    "properties": {
        "SchemeName": {
            "$ref": "#\/definitions\/OBExternalAccountIdentification4Code"
        },
        "Identification": {
            "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
        },
        "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": 70
        },
        "SecondaryIdentification": {
            "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).",
            "type": "string",
            "minLength": 1,
            "maxLength": 34
        }
    },
    "required": [
        "SchemeName",
        "Identification",
        "Name"
    ],
    "additionalProperties": false
}
              

OBExternalPaymentContext1Code

                    {
    "type": "string",
    "enum": [
        "BillPayment",
        "EcommerceGoods",
        "EcommerceServices",
        "Other",
        "PartyToParty"
    ]
}
              

OBExternalStatus1Code

                    {
    "type": "string",
    "enum": [
        "InitiationCompleted",
        "InitiationFailed",
        "InitiationPending"
    ]
}
              

OBExternalStatus2Code

                    {
    "type": "string",
    "enum": [
        "Authorised",
        "AwaitingFurtherAuthorisation",
        "Rejected"
    ]
}
              

OBMultiAuthorisation1

                    {
    "type": "object",
    "properties": {
        "Status": {
            "$ref": "#\/definitions\/OBExternalStatus2Code"
        },
        "NumberRequired": {
            "description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
            "type": "integer",
            "format": "int32"
        },
        "NumberReceived": {
            "description": "Number of authorisations required for payment order (total required at the start of the multi authorisation journey).",
            "type": "integer",
            "format": "int32"
        },
        "LastUpdateDateTime": {
            "description": "Last date and time at the authorisation flow was updated.\nAll 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"
        },
        "ExpirationDateTime": {
            "description": "Date and time at which the requested authorisation flow must be completed.\nAll 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"
        }
    },
    "required": [
        "Status"
    ],
    "additionalProperties": false
}
              

OBPostalAddress6

                    {
    "type": "object",
    "properties": {
        "AddressType": {
            "$ref": "#\/definitions\/OBAddressTypeCode"
        },
        "Department": {
            "description": "Identification of a division of a large organisation or building.",
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "SubDepartment": {
            "description": "Identification of a sub-division of a large organisation or building.",
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "StreetName": {
            "description": "Name of a street or thoroughfare.",
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "BuildingNumber": {
            "description": "Number that identifies the position of a building on a street.",
            "type": "string",
            "minLength": 1,
            "maxLength": 16
        },
        "PostCode": {
            "description": "Identifier consisting of a group of letters and\/or numbers that is added to a postal address to assist the sorting of mail.",
            "type": "string",
            "minLength": 1,
            "maxLength": 16
        },
        "TownName": {
            "description": "Name of a built-up area, with defined boundaries, and a local government.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "CountrySubDivision": {
            "description": "Identifies a subdivision of a country such as state, region, county.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "Country": {
            "description": "Nation with its own government.",
            "type": "string",
            "pattern": "^[A-Z]{2,2}$"
        },
        "AddressLine": {
            "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 70
            },
            "type": "array",
            "description": "Information that locates and identifies a specific address, as defined by postal services, presented in free format text.",
            "minItems": 0,
            "maxItems": 7
        }
    },
    "additionalProperties": false
}
              

OBRemittanceInformation1

                    {
    "type": "object",
    "properties": {
        "Unstructured": {
            "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.",
            "type": "string",
            "minLength": 1,
            "maxLength": 140
        },
        "Reference": {
            "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.\nOB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        }
    },
    "additionalProperties": false
}
              

OBRisk1

                    {
    "type": "object",
    "properties": {
        "PaymentContextCode": {
            "$ref": "#\/definitions\/OBExternalPaymentContext1Code"
        },
        "MerchantCategoryCode": {
            "description": "Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.",
            "type": "string",
            "minLength": 3,
            "maxLength": 4
        },
        "MerchantCustomerIdentification": {
            "description": "The unique customer identifier of the PSU with the merchant.",
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "DeliveryAddress": {
            "description": "Information that locates and identifies a specific address, as defined by postal services or in free format text.",
            "type": "object",
            "properties": {
                "AddressLine": {
                    "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 70
                    },
                    "type": "array",
                    "description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.",
                    "minItems": 0,
                    "maxItems": 2
                },
                "StreetName": {
                    "description": "Name of a street or thoroughfare.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 70
                },
                "BuildingNumber": {
                    "description": "Number that identifies the position of a building on a street.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 16
                },
                "PostCode": {
                    "description": "Identifier consisting of a group of letters and\/or numbers that is added to a postal address to assist the sorting of mail.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 16
                },
                "TownName": {
                    "description": "Name of a built-up area, with defined boundaries, and a local government.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 35
                },
                "CountrySubDivision": {
                    "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 35
                    },
                    "type": "array",
                    "description": "Identifies a subdivision of a country, for instance state, region, county.",
                    "minItems": 0,
                    "maxItems": 2
                },
                "Country": {
                    "description": "Nation with its own government, occupying a particular territory.",
                    "type": "string",
                    "pattern": "^[A-Z]{2,2}$"
                }
            },
            "required": [
                "TownName",
                "Country"
            ],
            "additionalProperties": false
        }
    },
    "additionalProperties": false
}
              

OBTransactionIndividualStatus1Code

                    {
    "type": "string",
    "enum": [
        "AcceptedSettlementCompleted",
        "AcceptedSettlementInProcess",
        "Pending",
        "Rejected"
    ]
}
              

OBWriteDataDomestic2

                    {
    "type": "object",
    "properties": {
        "ConsentId": {
            "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
        },
        "Initiation": {
            "$ref": "#\/definitions\/OBDomestic2"
        }
    },
    "required": [
        "ConsentId",
        "Initiation"
    ],
    "additionalProperties": false
}
              

OBDomestic2

                    {
    "type": "object",
    "properties": {
        "InstructionIdentification": {
            "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.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "EndToEndIdentification": {
            "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.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "LocalInstrument": {
            "$ref": "#\/definitions\/OBExternalLocalInstrument1Code"
        },
        "InstructedAmount": {
            "type": "object",
            "properties": {
                "Amount": {
                    "$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
                },
                "Currency": {
                    "type": "string",
                    "pattern": "^[A-Z]{3,3}$"
                }
            },
            "required": [
                "Amount",
                "Currency"
            ],
            "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."
        },
        "DebtorAccount": {
            "$ref": "#\/definitions\/OBCashAccountDebtor4"
        },
        "CreditorAccount": {
            "$ref": "#\/definitions\/OBCashAccountCreditor3"
        },
        "CreditorPostalAddress": {
            "$ref": "#\/definitions\/OBPostalAddress6"
        },
        "RemittanceInformation": {
            "$ref": "#\/definitions\/OBRemittanceInformation1"
        },
        "SupplementaryData": {
            "$ref": "#\/definitions\/OBSupplementaryData1"
        }
    },
    "required": [
        "InstructionIdentification",
        "EndToEndIdentification",
        "InstructedAmount",
        "CreditorAccount"
    ],
    "additionalProperties": false
}
              

OBWriteDataDomesticResponse2

                    {
    "type": "object",
    "properties": {
        "DomesticPaymentId": {
            "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "ConsentId": {
            "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
        },
        "CreationDateTime": {
            "description": "Date and time at which the message was created.\nAll 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"
        },
        "Status": {
            "$ref": "#\/definitions\/OBTransactionIndividualStatus1Code"
        },
        "StatusUpdateDateTime": {
            "description": "Date and time at which the resource status was updated.\nAll 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"
        },
        "ExpectedExecutionDateTime": {
            "description": "Expected execution date and time for the payment resource.\nAll 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"
        },
        "ExpectedSettlementDateTime": {
            "description": "Expected settlement date and time for the payment resource.\nAll 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"
        },
        "Charges": {
            "items": {
                "$ref": "#\/definitions\/OBCharge2"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a charge for the payment initiation."
        },
        "Initiation": {
            "$ref": "#\/definitions\/OBDomestic2"
        },
        "MultiAuthorisation": {
            "$ref": "#\/definitions\/OBMultiAuthorisation1"
        }
    },
    "required": [
        "DomesticPaymentId",
        "ConsentId",
        "CreationDateTime",
        "Status",
        "StatusUpdateDateTime",
        "Initiation"
    ],
    "additionalProperties": false
}
              

OBWriteDataDomesticScheduled2

                    {
    "type": "object",
    "properties": {
        "ConsentId": {
            "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
        },
        "Initiation": {
            "$ref": "#\/definitions\/OBDomesticScheduled2"
        }
    },
    "required": [
        "ConsentId",
        "Initiation"
    ],
    "additionalProperties": false
}
              

OBWriteDataDomesticScheduledResponse2

                    {
    "type": "object",
    "properties": {
        "DomesticScheduledPaymentId": {
            "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "ConsentId": {
            "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
        },
        "CreationDateTime": {
            "description": "Date and time at which the message was created.\nAll 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"
        },
        "Status": {
            "$ref": "#\/definitions\/OBExternalStatus1Code"
        },
        "StatusUpdateDateTime": {
            "description": "Date and time at which the resource status was updated.\nAll 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"
        },
        "ExpectedExecutionDateTime": {
            "description": "Expected execution date and time for the payment resource.\nAll 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"
        },
        "ExpectedSettlementDateTime": {
            "description": "Expected settlement date and time for the payment resource.\nAll 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"
        },
        "Charges": {
            "items": {
                "$ref": "#\/definitions\/OBCharge2"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a charge for the payment initiation."
        },
        "Initiation": {
            "$ref": "#\/definitions\/OBDomesticScheduled2"
        },
        "MultiAuthorisation": {
            "$ref": "#\/definitions\/OBMultiAuthorisation1"
        }
    },
    "required": [
        "DomesticScheduledPaymentId",
        "ConsentId",
        "CreationDateTime",
        "Status",
        "StatusUpdateDateTime",
        "Initiation"
    ],
    "additionalProperties": false
}
              

OBWriteDataDomesticStandingOrder2

                    {
    "type": "object",
    "properties": {
        "ConsentId": {
            "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
        },
        "Initiation": {
            "$ref": "#\/definitions\/OBDomesticStandingOrder2"
        }
    },
    "required": [
        "ConsentId",
        "Initiation"
    ],
    "additionalProperties": false
}
              

OBWriteDataDomesticStandingOrderResponse2

                    {
    "type": "object",
    "properties": {
        "DomesticStandingOrderId": {
            "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "ConsentId": {
            "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
        },
        "CreationDateTime": {
            "description": "Date and time at which the resource was created.\nAll 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"
        },
        "Status": {
            "$ref": "#\/definitions\/OBExternalStatus1Code"
        },
        "StatusUpdateDateTime": {
            "description": "Date and time at which the resource status was updated.\nAll 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"
        },
        "Charges": {
            "items": {
                "$ref": "#\/definitions\/OBCharge2"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a charge for the payment initiation."
        },
        "Initiation": {
            "$ref": "#\/definitions\/OBDomesticStandingOrder2"
        },
        "MultiAuthorisation": {
            "$ref": "#\/definitions\/OBMultiAuthorisation1"
        }
    },
    "required": [
        "DomesticStandingOrderId",
        "ConsentId",
        "CreationDateTime",
        "Status",
        "StatusUpdateDateTime",
        "Initiation"
    ],
    "additionalProperties": false
}
              

OBWriteDomestic2

                    {
    "type": "object",
    "properties": {
        "Data": {
            "$ref": "#\/definitions\/OBWriteDataDomestic2"
        },
        "Risk": {
            "$ref": "#\/definitions\/OBRisk1"
        }
    },
    "required": [
        "Data",
        "Risk"
    ],
    "additionalProperties": false
}
              

OBWriteDomesticResponse2

                    {
    "type": "object",
    "properties": {
        "Data": {
            "$ref": "#\/definitions\/OBWriteDataDomesticResponse2"
        },
        "Links": {
            "$ref": "#\/definitions\/Links"
        },
        "Meta": {
            "$ref": "#\/definitions\/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBWriteDomesticScheduled2

                    {
    "type": "object",
    "properties": {
        "Data": {
            "$ref": "#\/definitions\/OBWriteDataDomesticScheduled2"
        },
        "Risk": {
            "$ref": "#\/definitions\/OBRisk1"
        }
    },
    "required": [
        "Data",
        "Risk"
    ],
    "additionalProperties": false
}
              

OBWriteDomesticScheduledResponse2

                    {
    "type": "object",
    "properties": {
        "Data": {
            "$ref": "#\/definitions\/OBWriteDataDomesticScheduledResponse2"
        },
        "Links": {
            "$ref": "#\/definitions\/Links"
        },
        "Meta": {
            "$ref": "#\/definitions\/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBWriteDomesticStandingOrder2

                    {
    "type": "object",
    "properties": {
        "Data": {
            "$ref": "#\/definitions\/OBWriteDataDomesticStandingOrder2"
        },
        "Risk": {
            "$ref": "#\/definitions\/OBRisk1"
        }
    },
    "required": [
        "Data",
        "Risk"
    ],
    "additionalProperties": false
}
              

OBWriteDomesticStandingOrderResponse2

                    {
    "type": "object",
    "properties": {
        "Data": {
            "$ref": "#\/definitions\/OBWriteDataDomesticStandingOrderResponse2"
        },
        "Links": {
            "$ref": "#\/definitions\/Links"
        },
        "Meta": {
            "$ref": "#\/definitions\/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBExternalLocalInstrument1Code

                    {
    "type": "string",
    "example": [
        "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"
    ],
    "minLength": 1,
    "maxLength": 50
}
              

OBCharge2

                    {
    "type": "object",
    "properties": {
        "ChargeBearer": {
            "$ref": "#\/definitions\/OBChargeBearerType1Code"
        },
        "Type": {
            "$ref": "#\/definitions\/OBExternalPaymentChargeType1Code"
        },
        "Amount": {
            "type": "object",
            "properties": {
                "Amount": {
                    "$ref": "#\/definitions\/OBActiveCurrencyAndAmount_SimpleType"
                },
                "Currency": {
                    "type": "string",
                    "pattern": "^[A-Z]{3,3}$"
                }
            },
            "required": [
                "Amount",
                "Currency"
            ],
            "additionalProperties": false,
            "description": "Amount of money associated with the charge type."
        }
    },
    "required": [
        "ChargeBearer",
        "Type",
        "Amount"
    ],
    "additionalProperties": false
}
              

OBExternalPaymentChargeType1Code

                    {
    "type": "string",
    "example": [
        "UK.OBIE.CHAPSOut",
        "UK.OBIE.BalanceTransferOut",
        "UK.OBIE.MoneyTransferOut"
    ],
    "minLength": 1,
    "maxLength": 40
}
              

OBError1

                    {
    "type": "object",
    "properties": {
        "ErrorCode": {
            "description": "Low level textual error code, e.g., UK.OBIE.Field.Missing",
            "type": "string",
            "minLength": 1,
            "maxLength": 128
        },
        "Message": {
            "description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE 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",
        "Message"
    ],
    "additionalProperties": false,
    "minProperties": 1
}
              

OBErrorResponse1

                    {
    "type": "object",
    "properties": {
        "Code": {
            "description": "High level textual error code, to help categorize the errors.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "Id": {
            "description": "A unique reference for the error instance, for audit purposes, in case of unknown\/unclassified errors.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "Message": {
            "description": "Brief Error message, e.g., 'There is something wrong with the request parameters provided'",
            "type": "string",
            "minLength": 1,
            "maxLength": 500
        },
        "Errors": {
            "items": {
                "$ref": "#\/definitions\/OBError1"
            },
            "type": "array",
            "minItems": 1
        }
    },
    "required": [
        "Code",
        "Message",
        "Errors"
    ],
    "additionalProperties": false
}
              

ISODateTime

                    {
    "type": "string",
    "format": "date-time"
}
              

Links

                    {
    "type": "object",
    "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"
        }
    },
    "additionalProperties": false,
    "required": [
        "Self"
    ]
}
              

Meta

                    {
    "title": "MetaData",
    "type": "object",
    "properties": {
        "TotalPages": {
            "type": "integer",
            "format": "int32"
        },
        "FirstAvailableDateTime": {
            "$ref": "#\/definitions\/ISODateTime"
        },
        "LastAvailableDateTime": {
            "$ref": "#\/definitions\/ISODateTime"
        }
    },
    "additionalProperties": false
}