AccountId

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

OBAccount6

{
    "type": "object",
    "properties": {
        "AccountId": {
            "$ref": "#/definitions/AccountId"
        },
        "Currency": {
            "description": "Identification of the currency in which the account is held.\nUsage: Currency should only be used in case one and the same account number covers several currencies\nand the initiating party needs to identify which currency needs to be used for settlement on the account.",
            "type": "string",
            "pattern": "^[A-Z]{3,3}$"
        },
        "AccountType": {
            "$ref": "#/definitions/OBExternalAccountType1Code"
        },
        "AccountSubType": {
            "$ref": "#/definitions/OBExternalAccountSubType1Code"
        },
        "Description": {
            "description": "Specifies the description of the account type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "Nickname": {
            "description": "The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account.",
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "OpeningDate": {
            "description": "Date on which the account and related basic services are effectively operational for the account owner.All dates in the JSON payloads are represented in ISO 8601 date-time format. \n All date-time fields in responses must include the timezone. An example is below:\n 2017-04-05T10:43:07+00:00",
            "format": "date-time",
            "type": "string"
        },
        "MaturityDate": {
            "description": "Maturity date of the account.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"
        },
        "SwitchStatus": {
            "description": "Specifies the switch status for the account, in a coded form.",
            "type": "string",
            "x-namespaced-enum": [
                "UK.CASS.NotSwitced",
                "UK.CASS.SwitchCompleted"
            ]
        },
        "Account": {
            "items": {
                "$ref": "#/definitions/OBCashAccount5"
            },
            "type": "array",
            "description": "Provides the details to identify an account."
        },
        "Servicer": {
            "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5"
        }
    },
    "required": [
        "AccountId"
    ],
    "additionalProperties": false
}
              

OBActiveCurrencyAndAmount_SimpleType

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

OBActiveOrHistoricCurrencyAndAmount

{
    "type": "object",
    "properties": {
        "Amount": {
            "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType"
        },
        "Currency": {
            "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}$"
        }
    },
    "required": [
        "Amount",
        "Currency"
    ],
    "additionalProperties": false
}
              

OBAddressTypeCode

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

OBBalanceType1Code

{
    "type": "string",
    "enum": [
        "ClosingAvailable",
        "ClosingBooked",
        "ClosingCleared",
        "Expected",
        "ForwardAvailable",
        "Information",
        "InterimAvailable",
        "InterimBooked",
        "InterimCleared",
        "OpeningAvailable",
        "OpeningBooked",
        "OpeningCleared",
        "PreviouslyClosedBooked"
    ]
}
              

OBBankTransactionCodeStructure1

{
    "type": "object",
    "properties": {
        "Code": {
            "description": "Specifies the family within a domain.",
            "type": "string"
        },
        "SubCode": {
            "description": "Specifies the sub-product family within a specific family.",
            "type": "string"
        }
    },
    "required": [
        "Code",
        "SubCode"
    ],
    "additionalProperties": false
}
              

OBBeneficiary5

{
    "type": "object",
    "properties": {
        "AccountId": {
            "$ref": "#/definitions/AccountId"
        },
        "BeneficiaryId": {
            "description": "A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "BeneficiaryType": {
            "description": "Specifies the Beneficiary Type.",
            "type": "string",
            "enum": [
                "Trusted",
                "Ordinary"
            ]
        },
        "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
        },
        "SupplementaryData": {
            "type": "object",
            "properties": {
                "BenificiaryPostalAddress": {
                    "type": "object",
                    "properties": {
                        "Country": {
                            "type": "string"
                        },
                        "AddressLine": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            }
                        }
                    }
                }
            },
            "description": "Beneficiary supplementary data"
        },
        "CreditorAgent": {
            "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification6"
        },
        "CreditorAccount": {
            "$ref": "#/definitions/OBCashAccount5"
        }
    },
    "additionalProperties": false
}
              

OBCashBalance1

{
    "type": "object",
    "properties": {
        "AccountId": {
            "$ref": "#/definitions/AccountId"
        },
        "CreditDebitIndicator": {
            "type": "string",
            "enum": [
                "Credit",
                "Debit"
            ],
            "description": "Indicates whether the balance is a credit or a debit balance.\nUsage: A zero balance is considered to be a credit balance."
        },
        "Type": {
            "$ref": "#/definitions/OBBalanceType1Code"
        },
        "DateTime": {
            "description": "Indicates the date (and time) of the balance.\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"
        },
        "Amount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        },
        "CreditLine": {
            "items": {
                "$ref": "#/definitions/OBCreditLine1"
            },
            "type": "array",
            "description": "Set of elements used to provide details on the credit line."
        }
    },
    "required": [
        "AccountId",
        "CreditDebitIndicator",
        "Type",
        "DateTime",
        "Amount"
    ],
    "additionalProperties": false,
    "minProperties": 1
}
              

OBCreditLine1

{
    "type": "object",
    "properties": {
        "Included": {
            "description": "Indicates whether or not the credit line is included in the balance of the account.\nUsage: If not present, credit line is not included in the balance amount of the account.",
            "type": "boolean"
        },
        "Type": {
            "$ref": "#/definitions/OBExternalLimitType1Code"
        },
        "Amount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        }
    },
    "required": [
        "Included"
    ],
    "additionalProperties": false
}
              

OBCurrencyExchange5

{
    "type": "object",
    "properties": {
        "SourceCurrency": {
            "description": "Currency from which an amount is to be converted in a currency conversion.",
            "type": "string",
            "pattern": "^[A-Z]{3,3}$"
        },
        "TargetCurrency": {
            "description": "Currency from which an amount is to be converted in a currency conversion.",
            "type": "string",
            "pattern": "^[A-Z]{3,3}$"
        },
        "UnitCurrency": {
            "description": "Currency from which an amount is to be converted in a currency conversion.",
            "type": "string",
            "pattern": "^[A-Z]{3,3}$"
        },
        "ExchangeRate": {
            "description": "Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\nUsage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency).",
            "type": "number"
        },
        "ContractIdentification": {
            "description": "Unique identification to unambiguously identify the foreign exchange contract.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "QuotationDate": {
            "description": "Date and time at which an exchange rate is quoted.\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": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        }
    },
    "required": [
        "SourceCurrency",
        "ExchangeRate"
    ],
    "additionalProperties": false
}
              

OBDirectDebit1

{
    "type": "object",
    "properties": {
        "AccountId": {
            "$ref": "#/definitions/AccountId"
        },
        "DirectDebitId": {
            "description": "A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "MandateIdentification": {
            "description": "Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "DirectDebitStatusCode": {
            "$ref": "#/definitions/OBExternalDirectDebitStatus1Code"
        },
        "Name": {
            "description": "Name of Service User.",
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "PreviousPaymentDateTime": {
            "description": "Date of most recent direct debit collection.\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"
        },
        "Frequency": {
            "description": "Regularity with which direct debit instructions are to be created and processed.",
            "type": "string",
            "x-namespaced-enum": [
                "UK.OBIE.Annual",
                "UK.OBIE.Daily",
                "UK.OBIE.Fortnightly",
                "UK.OBIE.HalfYearly",
                "UK.OBIE.Monthly",
                "UK.OBIE.NotKnown",
                "UK.OBIE.Quarterly",
                "UK.OBIE.Weekly"
            ]
        },
        "PreviousPaymentAmount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        }
    },
    "required": [
        "AccountId",
        "MandateIdentification",
        "Name"
    ],
    "additionalProperties": false
}
              

OBEntryStatus1Code

{
    "type": "string",
    "enum": [
        "Booked",
        "Pending"
    ]
}
              

OBExternalAccountSubType1Code

{
    "type": "string",
    "enum": [
        "ChargeCard",
        "CreditCard",
        "CurrentAccount",
        "EMoney",
        "Loan",
        "Mortgage",
        "PrePaidCard",
        "Savings"
    ]
}
              

OBExternalAccountType1Code

{
    "type": "string",
    "enum": [
        "Business",
        "Personal"
    ]
}
              

OBExternalCardAuthorisationType1Code

{
    "type": "string",
    "enum": [
        "ConsumerDevice",
        "Contactless",
        "None",
        "PIN"
    ]
}
              

OBExternalCardSchemeType1Code

{
    "type": "string",
    "enum": [
        "AmericanExpress",
        "Diners",
        "Discover",
        "MasterCard",
        "VISA"
    ]
}
              

OBExternalDirectDebitStatus1Code

{
    "type": "string",
    "enum": [
        "Active",
        "Inactive"
    ]
}
              

OBExternalLimitType1Code

{
    "type": "string",
    "enum": [
        "Available",
        "Credit",
        "Emergency",
        "Pre-Agreed",
        "Temporary"
    ]
}
              

OBExternalPermissions1Code

{
    "type": "string",
    "enum": [
        "ReadAccountsBasic",
        "ReadAccountsDetail",
        "ReadBalances",
        "ReadBeneficiariesBasic",
        "ReadBeneficiariesDetail",
        "ReadDirectDebits",
        "ReadOffers",
        "ReadPAN",
        "ReadParty",
        "ReadPartyPSU",
        "ReadProducts",
        "ReadScheduledPaymentsBasic",
        "ReadScheduledPaymentsDetail",
        "ReadStandingOrdersBasic",
        "ReadStandingOrdersDetail",
        "ReadStatementsBasic",
        "ReadStatementsDetail",
        "ReadTransactionsBasic",
        "ReadTransactionsCredits",
        "ReadTransactionsDebits",
        "ReadTransactionsDetail"
    ]
}
              

OBExternalRequestStatus1Code

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

OBExternalScheduleType1Code

{
    "type": "string",
    "enum": [
        "Arrival",
        "Execution"
    ]
}
              

OBExternalStandingOrderStatus1Code

{
    "type": "string",
    "enum": [
        "Active",
        "Inactive"
    ]
}
              

OBMerchantDetails1

{
    "type": "object",
    "properties": {
        "MerchantName": {
            "description": "Name by which the merchant is known.",
            "type": "string",
            "minLength": 1,
            "maxLength": 350
        },
        "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
        }
    },
    "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
}
              

OBReadAccount6

{
    "type": "object",
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "Account": {
                    "items": {
                        "$ref": "#/definitions/OBAccount6"
                    },
                    "type": "array",
                    "description": "Unambiguous identification of the account to which credit and debit entries are made."
                }
            },
            "additionalProperties": false
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBReadBalance1

{
    "type": "object",
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "Balance": {
                    "items": {
                        "$ref": "#/definitions/OBCashBalance1"
                    },
                    "type": "array",
                    "description": "Set of elements used to define the balance details.",
                    "minItems": 1
                }
            },
            "required": [
                "Balance"
            ],
            "additionalProperties": false
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBReadBeneficiary5

{
    "type": "object",
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "Beneficiary": {
                    "items": {
                        "$ref": "#/definitions/OBBeneficiary5"
                    },
                    "type": "array"
                }
            },
            "additionalProperties": false
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBReadConsent1

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

OBReadConsentResponse1

{
    "type": "object",
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "ConsentId": {
                    "description": "Unique identification as assigned to identify the account access 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/OBExternalRequestStatus1Code"
                },
                "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"
                },
                "Permissions": {
                    "items": {
                        "$ref": "#/definitions/OBExternalPermissions1Code"
                    },
                    "type": "array",
                    "description": "Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.",
                    "minItems": 1
                },
                "ExpirationDateTime": {
                    "description": "Specified date and time the permissions will expire.\nIf this is not populated, the permissions will be open ended.\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"
                },
                "TransactionFromDateTime": {
                    "description": "Specified start date and time for the transaction query period.\nIf this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.\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"
                },
                "TransactionToDateTime": {
                    "description": "Specified end date and time for the transaction query period.\nIf this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.\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": [
                "ConsentId",
                "CreationDateTime",
                "Status",
                "StatusUpdateDateTime",
                "Permissions"
            ],
            "additionalProperties": false
        },
        "Risk": {
            "$ref": "#/definitions/OBRisk2"
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "required": [
        "Data",
        "Risk",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBReadData1

{
    "type": "object",
    "properties": {
        "Permissions": {
            "items": {
                "$ref": "#/definitions/OBExternalPermissions1Code"
            },
            "type": "array",
            "description": "Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.",
            "minItems": 1
        },
        "ExpirationDateTime": {
            "description": "Specified date and time the permissions will expire.\nIf this is not populated, the permissions will be open ended.\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"
        },
        "TransactionFromDateTime": {
            "description": "Specified start date and time for the transaction query period.\nIf this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.\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"
        },
        "TransactionToDateTime": {
            "description": "Specified end date and time for the transaction query period.\nIf this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.\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": [
        "Permissions"
    ],
    "additionalProperties": false
}
              

OBReadDirectDebit1

{
    "type": "object",
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "DirectDebit": {
                    "items": {
                        "$ref": "#/definitions/OBDirectDebit1"
                    },
                    "type": "array",
                    "description": "Account to or from which a cash entry is made."
                }
            },
            "additionalProperties": false
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBReadProduct2

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

OBReadScheduledPayment2

{
    "type": "object",
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "ScheduledPayment": {
                    "items": {
                        "$ref": "#/definitions/OBScheduledPayment2"
                    },
                    "type": "array"
                }
            },
            "additionalProperties": false
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBReadStandingOrder4

{
    "type": "object",
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "StandingOrder": {
                    "items": {
                        "$ref": "#/definitions/OBStandingOrder4"
                    },
                    "type": "array"
                }
            },
            "additionalProperties": false
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBReadTransaction6

{
    "type": "object",
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "Transaction": {
                    "items": {
                        "$ref": "#/definitions/OBTransaction6"
                    },
                    "type": "array",
                    "description": "Provides further details on an entry in the report."
                }
            },
            "additionalProperties": false
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBScheduledPayment2

{
    "type": "object",
    "properties": {
        "AccountId": {
            "$ref": "#/definitions/AccountId"
        },
        "ScheduledPaymentId": {
            "description": "A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "ScheduledPaymentDateTime": {
            "description": "The date on which the scheduled payment 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"
        },
        "ScheduledType": {
            "$ref": "#/definitions/OBExternalScheduleType1Code"
        },
        "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
        },
        "DebtorReference": {
            "description": "A reference value provided by the PSU to the PISP while setting up the scheduled payment.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "InstructedAmount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        },
        "CreditorAgent": {
            "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5"
        },
        "CreditorAccount": {
            "$ref": "#/definitions/OBCashAccount5"
        }
    },
    "required": [
        "AccountId",
        "ScheduledPaymentDateTime",
        "ScheduledType",
        "InstructedAmount"
    ],
    "additionalProperties": false
}
              

OBStandingOrder4

{
    "type": "object",
    "properties": {
        "AccountId": {
            "$ref": "#/definitions/AccountId"
        },
        "StandingOrderId": {
            "description": "A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "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
        },
        "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"
        },
        "NextPaymentDateTime": {
            "description": "The date on which the next 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"
        },
        "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"
        },
        "StandingOrderStatusCode": {
            "$ref": "#/definitions/OBExternalStandingOrderStatus1Code"
        },
        "FirstPaymentAmount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        },
        "NextPaymentAmount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        },
        "FinalPaymentAmount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        },
        "SupplementaryData": {
            "$ref": "#/definitions/OBSupplementaryData1"
        },
        "CreditorAgent": {
            "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5"
        },
        "CreditorAccount": {
            "$ref": "#/definitions/OBCashAccount5"
        }
    },
    "required": [
        "AccountId",
        "Frequency"
    ],
    "additionalProperties": false
}
              

OBTransaction6

{
    "type": "object",
    "properties": {
        "AccountId": {
            "$ref": "#/definitions/AccountId"
        },
        "TransactionId": {
            "description": "Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "TransactionReference": {
            "description": "Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context.",
            "type": "string",
            "minLength": 1,
            "maxLength": 210
        },
        "StatementReference": {
            "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 35
            },
            "type": "array",
            "description": "Unique reference for the statement. This reference may be optionally populated if available."
        },
        "CreditDebitIndicator": {
            "type": "string",
            "enum": [
                "Credit",
                "Debit"
            ],
            "description": "Indicates whether the transaction is a credit or a debit entry."
        },
        "Status": {
            "$ref": "#/definitions/OBEntryStatus1Code"
        },
        "TransactionMutability": {
            "description": "Specifies the Mutability of the Transaction record.",
            "type": "string",
            "enum": [
                "Mutable",
                "Immutable"
            ]
        },
        "BookingDateTime": {
            "description": "Date and time when a transaction entry is posted to an account on the account servicer's books.\nUsage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking 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"
        },
        "ValueDateTime": {
            "description": "Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry.\nUsage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date.\nFor transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.\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"
        },
        "AddressLine": {
            "description": "Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.",
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "Amount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        },
        "ChargeAmount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        },
        "CurrencyExchange": {
            "$ref": "#/definitions/OBCurrencyExchange5"
        },
        "BankTransactionCode": {
            "$ref": "#/definitions/OBBankTransactionCodeStructure1"
        },
        "ProprietaryBankTransactionCode": {
            "description": "Set of elements to fully identify a proprietary bank transaction code.",
            "type": "object",
            "properties": {
                "Code": {
                    "description": "Proprietary bank transaction code to identify the underlying transaction.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 35
                },
                "Issuer": {
                    "description": "Identification of the issuer of the proprietary bank transaction code.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 35
                }
            },
            "required": [
                "Code"
            ],
            "additionalProperties": false
        },
        "CardInstrument": {
            "$ref": "#/definitions/OBTransactionCardInstrument1"
        },
        "SupplementaryData": {
            "$ref": "#/definitions/OBSupplementaryData1"
        },
        "TransactionInformation": {
            "$ref": "#/definitions/TransactionInformation"
        },
        "Balance": {
            "$ref": "#/definitions/OBTransactionCashBalance"
        },
        "MerchantDetails": {
            "$ref": "#/definitions/OBMerchantDetails1"
        },
        "CreditorAgent": {
            "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification6"
        },
        "CreditorAccount": {
            "$ref": "#/definitions/OBCashAccount6"
        },
        "DebtorAgent": {
            "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification6"
        },
        "DebtorAccount": {
            "$ref": "#/definitions/OBCashAccount6"
        }
    },
    "required": [
        "AccountId",
        "CreditDebitIndicator",
        "Status",
        "BookingDateTime",
        "Amount"
    ],
    "additionalProperties": false
}
              

OBTransactionCardInstrument1

{
    "type": "object",
    "properties": {
        "CardSchemeName": {
            "$ref": "#/definitions/OBExternalCardSchemeType1Code"
        },
        "AuthorisationType": {
            "$ref": "#/definitions/OBExternalCardAuthorisationType1Code"
        },
        "Name": {
            "description": "Name of the cardholder using the card instrument.",
            "type": "string",
            "minLength": 1,
            "maxLength": 70
        },
        "Identification": {
            "description": "Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked.",
            "type": "string",
            "minLength": 1,
            "maxLength": 34
        }
    },
    "required": [
        "CardSchemeName"
    ],
    "additionalProperties": false
}
              

OBTransactionCashBalance

{
    "type": "object",
    "properties": {
        "CreditDebitIndicator": {
            "type": "string",
            "enum": [
                "Credit",
                "Debit"
            ],
            "description": "Indicates whether the balance is a credit or a debit balance.\nUsage: A zero balance is considered to be a credit balance."
        },
        "Type": {
            "$ref": "#/definitions/OBBalanceType1Code"
        },
        "Amount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        }
    },
    "required": [
        "CreditDebitIndicator",
        "Type",
        "Amount"
    ],
    "additionalProperties": false
}
              

TransactionInformation

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

OBSupplementaryData1

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

OBBranchAndFinancialInstitutionIdentification5

{
    "type": "object",
    "properties": {
        "SchemeName": {
            "$ref": "#/definitions/OBExternalFinancialInstitutionIdentification4Code"
        },
        "Identification": {
            "description": "Unique and unambiguous identification of the servicing institution.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        }
    },
    "required": [
        "SchemeName",
        "Identification"
    ],
    "additionalProperties": false
}
              

OBExternalFinancialInstitutionIdentification4Code

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

OBCashAccount5

{
    "type": "object",
    "properties": {
        "SchemeName": {
            "$ref": "#/definitions/OBExternalAccountIdentification4Code"
        },
        "Identification": {
            "description": "Beneficiary account identification.",
            "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
}
              

OBCashAccount6

{
    "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
        }
    },
    "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
}
              

OBBranchAndFinancialInstitutionIdentification6

{
    "type": "object",
    "properties": {
        "SchemeName": {
            "$ref": "#/definitions/OBExternalFinancialInstitutionIdentification4Code"
        },
        "Identification": {
            "description": "Unique and unambiguous identification of a financial institution or a branch of a financial 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
}
              

OBOffer1

{
    "type": "object",
    "properties": {
        "AccountId": {
            "$ref": "#/definitions/AccountId"
        },
        "OffersId": {
            "description": "Identifier within the parent organisation for the offers. Must be unique in the organisation.",
            "type": "string"
        },
        "OfferType": {
            "type": "string"
        },
        "Description": {
            "type": "string"
        },
        "StartDateTime": {
            "type": "string",
            "format": "date-time"
        },
        "EndDateTime": {
            "type": "string",
            "format": "date-time"
        },
        "Rate": {
            "description": "Rate associated with the offer type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 10,
            "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
        },
        "Value": {
            "type": "integer",
            "format": "int32"
        },
        "Term": {
            "description": "Further details of the term of the offer.",
            "type": "string",
            "minLength": 1,
            "maxLength": 500
        },
        "URL": {
            "description": "URL (Uniform Resource Locator) where documentation on the offer can be found",
            "type": "string",
            "minLength": 1,
            "maxLength": 256
        },
        "Amount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        },
        "Fee": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        }
    },
    "required": [
        "AccountId",
        "OfferType"
    ],
    "additionalProperties": false
}
              

OBReadOffer1

{
    "type": "object",
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "Offer": {
                    "items": {
                        "$ref": "#/definitions/OBOffer1"
                    },
                    "type": "array"
                }
            },
            "additionalProperties": false
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

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"
}
              

OBReadStatement1

{
    "type": "object",
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "Statement": {
                    "items": {
                        "$ref": "#/definitions/OBStatement1"
                    },
                    "type": "array",
                    "description": "Provides further details on a statement resource."
                }
            },
            "additionalProperties": false
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "required": [
        "Data",
        "Links",
        "Meta"
    ],
    "additionalProperties": false
}
              

OBStatement1

{
    "type": "object",
    "properties": {
        "AccountId": {
            "$ref": "#/definitions/AccountId"
        },
        "StatementId": {
            "description": "Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable.",
            "type": "string",
            "minLength": 1,
            "maxLength": 40
        },
        "StatementReference": {
            "description": "Unique reference for the statement. This reference may be optionally populated if available.",
            "type": "string",
            "minLength": 1,
            "maxLength": 35
        },
        "Type": {
            "$ref": "#/definitions/OBExternalStatementType1Code"
        },
        "StartDateTime": {
            "description": "Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format.  All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00",
            "type": "string",
            "format": "date-time"
        },
        "EndDateTime": {
            "description": "Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format.  All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00",
            "type": "string",
            "format": "date-time"
        },
        "CreationDateTime": {
            "description": "Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format.  All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00",
            "type": "string",
            "format": "date-time"
        },
        "StatementDescription": {
            "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 500
            },
            "type": "array",
            "description": "Other descriptions that may be available for the statement resource."
        },
        "StatementBenefit": {
            "items": {
                "$ref": "#/definitions/OBStatementBenefit1"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a benefit or reward amount for the statement resource."
        },
        "StatementFee": {
            "items": {
                "$ref": "#/definitions/OBStatementFee1"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a fee for the statement resource."
        },
        "StatementInterest": {
            "items": {
                "$ref": "#/definitions/OBStatementInterest1"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a generic interest amount related to the statement resource."
        },
        "StatementDateTime": {
            "items": {
                "$ref": "#/definitions/OBStatementDateTime1"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a generic date time for the statement resource."
        },
        "StatementRate": {
            "items": {
                "$ref": "#/definitions/OBStatementRate1"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a generic rate related to the statement resource."
        },
        "StatementValue": {
            "items": {
                "$ref": "#/definitions/OBStatementValue1"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a generic number value related to the statement resource."
        },
        "StatementAmount": {
            "items": {
                "$ref": "#/definitions/OBStatementAmount1"
            },
            "type": "array",
            "description": "Set of elements used to provide details of a generic amount for the statement resource."
        }
    },
    "required": [
        "AccountId",
        "Type",
        "StartDateTime",
        "EndDateTime",
        "CreationDateTime"
    ],
    "additionalProperties": false
}
              

OBReadParty3

{
    "type": "object",
    "required": [
        "Data"
    ],
    "properties": {
        "Data": {
            "type": "object",
            "properties": {
                "Party": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/OBParty2"
                    }
                }
            }
        },
        "Links": {
            "$ref": "#/definitions/Links"
        },
        "Meta": {
            "$ref": "#/definitions/Meta"
        }
    },
    "additionalProperties": false
}
              

OBReadParty2

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

OBParty2

{
    "type": "object",
    "required": [
        "PartyId"
    ],
    "properties": {
        "PartyId": {
            "$ref": "#/definitions/PartyId"
        },
        "PartyNumber": {
            "$ref": "#/definitions/PartyNumber"
        },
        "PartyType": {
            "$ref": "#/definitions/OBExternalPartyType1Code"
        },
        "Name": {
            "$ref": "#/definitions/Name_3"
        },
        "FullLegalName": {
            "$ref": "#/definitions/FullLegalName"
        },
        "LegalStructure": {
            "$ref": "#/definitions/OBExternalLegalStructureType1Code"
        },
        "BeneficialOwnership": {
            "type": "boolean"
        },
        "AccountRole": {
            "$ref": "#/definitions/OBExternalAccountRole1Code"
        },
        "EmailAddress": {
            "$ref": "#/definitions/EmailAddress"
        },
        "Phone": {
            "$ref": "#/definitions/PhoneNumber_0"
        },
        "Mobile": {
            "$ref": "#/definitions/PhoneNumber_1"
        },
        "Relationships": {
            "$ref": "#/definitions/OBPartyRelationships1"
        }
    },
    "additionalProperties": false
}
              

PartyId

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

PartyNumber

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

OBExternalPartyType1Code

{
    "type": "string",
    "enum": [
        "Delegate",
        "Joint",
        "Sole"
    ]
}
              

Name_3

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

FullLegalName

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

OBExternalLegalStructureType1Code

{
    "type": "string",
    "x-namespaced-enum": [
        "UK.OBIE.CIC",
        "UK.OBIE.CIO",
        "UK.OBIE.Charity",
        "UK.OBIE.CoOp",
        "UK.OBIE.GeneralPartnership",
        "UK.OBIE.Individual",
        "UK.OBIE.LimitedLiabilityPartnership",
        "UK.OBIE.LimitedPartnership",
        "UK.OBIE.PrivateLimitedCompany",
        "UK.OBIE.PublicLimitedCompany",
        "UK.OBIE.ScottishLimitedPartnership",
        "UK.OBIE.Sole"
    ]
}
              

OBExternalAccountRole1Code

{
    "type": "string",
    "x-namespaced-enum": [
        "UK.OBIE.Administrator",
        "UK.OBIE.Beneficiary",
        "UK.OBIE.CustodianForMinor",
        "UK.OBIE.Granter",
        "UK.OBIE.LegalGuardian",
        "UK.OBIE.OtherParty",
        "UK.OBIE.PowerOfAttorney",
        "UK.OBIE.Principal",
        "UK.OBIE.Protector",
        "UK.OBIE.RegisteredShareholderName",
        "UK.OBIE.SecondaryOwner",
        "UK.OBIE.SeniorManagingOfficial",
        "UK.OBIE.Settlor",
        "UK.OBIE.SuccessorOnDeath"
    ]
}
              

EmailAddress

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

PhoneNumber_0

{
    "type": "string",
    "pattern": "\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"
}
              

PhoneNumber_1

{
    "type": "string",
    "pattern": "\\+[0-9]{1,3}-[0-9()+\\-]{1,30}"
}
              

CountryCode

{
    "type": "string",
    "pattern": "^[A-Z]{2,2}$"
}
              

OBPartyRelationships1

{
    "type": "object",
    "properties": {
        "Account": {
            "type": "object",
            "required": [
                "Related",
                "Id"
            ],
            "description": "Relationship to the Account resource.",
            "properties": {
                "Related": {
                    "description": "Absolute URI to the related resource.",
                    "type": "string",
                    "format": "uri"
                },
                "Id": {
                    "description": "Unique identification as assigned by the ASPSP to uniquely identify the related resource.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 40
                }
            }
        }
    }
}
              

OBExternalStatementType1Code

{
    "type": "string",
    "enum": [
        "AccountClosure",
        "AccountOpening",
        "Annual",
        "Interim",
        "RegularPeriodic"
    ]
}
              

OBStatementBenefit1

{
    "type": "object",
    "properties": {
        "Type": {
            "$ref": "#/definitions/OBExternalStatementBenefitType1Code"
        },
        "Amount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        }
    },
    "required": [
        "Type",
        "Amount"
    ],
    "additionalProperties": false
}
              

OBStatementFee1

{
    "type": "object",
    "properties": {
        "CreditDebitIndicator": {
            "type": "string",
            "enum": [
                "Credit",
                "Debit"
            ],
            "description": "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount."
        },
        "Type": {
            "$ref": "#/definitions/OBExternalStatementFeeType1Code"
        },
        "Amount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        }
    },
    "required": [
        "CreditDebitIndicator",
        "Type",
        "Amount"
    ],
    "additionalProperties": false
}
              

OBStatementInterest1

{
    "type": "object",
    "properties": {
        "CreditDebitIndicator": {
            "type": "string",
            "enum": [
                "Credit",
                "Debit"
            ],
            "description": "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount."
        },
        "Type": {
            "$ref": "#/definitions/OBExternalStatementInterestType1Code"
        },
        "Amount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        }
    },
    "required": [
        "CreditDebitIndicator",
        "Type",
        "Amount"
    ],
    "additionalProperties": false
}
              

OBStatementDateTime1

{
    "type": "object",
    "properties": {
        "DateTime": {
            "description": "Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format.  All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00",
            "type": "string",
            "format": "date-time"
        },
        "Type": {
            "$ref": "#/definitions/OBExternalStatementDateTimeType1Code"
        }
    },
    "required": [
        "DateTime",
        "Type"
    ],
    "additionalProperties": false
}
              

OBStatementRate1

{
    "type": "object",
    "properties": {
        "Rate": {
            "description": "Rate associated with the statement rate type.",
            "type": "string",
            "minLength": 1,
            "maxLength": 10,
            "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$"
        },
        "Type": {
            "$ref": "#/definitions/OBExternalStatementRateType1Code"
        }
    },
    "required": [
        "Rate",
        "Type"
    ],
    "additionalProperties": false
}
              

OBStatementValue1

{
    "type": "object",
    "properties": {
        "Value": {
            "description": "Value associated with the statement value type.",
            "type": "integer",
            "format": "int32"
        },
        "Type": {
            "$ref": "#/definitions/OBExternalStatementValueType1Code"
        }
    },
    "required": [
        "Value",
        "Type"
    ],
    "additionalProperties": false
}
              

OBStatementAmount1

{
    "type": "object",
    "properties": {
        "CreditDebitIndicator": {
            "type": "string",
            "enum": [
                "Credit",
                "Debit"
            ],
            "description": "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount."
        },
        "Type": {
            "$ref": "#/definitions/OBExternalStatementAmountType1Code"
        },
        "Amount": {
            "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount"
        }
    },
    "required": [
        "CreditDebitIndicator",
        "Type",
        "Amount"
    ],
    "additionalProperties": false
}
              

OBExternalStatementBenefitType1Code

{
    "type": "string",
    "example": [
        "UK.OBIE.Cashback",
        "UK.OBIE.Insurance",
        "UK.OBIE.TravelDiscount",
        "UK.OBIE.TravelInsurance"
    ],
    "minLength": 1,
    "maxLength": 40
}
              

OBExternalStatementFeeType1Code

{
    "type": "string",
    "example": [
        "UK.OBIE.Annual",
        "UK.OBIE.BalanceTransfer",
        "UK.OBIE.CashAdvance",
        "UK.OBIE.CashTransaction",
        "UK.OBIE.ForeignCashTransaction",
        "UK.OBIE.ForeignTransaction",
        "UK.OBIE.Gambling",
        "UK.OBIE.LatePayment",
        "UK.OBIE.MoneyTransfer",
        "UK.OBIE.Monthly",
        "UK.OBIE.Overlimit",
        "UK.OBIE.PostalOrder",
        "UK.OBIE.PrizeEntry",
        "UK.OBIE.StatementCopy",
        "UK.OBIE.Total"
    ],
    "minLength": 1,
    "maxLength": 40
}
              

OBExternalStatementInterestType1Code

{
    "type": "string",
    "example": [
        "UK.OBIE.BalanceTransfer",
        "UK.OBIE.Cash",
        "UK.OBIE.EstimatedNext",
        "UK.OBIE.Purchase",
        "UK.OBIE.Total"
    ],
    "minLength": 1,
    "maxLength": 40
}
              

OBExternalStatementDateTimeType1Code

{
    "type": "string",
    "example": [
        "UK.OBIE.BalanceTransferPromoEnd",
        "UK.OBIE.DirectDebitDue",
        "UK.OBIE.LastPayment",
        "UK.OBIE.LastStatement",
        "UK.OBIE.NextStatement",
        "UK.OBIE.PaymentDue",
        "UK.OBIE.PurchasePromoEnd",
        "UK.OBIE.StatementAvailable"
    ],
    "minLength": 1,
    "maxLength": 40
}
              

OBExternalStatementRateType1Code

{
    "type": "string",
    "example": [
        "UK.OBIE.AnnualBalanceTransfer",
        "UK.OBIE.AnnualBalanceTransferAfterPromo",
        "UK.OBIE.AnnualBalanceTransferPromo",
        "UK.OBIE.AnnualCash",
        "UK.OBIE.AnnualPurchase",
        "UK.OBIE.AnnualPurchaseAfterPromo",
        "UK.OBIE.AnnualPurchasePromo",
        "UK.OBIE.MonthlyBalanceTransfer",
        "UK.OBIE.MonthlyCash",
        "UK.OBIE.MonthlyPurchase"
    ],
    "minLength": 1,
    "maxLength": 40
}
              

OBExternalStatementValueType1Code

{
    "type": "string",
    "example": [
        "UK.OBIE.AirMilesPoints",
        "UK.OBIE.AirMilesPointsBalance",
        "UK.OBIE.Credits",
        "UK.OBIE.Debits",
        "UK.OBIE.HotelPoints",
        "UK.OBIE.HotelPointsBalance",
        "UK.OBIE.RetailShoppingPoints",
        "UK.OBIE.RetailShoppingPointsBalance"
    ],
    "minLength": 1,
    "maxLength": 40
}
              

OBExternalStatementAmountType1Code

{
    "type": "string",
    "example": [
        "UK.OBIE.ArrearsClosingBalance",
        "UK.OBIE.AvailableBalance",
        "UK.OBIE.AverageBalanceWhenInCredit",
        "UK.OBIE.AverageBalanceWhenInDebit",
        "UK.OBIE.AverageDailyBalance",
        "UK.OBIE.BalanceTransferClosingBalance",
        "UK.OBIE.CashClosingBalance",
        "UK.OBIE.ClosingBalance",
        "UK.OBIE.CreditLimit",
        "UK.OBIE.CurrentPayment",
        "UK.OBIE.DirectDebitPaymentDue",
        "UK.OBIE.FSCSInsurance",
        "UK.OBIE.MinimumPaymentDue",
        "UK.OBIE.PendingTransactionsBalance",
        "UK.OBIE.PreviousClosingBalance",
        "UK.OBIE.PreviousPayment",
        "UK.OBIE.PurchaseClosingBalance",
        "UK.OBIE.StartingBalance",
        "UK.OBIE.TotalAdjustments",
        "UK.OBIE.TotalCashAdvances",
        "UK.OBIE.TotalCharges",
        "UK.OBIE.TotalCredits",
        "UK.OBIE.TotalDebits",
        "UK.OBIE.TotalPurchases"
    ],
    "minLength": 1,
    "maxLength": 40
}
              

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
}
              

OBRisk2

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