OBWriteDataInternationalResponse2

{
    "type": "object",
    "properties": {
        "InternationalPaymentId": {
            "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the international 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"
        },
        "Refund": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "Account"
            ],
            "properties": {
                "Agent": {
                    "type": "object",
                    "additionalProperties": false,
                    "description": "Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution.",
                    "properties": {
                        "SchemeName": {
                            "$ref": "#/definitions/OBExternalFinancialInstitutionIdentification4Code"
                        },
                        "Identification": {
                            "$ref": "#/definitions/Identification_1"
                        }
                    }
                },
                "Account": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                        "SchemeName",
                        "Identification",
                        "Name"
                    ],
                    "description": "Provides the details to identify an account.",
                    "properties": {
                        "SchemeName": {
                            "$ref": "#/definitions/OBExternalAccountIdentification4Code"
                        },
                        "Identification": {
                            "$ref": "#/definitions/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": "#/definitions/SecondaryIdentification"
                        }
                    }
                }
            }
        },
        "Charges": {
            "items": {
                "$ref": "#/definitions/OBCharge2"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a charge for the payment initiation."
        },
        "ExchangeRateInformation": {
            "$ref": "#/definitions/OBExchangeRate2"
        },
        "Initiation": {
            "$ref": "#/definitions/OBInternational2"
        },
        "MultiAuthorisation": {
            "$ref": "#/definitions/OBMultiAuthorisation1"
        },
        "Debtor": {
            "$ref": "#/definitions/OBDebtorIdentification1"
        }
    },
    "required": [
        "InternationalPaymentId",
        "ConsentId",
        "CreationDateTime",
        "Status",
        "StatusUpdateDateTime",
        "Initiation"
    ],
    "additionalProperties": false
}
              

Identification_1

{
    "type": "string",
    "minLength": 1,
    "maxLength": 35
}
              

Identification_0

{
    "type": "string",
    "minLength": 1,
    "maxLength": 256
}
              

SecondaryIdentification

{
    "type": "string",
    "minLength": 1,
    "maxLength": 34
}
              

Name

{
    "type": "string",
    "minLength": 1,
    "maxLength": 140
}
              

OBTransactionIndividualStatus1Code

{
    "type": "string",
    "enum": [
        "AcceptedSettlementCompleted",
        "AcceptedSettlementInProcess",
        "Pending",
        "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
}
              

OBDebtorIdentification12

{
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "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. Note, the account name is not the product name or the nickname of the account.",
            "minLength": 0,
            "maxLength": 350
        }
    }
}
              

OBExternalStatus2Code

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

OBWriteInternational2

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

OBWriteDataInternational2

{
    "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/OBInternational2"
        }
    },
    "required": [
        "ConsentId",
        "Initiation"
    ],
    "additionalProperties": false
}
              

OBActiveCurrencyAndAmount_SimpleType

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

OBAddressTypeCode

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

OBAuthorisation1

{
    "type": "object",
    "properties": {
        "AuthorisationType": {
            "$ref": "#/definitions/OBExternalAuthorisation1Code"
        },
        "CompletionDateTime": {
            "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": [
        "AuthorisationType"
    ],
    "additionalProperties": false
}
              

OBChargeBearerType1Code

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

OBExchangeRate1

{
    "type": "object",
    "properties": {
        "UnitCurrency": {
            "description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
            "type": "string",
            "pattern": "^[A-Z]{3,3}$"
        },
        "ExchangeRate": {
            "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.",
            "type": "number"
        },
        "RateType": {
            "$ref": "#/definitions/OBExchangeRateType2Code"
        },
        "ContractIdentification": {
            "description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
        }
    },
    "required": [
        "UnitCurrency",
        "RateType"
    ],
    "additionalProperties": false
}
              

OBExchangeRate2

{
    "type": "object",
    "properties": {
        "UnitCurrency": {
            "description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.",
            "type": "string",
            "pattern": "^[A-Z]{3,3}$"
        },
        "ExchangeRate": {
            "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.",
            "type": "number"
        },
        "RateType": {
            "$ref": "#/definitions/OBExchangeRateType2Code"
        },
        "ContractIdentification": {
            "description": "Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
        },
        "ExpirationDateTime": {
            "description": "Specified date and time the exchange rate agreement will expire.\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": [
        "UnitCurrency",
        "ExchangeRate",
        "RateType"
    ],
    "additionalProperties": false
}
              

OBExchangeRateType2Code

{
    "type": "string",
    "enum": [
        "Actual",
        "Agreed",
        "Indicative"
    ]
}
              

OBExternalAuthorisation1Code

{
    "type": "string",
    "enum": [
        "Any",
        "Single"
    ]
}
              

OBExternalConsentStatus1Code

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

OBExternalPaymentContext1Code

{
    "type": "string",
    "enum": [
        "BillPayment",
        "EcommerceGoods",
        "EcommerceServices",
        "Other",
        "PartyToParty",
        "BillingGoodsAndServicesInAdvance",
        "BillingGoodsAndServicesInArrears",
        "PispPayee",
        "EcommerceMerchantInitiatedPayment",
        "FaceToFacePointOfSale",
        "TransferToSelf",
        "TransferToThirdParty"
    ]
}
              

OBInternational2

{
    "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
        },
        "ExtendedPurpose": {
            "description": "Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes.",
            "type": "string",
            "minLength": 1,
            "maxLength": 140
        },
        "DestinationCountryCode": {
            "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).",
            "type": "string",
            "pattern": "^[A-Z]{2,2}$"
        },
        "LocalInstrument": {
            "$ref": "#/definitions/OBExternalLocalInstrument1Code"
        },
        "InstructionPriority": {
            "$ref": "#/definitions/OBPriority2Code"
        },
        "Purpose": {
            "$ref": "#/definitions/OBExternalPurpose1Code1"
        },
        "ChargeBearer": {
            "$ref": "#/definitions/OBChargeBearerType1Code"
        },
        "CurrencyOfTransfer": {
            "description": "Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.",
            "type": "string",
            "pattern": "^[A-Z]{3,3}$"
        },
        "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."
        },
        "ExchangeRateInformation": {
            "$ref": "#/definitions/OBExchangeRate1"
        },
        "DebtorAccount": {
            "$ref": "#/definitions/OBCashAccountDebtor4"
        },
        "Creditor": {
            "$ref": "#/definitions/OBPartyIdentification43"
        },
        "CreditorAgent": {
            "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification6"
        },
        "CreditorAccount": {
            "$ref": "#/definitions/OBCashAccountCreditor3"
        },
        "RemittanceInformation": {
            "$ref": "#/definitions/OBRemittanceInformation1"
        },
        "SupplementaryData": {
            "$ref": "#/definitions/OBSupplementaryData1"
        }
    },
    "required": [
        "InstructionIdentification",
        "EndToEndIdentification",
        "CurrencyOfTransfer",
        "InstructedAmount",
        "CreditorAccount"
    ],
    "additionalProperties": false
}
              

OBPartyIdentification43

{
    "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": 350
        },
        "PostalAddress": {
            "$ref": "#/definitions/OBPostalAddress6"
        }
    },
    "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
}
              

OBPriority2Code

{
    "type": "string",
    "enum": [
        "Normal",
        "Urgent"
    ]
}
              

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",
    "required": [
        "PaymentContextCode"
    ],
    "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
        },
        "BeneficiaryPrepopulatedIndicator": {
            "type": "boolean",
            "description": "Indicates if PISP has immutably prepopulated payment details in for the PSU."
        },
        "ContractPresentInidicator": {
            "type": "boolean",
            "description": "Indicates if Payee has a contractual relationship with the PISP."
        },
        "PaymentPurposeCode": {
            "type": "string",
            "minLength": 3,
            "maxLength": 4,
            "description": "Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List"
        },
        "BeneficiaryAccountType": {
            "$ref": "#/definitions/OBExternalExtendedAccountType1Code"
        },
        "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": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 35,
                    "description": "Identifies a subdivision of a country, for instance state, region, county."
                },
                "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
}
              

OBWriteDataInternationalConsent2

{
    "type": "object",
    "properties": {
        "ReadRefundAccount": {
            "description": "Specifies to share the refund account details with PISP",
            "type": "string",
            "enum": [
                "No",
                "Yes"
            ]
        },
        "Initiation": {
            "$ref": "#/definitions/OBInternational2"
        },
        "Authorisation": {
            "$ref": "#/definitions/OBAuthorisation1"
        },
        "SCASupportData": {
            "$ref": "#/definitions/OBSCASupportData1"
        }
    },
    "required": [
        "Initiation"
    ],
    "additionalProperties": false
}
              

OBWriteDataInternationalConsentResponse2

{
    "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
        },
        "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/OBExternalConsentStatus1Code"
        },
        "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"
        },
        "CutOffDateTime": {
            "description": "Specified cut-off date and time for the payment consent.\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."
        },
        "ReadRefundAccount": {
            "description": "Specifies to share the refund account details with PISP",
            "type": "string",
            "enum": [
                "No",
                "Yes"
            ]
        },
        "ExchangeRateInformation": {
            "$ref": "#/definitions/OBExchangeRate2"
        },
        "Initiation": {
            "$ref": "#/definitions/OBInternational2"
        },
        "Authorisation": {
            "$ref": "#/definitions/OBAuthorisation1"
        },
        "SCASupportData": {
            "$ref": "#/definitions/OBSCASupportData1"
        },
        "Debtor": {
            "$ref": "#/definitions/OBDebtorIdentification1"
        }
    },
    "required": [
        "ConsentId",
        "CreationDateTime",
        "Status",
        "StatusUpdateDateTime",
        "Initiation"
    ],
    "additionalProperties": false
}
              

OBWriteInternationalConsent2

{
    "type": "object",
    "properties": {
        "Data": {
            "$ref": "#/definitions/OBWriteDataInternationalConsent2"
        },
        "Risk": {
            "$ref": "#/definitions/OBRisk1"
        }
    },
    "required": [
        "Data",
        "Risk"
    ],
    "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": 350
        },
        "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": 350
        },
        "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
}
              

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
}
              

OBExternalPurpose1Code1

{
    "type": "string",
    "minLength": 1,
    "maxLength": 4
}
              

OBBranchAndFinancialInstitutionIdentification6

{
    "type": "object",
    "properties": {
        "SchemeName": {
            "$ref": "#/definitions/OBExternalFinancialInstitutionIdentification4Code"
        },
        "Identification": {
            "description": "Unique and unambiguous identification of the servicing institution.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "Name": {
            "description": "Name by which an agent is known and which is usually used to identify that agent.",
            "type": "string",
            "minLength": 1,
            "maxLength": 140
        },
        "PostalAddress": {
            "$ref": "#/definitions/OBPostalAddress6"
        }
    },
    "additionalProperties": false
}
              

OBExternalFinancialInstitutionIdentification4Code

{
    "type": "string",
    "example": [
        "UK.OBIE.BICFI"
    ],
    "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
}
              

OBExternalExtendedAccountType1Code

{
    "type": "string",
    "enum": [
        "Business",
        "BusinessSavingsAccount",
        "Charity",
        "Collection",
        "Corporate",
        "Ewallet",
        "Government",
        "Investment",
        "ISA",
        "JointPersonal",
        "Pension",
        "Personal",
        "PersonalSavingsAccount",
        "Premier",
        "Wealth"
    ]
}
              

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
}
              

OBWriteDataFundsConfirmationResponse1

{
    "type": "object",
    "properties": {
        "FundsAvailableResult": {
            "$ref": "#/definitions/OBFundsAvailableResult1"
        },
        "SupplementaryData": {
            "$ref": "#/definitions/OBSupplementaryData1"
        }
    },
    "additionalProperties": false
}
              

OBFundsAvailableResult1

{
    "type": "object",
    "properties": {
        "FundsAvailableDateTime": {
            "description": "Date and time at which the funds availability check was generated.\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"
        },
        "FundsAvailable": {
            "description": "Flag to indicate the availability of funds given the Amount in the consent request.",
            "type": "boolean"
        }
    },
    "required": [
        "FundsAvailableDateTime",
        "FundsAvailable"
    ],
    "additionalProperties": false
}
              

OBSCASupportData1

{
    "type": "object",
    "properties": {
        "RequestedSCAExemptionType": {
            "type": "string",
            "description": "This field allows a PISP to request specific SCA Exemption for a Payment Initiation",
            "enum": [
                "BillPayment",
                "ContactlessTravel",
                "EcommerceGoods",
                "EcommerceServices",
                "Kiosk",
                "Parking",
                "PartyToParty"
            ]
        },
        "AppliedAuthenticationApproach": {
            "type": "string",
            "maxLength": 40,
            "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",
            "enum": [
                "CA",
                "SCA"
            ]
        },
        "ReferencePaymentOrderId": {
            "type": "string",
            "maxLength": 40,
            "minLength": 1,
            "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  "
        }
    }
}
              

OBDebtorIdentification1

{
    "type": "object",
    "properties": {
        "SchemeName": {
            "type": "string",
            "description": "^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBExternalAccountIdentification4Code"
        },
        "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"
        }
    }
}