{ "swagger": "2.0", "info": { "title": "Account and Transaction API Specification", "description": "Swagger for Account and Transaction API Specification", "termsOfService": "https://www.openbanking.org.uk/terms", "contact": { "name": "Service Desk", "email": "ServiceDesk@openbanking.org.uk" }, "license": { "name": "open-licence", "url": "https://www.openbanking.org.uk/open-licence" }, "version": "v3.1.2-RC1" }, "basePath": "/open-banking/v3.1/aisp", "schemes": [ "https" ], "consumes": [ "application/json; charset=utf-8", "application/jose+jwe" ], "produces": [ "application/json; charset=utf-8", "application/jose+jwe" ], "paths": { "/account-access-consents": { "post": { "tags": [ "Account Access" ], "summary": "Create Account Access Consents", "operationId": "CreateAccountAccessConsents", "parameters": [ { "$ref": "#/parameters/OBReadConsent1Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "201": { "$ref": "#/responses/201AccountAccessConsentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "accounts" ] } ] } }, "/account-access-consents/{ConsentId}": { "get": { "tags": [ "Account Access" ], "summary": "Get Account Access Consents", "operationId": "GetAccountAccessConsentsConsentId", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountAccessConsentsConsentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "accounts" ] } ] }, "delete": { "tags": [ "Account Access" ], "summary": "Delete Account Access Consents", "operationId": "DeleteAccountAccessConsentsConsentId", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "204": { "$ref": "#/responses/204AccountAccessConsentsConsentIdDeleted" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "accounts" ] } ] } }, "/accounts": { "get": { "tags": [ "Accounts" ], "summary": "Get Accounts", "operationId": "GetAccounts", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}": { "get": { "tags": [ "Accounts" ], "summary": "Get Accounts", "operationId": "GetAccountsAccountId", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/balances": { "get": { "tags": [ "Balances" ], "summary": "Get Balances", "operationId": "GetAccountsAccountIdBalances", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdBalancesRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/beneficiaries": { "get": { "tags": [ "Beneficiaries" ], "summary": "Get Beneficiaries", "operationId": "GetAccountsAccountIdBeneficiaries", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdBeneficiariesRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/direct-debits": { "get": { "tags": [ "Direct Debits" ], "summary": "Get Direct Debits", "operationId": "GetAccountsAccountIdDirectDebits", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdDirectDebitsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/offers": { "get": { "tags": [ "Offers" ], "summary": "Get Offers", "operationId": "GetAccountsAccountIdOffers", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdOffersRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/parties": { "get": { "tags": [ "Parties" ], "summary": "Get Parties", "operationId": "GetAccountsAccountIdParties", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdPartiesRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/party": { "get": { "tags": [ "Parties" ], "summary": "Get Parties", "operationId": "GetAccountsAccountIdParty", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdPartyRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/product": { "get": { "tags": [ "Products" ], "summary": "Get Products", "operationId": "GetAccountsAccountIdProduct", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdProductRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/scheduled-payments": { "get": { "tags": [ "Scheduled Payments" ], "summary": "Get Scheduled Payments", "operationId": "GetAccountsAccountIdScheduledPayments", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdScheduledPaymentsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/standing-orders": { "get": { "tags": [ "Standing Orders" ], "summary": "Get Standing Orders", "operationId": "GetAccountsAccountIdStandingOrders", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdStandingOrdersRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/statements": { "get": { "tags": [ "Statements" ], "summary": "Get Statements", "operationId": "GetAccountsAccountIdStatements", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/FromStatementDateTimeParam" }, { "$ref": "#/parameters/ToStatementDateTimeParam" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdStatementsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/statements/{StatementId}": { "get": { "tags": [ "Statements" ], "summary": "Get Statements", "operationId": "GetAccountsAccountIdStatementsStatementId", "parameters": [ { "$ref": "#/parameters/StatementId" }, { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdStatementsStatementIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/statements/{StatementId}/file": { "get": { "tags": [ "Statements" ], "summary": "Get Statements", "operationId": "GetAccountsAccountIdStatementsStatementIdFile", "parameters": [ { "$ref": "#/parameters/StatementId" }, { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdStatementsStatementIdFileRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/statements/{StatementId}/transactions": { "get": { "tags": [ "Transactions" ], "summary": "Get Transactions", "operationId": "GetAccountsAccountIdStatementsStatementIdTransactions", "parameters": [ { "$ref": "#/parameters/StatementId" }, { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdStatementsStatementIdTransactionsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/accounts/{AccountId}/transactions": { "get": { "tags": [ "Transactions" ], "summary": "Get Transactions", "operationId": "GetAccountsAccountIdTransactions", "parameters": [ { "$ref": "#/parameters/AccountId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/FromBookingDateTimeParam" }, { "$ref": "#/parameters/ToBookingDateTimeParam" } ], "responses": { "200": { "$ref": "#/responses/200AccountsAccountIdTransactionsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/balances": { "get": { "tags": [ "Balances" ], "summary": "Get Balances", "operationId": "GetBalances", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200BalancesRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/beneficiaries": { "get": { "tags": [ "Beneficiaries" ], "summary": "Get Beneficiaries", "operationId": "GetBeneficiaries", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200BeneficiariesRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/direct-debits": { "get": { "tags": [ "Direct Debits" ], "summary": "Get Direct Debits", "operationId": "GetDirectDebits", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DirectDebitsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/offers": { "get": { "tags": [ "Offers" ], "summary": "Get Offers", "operationId": "GetOffers", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200OffersRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/party": { "get": { "tags": [ "Parties" ], "summary": "Get Parties", "operationId": "GetParty", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200PartyRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/products": { "get": { "tags": [ "Products" ], "summary": "Get Products", "operationId": "GetProducts", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200ProductsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/scheduled-payments": { "get": { "tags": [ "Scheduled Payments" ], "summary": "Get Scheduled Payments", "operationId": "GetScheduledPayments", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200ScheduledPaymentsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/standing-orders": { "get": { "tags": [ "Standing Orders" ], "summary": "Get Standing Orders", "operationId": "GetStandingOrders", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200StandingOrdersRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/statements": { "get": { "tags": [ "Statements" ], "summary": "Get Statements", "operationId": "GetStatements", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/FromStatementDateTimeParam" }, { "$ref": "#/parameters/ToStatementDateTimeParam" } ], "responses": { "200": { "$ref": "#/responses/200StatementsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } }, "/transactions": { "get": { "tags": [ "Transactions" ], "summary": "Get Transactions", "operationId": "GetTransactions", "parameters": [ { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/FromBookingDateTimeParam" }, { "$ref": "#/parameters/ToBookingDateTimeParam" } ], "responses": { "200": { "$ref": "#/responses/200TransactionsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "accounts" ] } ] } } }, "parameters": { "FromBookingDateTimeParam": { "in": "query", "name": "fromBookingDateTime", "type": "string", "format": "date-time", "description": "The UTC ISO 8601 Date Time to filter transactions FROM\nNB Time component is optional - set to 00:00:00 for just Date.\nIf the Date Time contains a timezone, the ASPSP must ignore the timezone component." }, "ToBookingDateTimeParam": { "in": "query", "name": "toBookingDateTime", "type": "string", "format": "date-time", "description": "The UTC ISO 8601 Date Time to filter transactions TO\nNB Time component is optional - set to 00:00:00 for just Date.\nIf the Date Time contains a timezone, the ASPSP must ignore the timezone component." }, "FromStatementDateTimeParam": { "in": "query", "name": "fromStatementDateTime", "type": "string", "format": "date-time", "description": "The UTC ISO 8601 Date Time to filter statements FROM\nNB Time component is optional - set to 00:00:00 for just Date.\nIf the Date Time contains a timezone, the ASPSP must ignore the timezone component." }, "ToStatementDateTimeParam": { "in": "query", "name": "toStatementDateTime", "type": "string", "format": "date-time", "description": "The UTC ISO 8601 Date Time to filter statements TO\nNB Time component is optional - set to 00:00:00 for just Date.\nIf the Date Time contains a timezone, the ASPSP must ignore the timezone component." }, "OBReadConsent1Param": { "name": "OBReadConsent1Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBReadConsent1" } }, "ConsentId": { "name": "ConsentId", "in": "path", "description": "ConsentId", "required": true, "type": "string" }, "AccountId": { "name": "AccountId", "in": "path", "description": "AccountId", "required": true, "type": "string" }, "StatementId": { "name": "StatementId", "in": "path", "description": "StatementId", "required": true, "type": "string" }, "Authorization": { "in": "header", "name": "Authorization", "type": "string", "required": true, "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" }, "x-customer-user-agent": { "in": "header", "name": "x-customer-user-agent", "type": "string", "description": "Indicates the user-agent that the PSU is using.", "required": false }, "x-fapi-customer-ip-address": { "in": "header", "name": "x-fapi-customer-ip-address", "type": "string", "required": false, "description": "The PSU's IP address if the PSU is currently logged in with the TPP." }, "x-fapi-auth-date": { "in": "header", "name": "x-fapi-auth-date", "type": "string", "required": false, "description": "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC", "pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \\d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \\d{4} \\d{2}:\\d{2}:\\d{2} (GMT|UTC)$" }, "x-fapi-interaction-id": { "in": "header", "name": "x-fapi-interaction-id", "type": "string", "required": false, "description": "An RFC4122 UID used as a correlation id." }, "x-idempotency-key": { "name": "x-idempotency-key", "in": "header", "description": "Every request will be processed only once per x-idempotency-key. The\nIdempotency Key will be valid for 24 hours.\n", "required": true, "type": "string", "pattern": "^(?!\\s)(.*)(\\S)$", "maxLength": 40 }, "x-jws-signature": { "in": "header", "name": "x-jws-signature", "type": "string", "required": true, "description": "A detached JWS signature of the body of the payload." } }, "responses": { "201AccountAccessConsentsCreated": { "description": "Account Access Consents Created", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadConsentResponse1" } }, "200AccountAccessConsentsConsentIdRead": { "description": "Account Access Consents Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadConsentResponse1" } }, "204AccountAccessConsentsConsentIdDeleted": { "description": "Account Access Consents Deleted", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "200AccountsRead": { "description": "Accounts Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadAccount4" } }, "200AccountsAccountIdRead": { "description": "Accounts Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadAccount4" } }, "200AccountsAccountIdBalancesRead": { "description": "Balances Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadBalance1" } }, "200BalancesRead": { "description": "Balances Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadBalance1" } }, "200AccountsAccountIdTransactionsRead": { "description": "Transactions Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadTransaction5" } }, "200TransactionsRead": { "description": "Transactions Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadTransaction5" } }, "200AccountsAccountIdBeneficiariesRead": { "description": "Beneficiaries Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadBeneficiary3" } }, "200BeneficiariesRead": { "description": "Beneficiaries Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadBeneficiary3" } }, "200AccountsAccountIdDirectDebitsRead": { "description": "Direct Debits Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadDirectDebit1" } }, "200DirectDebitsRead": { "description": "Direct Debits Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadDirectDebit1" } }, "200AccountsAccountIdStandingOrdersRead": { "description": "Standing Orders Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadStandingOrder5" } }, "200StandingOrdersRead": { "description": "Standing Orders Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadStandingOrder5" } }, "200AccountsAccountIdProductRead": { "description": "Products Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadProduct2" } }, "200ProductsRead": { "description": "Products Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadProduct2" } }, "200AccountsAccountIdOffersRead": { "description": "Offers Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadOffer1" } }, "200OffersRead": { "description": "Offers Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadOffer1" } }, "200AccountsAccountIdPartiesRead": { "description": "Parties Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadParty3" } }, "200AccountsAccountIdPartyRead": { "description": "Parties Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadParty2" } }, "200PartyRead": { "description": "Parties Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadParty2" } }, "200AccountsAccountIdScheduledPaymentsRead": { "description": "Scheduled Payments Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadScheduledPayment2" } }, "200ScheduledPaymentsRead": { "description": "Scheduled Payments Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadScheduledPayment2" } }, "200AccountsAccountIdStatementsRead": { "description": "Statements Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadStatement2" } }, "200AccountsAccountIdStatementsStatementIdRead": { "description": "Statements Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadStatement2" } }, "200AccountsAccountIdStatementsStatementIdFileRead": { "description": "Statements Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/File" } }, "200AccountsAccountIdStatementsStatementIdTransactionsRead": { "description": "Transactions Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadTransaction5" } }, "200StatementsRead": { "description": "Statements Read", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBReadStatement2" } }, "400Error": { "description": "Bad request", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBErrorResponse1" } }, "401Error": { "description": "Unauthorized", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "403Error": { "description": "Forbidden", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBErrorResponse1" } }, "404Error": { "description": "Not found", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "405Error": { "description": "Method Not Allowed", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "406Error": { "description": "Not Acceptable", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "415Error": { "description": "Unsupported Media Type", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "429Error": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "Number in seconds to wait", "type": "integer" }, "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "500Error": { "description": "Internal Server Error", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } }, "schema": { "$ref": "#/definitions/OBErrorResponse1" } } }, "securityDefinitions": { "TPPOAuth2Security": { "type": "oauth2", "flow": "application", "tokenUrl": "https://authserver.example/token", "scopes": { "accounts": "Ability to read Accounts information" }, "description": "TPP client credential authorisation flow with the ASPSP" }, "PSUOAuth2Security": { "type": "oauth2", "flow": "accessCode", "tokenUrl": "https://authserver.example/token", "authorizationUrl": "https://authserver.example/authorization", "scopes": { "accounts": "Ability to read Accounts information" }, "description": "OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU" } }, "definitions": { "AccountId": { "description": "A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.", "type": "string", "minLength": 1, "maxLength": 40 }, "ActiveOrHistoricCurrencyCode_0": { "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}$" }, "ActiveOrHistoricCurrencyCode_1": { "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}$" }, "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 }, "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 }, "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.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" }, "BuildingNumber": { "description": "Number that identifies the position of a building on a street.", "type": "string", "minLength": 1, "maxLength": 16 }, "CountryCode": { "description": "Nation with its own government, occupying a particular territory.", "type": "string", "pattern": "^[A-Z]{2,2}$" }, "CountrySubDivision": { "description": "Identifies a subdivision of a country eg, state, region, county.", "type": "string", "minLength": 1, "maxLength": 35 }, "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. \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" }, "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. \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" }, "Description_0": { "description": "Specifies the description of the account type.", "type": "string", "minLength": 1, "maxLength": 35 }, "Description_1": { "description": "Description that may be available for the statement fee.", "type": "string", "minLength": 1, "maxLength": 128 }, "Description_2": { "description": "Description that may be available for the statement interest.", "type": "string", "minLength": 1, "maxLength": 128 }, "Description_3": { "description": "Description to describe the purpose of the code", "type": "string", "minLength": 1, "maxLength": 350 }, "EmailAddress": { "description": "Address for electronic mail (e-mail).", "type": "string", "minLength": 1, "maxLength": 256 }, "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. \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" }, "File": { "type": "object", "properties": {} }, "FinalPaymentDateTime": { "description": "The date on which the final payment for a Standing Order schedule will be made.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" }, "FirstPaymentDateTime": { "description": "The date on which the first payment for a Standing Order schedule will be made.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" }, "Frequency_0": { "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", "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))$" }, "Frequency_1": { "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", "pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" }, "FullLegalName": { "description": "Specifies a character string with a maximum length of 350 characters.", "type": "string", "minLength": 1, "maxLength": 350 }, "ISODateTime": { "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "Identification_0": { "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", "type": "string", "minLength": 1, "maxLength": 256 }, "Identification_1": { "description": "Unique and unambiguous identification of the servicing institution.", "type": "string", "minLength": 1, "maxLength": 35 }, "Identification_2": { "description": "Unique and unambiguous identification of a financial institution or a branch of a financial institution.", "type": "string", "minLength": 1, "maxLength": 35 }, "Links": { "type": "object", "description": "Links relevant to the payload", "properties": { "Self": { "type": "string", "format": "uri" }, "First": { "type": "string", "format": "uri" }, "Prev": { "type": "string", "format": "uri" }, "Next": { "type": "string", "format": "uri" }, "Last": { "type": "string", "format": "uri" } }, "additionalProperties": false, "required": [ "Self" ] }, "Meta": { "title": "MetaData", "type": "object", "description": "Meta Data relevant to the payload", "properties": { "TotalPages": { "type": "integer", "format": "int32" }, "FirstAvailableDateTime": { "$ref": "#/definitions/ISODateTime" }, "LastAvailableDateTime": { "$ref": "#/definitions/ISODateTime" } }, "additionalProperties": false }, "Name_0": { "description": "The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "Name_1": { "description": "Name by which a party is known and which is usually used to identify that party.", "type": "string", "minLength": 1, "maxLength": 70 }, "Name_2": { "description": "Name by which an agent is known and which is usually used to identify that agent.", "type": "string", "minLength": 1, "maxLength": 140 }, "Name_3": { "description": "Long name associated with the code", "type": "string", "minLength": 1, "maxLength": 70 }, "NextPaymentDateTime": { "description": "The date on which the next payment for a Standing Order schedule will be made.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" }, "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 }, "Number_0": { "description": "Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances.", "type": "integer" }, "Number_1": { "description": "fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount", "type": "integer" }, "OBAccount3": { "type": "object", "description": "Unambiguous identification of the account to which credit and debit entries are made.", "required": [ "AccountId", "Currency", "AccountType", "AccountSubType" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_0" }, "AccountType": { "$ref": "#/definitions/OBExternalAccountType1Code" }, "AccountSubType": { "$ref": "#/definitions/OBExternalAccountSubType1Code" }, "Description": { "$ref": "#/definitions/Description_0" }, "Nickname": { "$ref": "#/definitions/Nickname" }, "Account": { "type": "array", "items": { "type": "object", "description": "Provides the details to identify an account.", "required": [ "SchemeName", "Identification" ], "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalAccountIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_0" }, "Name": { "$ref": "#/definitions/Name_0" }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } } }, "Servicer": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5_0" } } }, "OBAccount3Basic": { "type": "object", "description": "Unambiguous identification of the account to which credit and debit entries are made.", "required": [ "AccountId", "Currency", "AccountType", "AccountSubType" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_0" }, "AccountType": { "$ref": "#/definitions/OBExternalAccountType1Code" }, "AccountSubType": { "$ref": "#/definitions/OBExternalAccountSubType1Code" }, "Description": { "$ref": "#/definitions/Description_0" }, "Nickname": { "$ref": "#/definitions/Nickname" } } }, "OBAccount3Detail": { "type": "object", "description": "Unambiguous identification of the account to which credit and debit entries are made.", "required": [ "AccountId", "Currency", "AccountType", "AccountSubType", "Account" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_0" }, "AccountType": { "$ref": "#/definitions/OBExternalAccountType1Code" }, "AccountSubType": { "$ref": "#/definitions/OBExternalAccountSubType1Code" }, "Description": { "$ref": "#/definitions/Description_0" }, "Nickname": { "$ref": "#/definitions/Nickname" }, "Account": { "type": "array", "items": { "type": "object", "description": "Provides the details to identify an account.", "required": [ "SchemeName", "Identification" ], "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalAccountIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_0" }, "Name": { "$ref": "#/definitions/Name_0" }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } } }, "Servicer": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5_0" } } }, "OBAccount4": { "type": "object", "description": "Unambiguous identification of the account to which credit and debit entries are made.", "required": [ "AccountId", "Currency", "AccountType", "AccountSubType" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "Status": { "$ref": "#/definitions/OBAccountStatus1Code" }, "StatusUpdateDateTime": { "$ref": "#/definitions/StatusUpdateDateTime" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_0" }, "AccountType": { "$ref": "#/definitions/OBExternalAccountType1Code" }, "AccountSubType": { "$ref": "#/definitions/OBExternalAccountSubType1Code" }, "Description": { "$ref": "#/definitions/Description_0" }, "Nickname": { "$ref": "#/definitions/Nickname" }, "Account": { "type": "array", "items": { "type": "object", "description": "Provides the details to identify an account.", "required": [ "SchemeName", "Identification" ], "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalAccountIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_0" }, "Name": { "$ref": "#/definitions/Name_0" }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } } }, "Servicer": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5_0" } } }, "OBAccount4Basic": { "type": "object", "description": "Unambiguous identification of the account to which credit and debit entries are made.", "required": [ "AccountId", "Currency", "AccountType", "AccountSubType" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "Status": { "$ref": "#/definitions/OBAccountStatus1Code" }, "StatusUpdateDateTime": { "$ref": "#/definitions/StatusUpdateDateTime" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_0" }, "AccountType": { "$ref": "#/definitions/OBExternalAccountType1Code" }, "AccountSubType": { "$ref": "#/definitions/OBExternalAccountSubType1Code" }, "Description": { "$ref": "#/definitions/Description_0" }, "Nickname": { "$ref": "#/definitions/Nickname" } } }, "OBAccount4Detail": { "type": "object", "description": "Unambiguous identification of the account to which credit and debit entries are made.", "required": [ "AccountId", "Currency", "AccountType", "AccountSubType", "Account" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "Status": { "$ref": "#/definitions/OBAccountStatus1Code" }, "StatusUpdateDateTime": { "$ref": "#/definitions/StatusUpdateDateTime" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_0" }, "AccountType": { "$ref": "#/definitions/OBExternalAccountType1Code" }, "AccountSubType": { "$ref": "#/definitions/OBExternalAccountSubType1Code" }, "Description": { "$ref": "#/definitions/Description_0" }, "Nickname": { "$ref": "#/definitions/Nickname" }, "Account": { "type": "array", "items": { "type": "object", "description": "Provides the details to identify an account.", "required": [ "SchemeName", "Identification" ], "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalAccountIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_0" }, "Name": { "$ref": "#/definitions/Name_0" }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } } }, "Servicer": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5_0" } } }, "OBAccountStatus1Code": { "description": "Specifies the status of account resource in code form.", "type": "string", "enum": [ "Deleted", "Disabled", "Enabled", "Pending", "ProForma" ] }, "OBActiveCurrencyAndAmount_SimpleType": { "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.", "type": "string", "pattern": "^\\d{1,13}\\.\\d{1,5}$" }, "OBActiveOrHistoricCurrencyAndAmount_0": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the first Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "OBActiveOrHistoricCurrencyAndAmount_1": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the next Standing Order.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "OBActiveOrHistoricCurrencyAndAmount_2": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the final Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "OBActiveOrHistoricCurrencyAndAmount_3": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Amount of money associated with the statement benefit type.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "OBActiveOrHistoricCurrencyAndAmount_4": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Amount of money associated with the statement fee type.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "OBActiveOrHistoricCurrencyAndAmount_5": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Amount of money associated with the statement interest amount type.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "OBActiveOrHistoricCurrencyAndAmount_6": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Amount of money associated with the amount type.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "OBActiveOrHistoricCurrencyAndAmount_7": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Amount of money in the cash transaction entry.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "OBActiveOrHistoricCurrencyAndAmount_8": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Transaction charges to be paid by the charge bearer.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "OBActiveOrHistoricCurrencyAndAmount_9": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "OBAddressTypeCode": { "description": "Identifies the nature of the postal address.", "type": "string", "enum": [ "Business", "Correspondence", "DeliveryTo", "MailTo", "POBox", "Postal", "Residential", "Statement" ] }, "OBBalanceType1Code": { "description": "Balance type, in a coded form.", "type": "string", "enum": [ "ClosingAvailable", "ClosingBooked", "ClosingCleared", "Expected", "ForwardAvailable", "Information", "InterimAvailable", "InterimBooked", "InterimCleared", "OpeningAvailable", "OpeningBooked", "OpeningCleared", "PreviouslyClosedBooked" ] }, "OBBankTransactionCodeStructure1": { "type": "object", "required": [ "Code", "SubCode" ], "description": "Set of elements used to fully identify the type of underlying transaction resulting in an entry.", "properties": { "Code": { "description": "Specifies the family within a domain.", "type": "string" }, "SubCode": { "description": "Specifies the sub-product family within a specific family.", "type": "string" } } }, "OBBeneficiary3": { "type": "object", "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "BeneficiaryId": { "$ref": "#/definitions/BeneficiaryId" }, "Reference": { "$ref": "#/definitions/Reference" }, "CreditorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification6_2" }, "CreditorAccount": { "$ref": "#/definitions/OBCashAccount5_1" } } }, "OBBeneficiary3Basic": { "type": "object", "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "BeneficiaryId": { "$ref": "#/definitions/BeneficiaryId" }, "Reference": { "$ref": "#/definitions/Reference" } } }, "OBBeneficiary3Detail": { "type": "object", "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "BeneficiaryId": { "$ref": "#/definitions/BeneficiaryId" }, "Reference": { "$ref": "#/definitions/Reference" }, "CreditorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification6_2" }, "CreditorAccount": { "$ref": "#/definitions/OBCashAccount5_1" } }, "required": [ "CreditorAccount" ] }, "OBBranchAndFinancialInstitutionIdentification5_0": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.", "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalFinancialInstitutionIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_1" } } }, "OBBranchAndFinancialInstitutionIdentification5_1": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.\nThis is the servicer of the beneficiary account.", "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalFinancialInstitutionIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_1" } } }, "OBBranchAndFinancialInstitutionIdentification6_0": { "type": "object", "description": "Financial institution servicing an account for the creditor.", "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalFinancialInstitutionIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_2" }, "Name": { "$ref": "#/definitions/Name_2" }, "PostalAddress": { "$ref": "#/definitions/OBPostalAddress6" } } }, "OBBranchAndFinancialInstitutionIdentification6_1": { "type": "object", "description": "Financial institution servicing an account for the debtor.", "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalFinancialInstitutionIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_2" }, "Name": { "$ref": "#/definitions/Name_2" }, "PostalAddress": { "$ref": "#/definitions/OBPostalAddress6" } } }, "OBBranchAndFinancialInstitutionIdentification6_2": { "type": "object", "description": "Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account.\nThis is the servicer of the beneficiary account.", "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalFinancialInstitutionIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_1" }, "Name": { "$ref": "#/definitions/Name_2" }, "PostalAddress": { "$ref": "#/definitions/OBPostalAddress6" } } }, "OBCashAccount5_0": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Provides the details to identify the beneficiary account.", "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalAccountIdentification4Code" }, "Identification": { "description": "Beneficiary account identification.", "type": "string", "minLength": 1, "maxLength": 256 }, "Name": { "$ref": "#/definitions/Name_0" }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "OBCashAccount5_1": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Provides the details to identify the beneficiary account.", "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalAccountIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_0" }, "Name": { "$ref": "#/definitions/Name_0" }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "OBCashAccount6_0": { "type": "object", "description": "Unambiguous identification of the account of the creditor, in the case of a debit transaction.", "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalAccountIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_0" }, "Name": { "$ref": "#/definitions/Name_0" }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "OBCashAccount6_1": { "type": "object", "description": "Unambiguous identification of the account of the debtor, in the case of a crebit transaction.", "properties": { "SchemeName": { "$ref": "#/definitions/OBExternalAccountIdentification4Code" }, "Identification": { "$ref": "#/definitions/Identification_0" }, "Name": { "$ref": "#/definitions/Name_0" }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "OBCreditDebitCode_0": { "description": "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount.", "type": "string", "enum": [ "Credit", "Debit" ] }, "OBCreditDebitCode_1": { "description": "Indicates whether the transaction is a credit or a debit entry.", "type": "string", "enum": [ "Credit", "Debit" ] }, "OBCreditDebitCode_2": { "description": "Indicates whether the balance is a credit or a debit balance. \nUsage: A zero balance is considered to be a credit balance.", "type": "string", "enum": [ "Credit", "Debit" ] }, "OBCurrencyExchange5": { "type": "object", "required": [ "SourceCurrency", "ExchangeRate" ], "description": "Set of elements used to provide details on the currency exchange.", "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 into which an amount is to be converted in a currency conversion.", "type": "string", "pattern": "^[A-Z]{3,3}$" }, "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": "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.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" }, "InstructedAmount": { "type": "object", "required": [ "Amount", "Currency" ], "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.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } } } }, "OBEntryStatus1Code": { "description": "Status of a transaction entry on the books of the account servicer.", "type": "string", "enum": [ "Booked", "Pending" ] }, "OBError1": { "type": "object", "properties": { "ErrorCode": { "description": "Low level textual error code, e.g., UK.OBIE.Field.Missing", "type": "string", "x-namespaced-enum": [ "UK.OBIE.Field.Expected", "UK.OBIE.Field.Invalid", "UK.OBIE.Field.InvalidDate", "UK.OBIE.Field.Missing", "UK.OBIE.Field.Unexpected", "UK.OBIE.Header.Invalid", "UK.OBIE.Header.Missing", "UK.OBIE.Reauthenticate", "UK.OBIE.Resource.ConsentMismatch", "UK.OBIE.Resource.InvalidConsentStatus", "UK.OBIE.Resource.InvalidFormat", "UK.OBIE.Resource.NotFound", "UK.OBIE.Rules.AfterCutOffDateTime", "UK.OBIE.Rules.DuplicateReference", "UK.OBIE.Signature.Invalid", "UK.OBIE.Signature.InvalidClaim", "UK.OBIE.Signature.Malformed", "UK.OBIE.Signature.Missing", "UK.OBIE.Signature.MissingClaim", "UK.OBIE.Signature.Unexpected", "UK.OBIE.UnexpectedError", "UK.OBIE.Unsupported.AccountIdentifier", "UK.OBIE.Unsupported.AccountSecondaryIdentifier", "UK.OBIE.Unsupported.Currency", "UK.OBIE.Unsupported.Frequency", "UK.OBIE.Unsupported.LocalInstrument", "UK.OBIE.Unsupported.Scheme" ] }, "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": { "description": "An array of detail error codes, and messages, and URLs to documentation to help remediation.", "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 }, "OBExternalAccountIdentification4Code": { "description": "Name of the identification scheme, in a coded form as published in an external list.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ] }, "OBExternalAccountRole1Code": { "description": "A party�s role with respect to the related account.", "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" ] }, "OBExternalAccountSubType1Code": { "description": "Specifies the sub type of account (product family group).", "type": "string", "enum": [ "ChargeCard", "CreditCard", "CurrentAccount", "EMoney", "Loan", "Mortgage", "PrePaidCard", "Savings" ] }, "OBExternalAccountType1Code": { "description": "Specifies the type of account (personal or business).", "type": "string", "enum": [ "Business", "Personal" ] }, "OBExternalFinancialInstitutionIdentification4Code": { "description": "Name of the identification scheme, in a coded form as published in an external list.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.BICFI" ] }, "OBExternalLegalStructureType1Code": { "description": "Legal standing of the party.", "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" ] }, "OBExternalPartyType1Code": { "description": "Party type, in a coded form.", "type": "string", "enum": [ "Delegate", "Joint", "Sole" ] }, "OBExternalScheduleType1Code": { "description": "Specifies the scheduled payment date type requested", "type": "string", "enum": [ "Arrival", "Execution" ] }, "OBExternalStandingOrderStatus1Code": { "description": "Specifies the status of the standing order in code form.", "type": "string", "enum": [ "Active", "Inactive" ] }, "OBExternalStatementAmountType1Code": { "description": "Amount type, in a coded form.", "type": "string", "x-namespaced-enum": [ "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" ] }, "OBExternalStatementBenefitType1Code": { "description": "Benefit type, in a coded form.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.Cashback", "UK.OBIE.Insurance", "UK.OBIE.TravelDiscount", "UK.OBIE.TravelInsurance" ] }, "OBExternalStatementDateTimeType1Code": { "description": "Date time type, in a coded form.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.BalanceTransferPromoEnd", "UK.OBIE.DirectDebitDue", "UK.OBIE.LastPayment", "UK.OBIE.LastStatement", "UK.OBIE.NextStatement", "UK.OBIE.PaymentDue", "UK.OBIE.PurchasePromoEnd", "UK.OBIE.StatementAvailable" ] }, "OBExternalStatementFeeFrequency1Code": { "description": "How frequently the fee is applied to the Account.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.ChargingPeriod", "UK.OBIE.PerTransactionAmount", "UK.OBIE.PerTransactionPercentage", "UK.OBIE.Quarterly", "UK.OBIE.StatementMonthly", "UK.OBIE.Weekly" ] }, "OBExternalStatementFeeRateType1Code": { "description": "Description that may be available for the statement fee rate type.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.AER", "UK.OBIE.EAR" ] }, "OBExternalStatementFeeType1Code": { "description": "Fee type, in a coded form.", "type": "string", "x-namespaced-enum": [ "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" ] }, "OBExternalStatementInterestFrequency1Code": { "description": "Specifies the statement fee type requested", "type": "string", "x-namespaced-enum": [ "UK.OBIE.Daily", "UK.OBIE.HalfYearly", "UK.OBIE.Monthly", "UK.OBIE.PerStatementDate", "UK.OBIE.Quarterly", "UK.OBIE.Weekly", "UK.OBIE.Yearly" ] }, "OBExternalStatementInterestRateType1Code": { "description": "Description that may be available for the statement Interest rate type.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.BOEBaseRate", "UK.OBIE.FixedRate", "UK.OBIE.Gross", "UK.OBIE.LoanProviderBaseRate", "UK.OBIE.Net" ] }, "OBExternalStatementInterestType1Code": { "description": "Interest amount type, in a coded form.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.BalanceTransfer", "UK.OBIE.Cash", "UK.OBIE.EstimatedNext", "UK.OBIE.Purchase", "UK.OBIE.Total" ] }, "OBExternalStatementRateType1Code": { "description": "Rate associated with the statement rate type.", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "OBExternalStatementType1Code": { "description": "Statement type, in a coded form.", "type": "string", "enum": [ "AccountClosure", "AccountOpening", "Annual", "Interim", "RegularPeriodic" ] }, "OBExternalStatementValueType1Code": { "description": "Value associated with the statement value type.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.AirMilesPoints", "UK.OBIE.AirMilesPointsBalance", "UK.OBIE.Credits", "UK.OBIE.Debits", "UK.OBIE.HotelPoints", "UK.OBIE.HotelPointsBalance", "UK.OBIE.RetailShoppingPoints", "UK.OBIE.RetailShoppingPointsBalance" ] }, "OBMerchantDetails1": { "type": "object", "description": "Details of the merchant involved in the transaction.", "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 } } }, "OBParty2": { "type": "object", "required": [ "PartyId" ], "properties": { "PartyId": { "$ref": "#/definitions/PartyId" }, "PartyNumber": { "$ref": "#/definitions/PartyNumber" }, "PartyType": { "$ref": "#/definitions/OBExternalPartyType1Code" }, "Name": { "$ref": "#/definitions/Name_1" }, "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" }, "Address": { "type": "array", "items": { "type": "object", "description": "Postal address of a party.", "required": [ "Country" ], "properties": { "AddressType": { "$ref": "#/definitions/OBAddressTypeCode" }, "AddressLine": { "type": "array", "items": { "description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.", "type": "string", "minLength": 1, "maxLength": 70 }, "minItems": 0, "maxItems": 5 }, "StreetName": { "$ref": "#/definitions/StreetName" }, "BuildingNumber": { "$ref": "#/definitions/BuildingNumber" }, "PostCode": { "$ref": "#/definitions/PostCode" }, "TownName": { "$ref": "#/definitions/TownName" }, "CountrySubDivision": { "$ref": "#/definitions/CountrySubDivision" }, "Country": { "$ref": "#/definitions/CountryCode" } } } } } }, "OBPartyRelationships1": { "type": "object", "description": "The Party's relationships with other resources.", "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 } } } } }, "OBPostalAddress6": { "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.", "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": { "$ref": "#/definitions/StreetName" }, "BuildingNumber": { "$ref": "#/definitions/BuildingNumber" }, "PostCode": { "$ref": "#/definitions/PostCode" }, "TownName": { "$ref": "#/definitions/TownName" }, "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": { "type": "array", "items": { "description": "Information that locates and identifies a specific address, as defined by postal services, presented in free format text.", "type": "string", "minLength": 1, "maxLength": 70 }, "minItems": 0, "maxItems": 7 } } }, "OBRate1_0": { "description": "Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount)", "type": "number" }, "OBRate1_1": { "description": "field representing a percentage (e.g. 0.05 represents 5% and 0.9525 represents 95.25%). Note the number of decimal places may vary.", "type": "number" }, "OBReadAccount3": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "Account": { "type": "array", "items": { "$ref": "#/definitions/OBAccount3" } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadAccount4": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "Account": { "type": "array", "items": { "$ref": "#/definitions/OBAccount4" } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadBalance1": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "required": [ "Balance" ], "properties": { "Balance": { "type": "array", "items": { "type": "object", "description": "Set of elements used to define the balance details.", "required": [ "AccountId", "CreditDebitIndicator", "Type", "DateTime", "Amount" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_2" }, "Type": { "$ref": "#/definitions/OBBalanceType1Code" }, "DateTime": { "description": "Indicates the date (and time) of the balance.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" }, "Amount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Amount of money of the cash balance.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "CreditLine": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details on the credit line.", "required": [ "Included" ], "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": { "description": "Limit type, in a coded form.", "type": "string", "enum": [ "Available", "Credit", "Emergency", "Pre-Agreed", "Temporary" ] }, "Amount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Amount of money of the credit line.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } } } } } } }, "minItems": 1 } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadBeneficiary3": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "Beneficiary": { "type": "array", "items": { "$ref": "#/definitions/OBBeneficiary3" } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadConsent1": { "type": "object", "required": [ "Data", "Risk" ], "properties": { "Data": { "type": "object", "required": [ "Permissions" ], "properties": { "Permissions": { "type": "array", "items": { "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.", "type": "string", "enum": [ "ReadAccountsBasic", "ReadAccountsDetail", "ReadBalances", "ReadBeneficiariesBasic", "ReadBeneficiariesDetail", "ReadDirectDebits", "ReadOffers", "ReadPAN", "ReadParty", "ReadPartyPSU", "ReadProducts", "ReadScheduledPaymentsBasic", "ReadScheduledPaymentsDetail", "ReadStandingOrdersBasic", "ReadStandingOrdersDetail", "ReadStatementsBasic", "ReadStatementsDetail", "ReadTransactionsBasic", "ReadTransactionsCredits", "ReadTransactionsDebits", "ReadTransactionsDetail" ] }, "minItems": 1 }, "ExpirationDateTime": { "description": "Specified date and time the permissions will expire.\nIf this is not populated, the permissions will be open ended.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" }, "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.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" }, "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.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" } } }, "Risk": { "$ref": "#/definitions/OBRisk2" } } }, "OBReadConsentResponse1": { "type": "object", "required": [ "Data", "Risk" ], "properties": { "Data": { "type": "object", "required": [ "ConsentId", "CreationDateTime", "Status", "StatusUpdateDateTime", "Permissions" ], "properties": { "ConsentId": { "description": "Unique identification as assigned to identify the account access consent resource.", "type": "string", "minLength": 1, "maxLength": 128 }, "CreationDateTime": { "$ref": "#/definitions/CreationDateTime" }, "Status": { "description": "Specifies the status of consent resource in code form.", "type": "string", "enum": [ "Authorised", "AwaitingAuthorisation", "Rejected", "Revoked" ] }, "StatusUpdateDateTime": { "$ref": "#/definitions/StatusUpdateDateTime" }, "Permissions": { "type": "array", "items": { "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.", "type": "string", "enum": [ "ReadAccountsBasic", "ReadAccountsDetail", "ReadBalances", "ReadBeneficiariesBasic", "ReadBeneficiariesDetail", "ReadDirectDebits", "ReadOffers", "ReadPAN", "ReadParty", "ReadPartyPSU", "ReadProducts", "ReadScheduledPaymentsBasic", "ReadScheduledPaymentsDetail", "ReadStandingOrdersBasic", "ReadStandingOrdersDetail", "ReadStatementsBasic", "ReadStatementsDetail", "ReadTransactionsBasic", "ReadTransactionsCredits", "ReadTransactionsDebits", "ReadTransactionsDetail" ] }, "minItems": 1 }, "ExpirationDateTime": { "description": "Specified date and time the permissions will expire.\nIf this is not populated, the permissions will be open ended.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" }, "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.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" }, "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.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" } } }, "Risk": { "$ref": "#/definitions/OBRisk2" }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadDataStatement2": { "type": "object", "properties": { "Statement": { "type": "array", "items": { "$ref": "#/definitions/OBStatement2" } } } }, "OBReadDataTransaction5": { "type": "object", "properties": { "Transaction": { "type": "array", "items": { "$ref": "#/definitions/OBTransaction5" } } } }, "OBReadDirectDebit1": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "DirectDebit": { "type": "array", "items": { "type": "object", "description": "Account to or from which a cash entry is made.", "required": [ "AccountId", "MandateIdentification", "Name" ], "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": { "description": "Specifies the status of the direct debit in code form.", "type": "string", "enum": [ "Active", "Inactive" ] }, "Name": { "description": "Name of Service User.", "type": "string", "minLength": 1, "maxLength": 70 }, "PreviousPaymentDateTime": { "description": "Date of most recent direct debit collection.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" }, "PreviousPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the most recent direct debit collection.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } } } } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadOffer1": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "Offer": { "type": "array", "items": { "type": "object", "required": [ "AccountId" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "OfferId": { "description": "A unique and immutable identifier used to identify the offer resource. This identifier has no meaning to the account owner.", "type": "string", "minLength": 1, "maxLength": 40 }, "OfferType": { "description": "Offer type, in a coded form.", "type": "string", "enum": [ "BalanceTransfer", "LimitIncrease", "MoneyTransfer", "Other", "PromotionalRate" ] }, "Description": { "description": "Further details of the offer.", "type": "string", "minLength": 1, "maxLength": 500 }, "StartDateTime": { "description": "Date and time at which the offer starts.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" }, "EndDateTime": { "description": "Date and time at which the offer ends.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" }, "Rate": { "description": "Rate associated with the offer type.", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "Value": { "description": "Value associated with the offer type.", "type": "integer" }, "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": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Amount of money associated with the offer type.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } }, "Fee": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Fee associated with the offer type.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } } } } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadParty1": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "Party": { "type": "object", "required": [ "PartyId" ], "properties": { "PartyId": { "$ref": "#/definitions/PartyId" }, "PartyNumber": { "$ref": "#/definitions/PartyNumber" }, "PartyType": { "$ref": "#/definitions/OBExternalPartyType1Code" }, "Name": { "$ref": "#/definitions/Name_1" }, "EmailAddress": { "$ref": "#/definitions/EmailAddress" }, "Phone": { "$ref": "#/definitions/PhoneNumber_0" }, "Mobile": { "$ref": "#/definitions/PhoneNumber_1" }, "Address": { "type": "array", "items": { "type": "object", "description": "Postal address of a party.", "required": [ "Country" ], "properties": { "AddressType": { "$ref": "#/definitions/OBAddressTypeCode" }, "AddressLine": { "type": "array", "items": { "description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.", "type": "string", "minLength": 1, "maxLength": 70 }, "minItems": 0, "maxItems": 5 }, "StreetName": { "$ref": "#/definitions/StreetName" }, "BuildingNumber": { "$ref": "#/definitions/BuildingNumber" }, "PostCode": { "$ref": "#/definitions/PostCode" }, "TownName": { "$ref": "#/definitions/TownName" }, "CountrySubDivision": { "$ref": "#/definitions/CountrySubDivision" }, "Country": { "$ref": "#/definitions/CountryCode" } } } } } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadParty2": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "Party": { "$ref": "#/definitions/OBParty2" } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "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" } } }, "OBReadProduct2": { "type": "object", "required": [ "Data" ], "description": "Product details of Other Product which is not avaiable in the standard list", "properties": { "Data": { "type": "object", "description": "Aligning with the read write specs structure.", "properties": { "Product": { "type": "array", "items": { "type": "object", "description": "Product details associated with the Account", "required": [ "AccountId", "ProductType" ], "properties": { "ProductName": { "description": "The name of the Product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.", "type": "string", "minLength": 1, "maxLength": 350 }, "ProductId": { "description": "The unique ID that has been internally assigned by the financial institution to each of the current account banking products they market to their retail and/or small to medium enterprise (SME) customers.", "type": "string", "minLength": 1, "maxLength": 40 }, "AccountId": { "description": "Account Identification of the customer for Product Details", "type": "string", "minLength": 1, "maxLength": 40 }, "SecondaryProductId": { "description": "Any secondary Identification which supports Product Identifier to uniquely identify the current account banking products.", "type": "string", "minLength": 1, "maxLength": 70 }, "ProductType": { "description": "Product type : Personal Current Account, Business Current Account", "type": "string", "enum": [ "BusinessCurrentAccount", "CommercialCreditCard", "Other", "PersonalCurrentAccount", "SMELoan" ] }, "MarketingStateId": { "description": "Unique and unambiguous identification of a Product Marketing State.", "type": "string", "minLength": 1, "maxLength": 35 }, "OtherProductType": { "type": "object", "required": [ "Name", "Description" ], "description": "Other product type details associated with the account.", "properties": { "Name": { "description": "Long name associated with the product", "type": "string", "minLength": 1, "maxLength": 350 }, "Description": { "description": "Description of the Product associated with the account", "type": "string", "minLength": 1, "maxLength": 350 }, "ProductDetails": { "type": "object", "properties": { "Segment": { "type": "array", "items": { "description": "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd ", "type": "string", "enum": [ "GEAS", "GEBA", "GEBR", "GEBU", "GECI", "GECS", "GEFB", "GEFG", "GEG", "GEGR", "GEGS", "GEOT", "GEOV", "GEPA", "GEPR", "GERE", "GEST", "GEYA", "GEYO", "PSCA", "PSES", "PSNC", "PSNP", "PSRG", "PSSS", "PSST", "PSSW" ] } }, "FeeFreeLength": { "description": "The length/duration of the fee free period", "type": "integer" }, "FeeFreeLengthPeriod": { "description": "The unit of period (days, weeks, months etc.) of the promotional length", "type": "string", "enum": [ "PACT", "PDAY", "PHYR", "PMTH", "PQTR", "PWEK", "PYER" ] }, "MonthlyMaximumCharge": { "description": "The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the Core product details", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherSegment": { "$ref": "#/definitions/OB_OtherCodeType1_0" } } }, "CreditInterest": { "type": "object", "required": [ "TierBandSet" ], "description": "Details about the interest that may be payable to the Account holders", "properties": { "TierBandSet": { "type": "array", "items": { "type": "object", "description": "The group of tiers or bands for which credit interest can be applied.", "required": [ "TierBandMethod", "Destination", "TierBand" ], "properties": { "TierBandMethod": { "description": "The methodology of how credit interest is paid/applied. It can be:-\n1. Banded\nInterest rates are banded. i.e. Increasing rate on whole balance as balance increases.\n2. Tiered\nInterest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.\n3. Whole\nThe same interest rate is applied irrespective of the product holder's account balance", "type": "string", "enum": [ "INBA", "INTI", "INWH" ] }, "CalculationMethod": { "$ref": "#/definitions/OB_InterestCalculationMethod1Code" }, "Destination": { "description": "Describes whether accrued interest is payable only to the BCA or to another bank account", "type": "string", "enum": [ "INOT", "INPA", "INSC" ] }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the Tier Band Set details", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherCalculationMethod": { "$ref": "#/definitions/OB_OtherCodeType1_0" }, "OtherDestination": { "$ref": "#/definitions/OB_OtherCodeType1_0" }, "TierBand": { "type": "array", "items": { "type": "object", "description": "Tier Band Details", "required": [ "TierValueMinimum", "ApplicationFrequency", "FixedVariableInterestRateType", "AER" ], "properties": { "Identification": { "description": "Unique and unambiguous identification of a Tier Band for the Product.", "type": "string", "minLength": 1, "maxLength": 35 }, "TierValueMinimum": { "description": "Minimum deposit value for which the credit interest tier applies.", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "TierValueMaximum": { "description": "Maximum deposit value for which the credit interest tier applies.", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "CalculationFrequency": { "description": "How often is credit interest calculated for the account.", "type": "string", "enum": [ "FQAT", "FQDY", "FQHY", "FQMY", "FQOT", "FQQY", "FQSD", "FQWY", "FQYY" ] }, "ApplicationFrequency": { "description": "How often is interest applied to the Product for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's account.", "type": "string", "enum": [ "FQAT", "FQDY", "FQHY", "FQMY", "FQOT", "FQQY", "FQSD", "FQWY", "FQYY" ] }, "DepositInterestAppliedCoverage": { "description": "Amount on which Interest applied.", "type": "string", "enum": [ "INBA", "INTI", "INWH" ] }, "FixedVariableInterestRateType": { "$ref": "#/definitions/OB_InterestFixedVariableType1Code" }, "AER": { "description": "The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. \nRead more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A", "type": "string", "pattern": "^(-?\\\\d{1,3}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "BankInterestRateType": { "description": "Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the account holder's account.", "type": "string", "enum": [ "INBB", "INFR", "INGR", "INLR", "INNE", "INOT" ] }, "BankInterestRate": { "description": "Bank Interest for the product", "type": "string", "pattern": "^(-?\\\\d{1,3}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the Tier Band details", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherBankInterestType": { "type": "object", "required": [ "Name", "Description" ], "description": "Other interest rate types which are not available in the standard code list", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OtherApplicationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_1" }, "OtherCalculationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_2" } } }, "minItems": 1 } } }, "minItems": 1 } } }, "Overdraft": { "type": "object", "required": [ "OverdraftTierBandSet" ], "description": "Borrowing details", "properties": { "Notes": { "type": "array", "items": { "description": "Associated Notes about the overdraft rates", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftTierBandSet": { "type": "array", "items": { "type": "object", "description": "Tier band set details", "required": [ "TierBandMethod", "OverdraftTierBand" ], "properties": { "TierBandMethod": { "description": "The methodology of how overdraft is charged. It can be:\n'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). \n'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation\n'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.", "type": "string", "enum": [ "INBA", "INTI", "INWH" ] }, "OverdraftType": { "description": "An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.", "type": "string", "enum": [ "OVCO", "OVOD", "OVOT" ] }, "Identification": { "description": "Unique and unambiguous identification of a Tier Band for a overdraft product.", "type": "string", "minLength": 1, "maxLength": 35 }, "AuthorisedIndicator": { "description": "Indicates if the Overdraft is authorised (Y) or unauthorised (N)", "type": "boolean" }, "BufferAmount": { "description": "When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the overdraft Tier Band Set details", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftTierBand": { "type": "array", "items": { "type": "object", "description": "Provides overdraft details for a specific tier or band", "required": [ "TierValueMin" ], "properties": { "Identification": { "description": "Unique and unambiguous identification of a Tier Band for a overdraft.", "type": "string", "minLength": 1, "maxLength": 35 }, "TierValueMin": { "description": "Minimum value of Overdraft Tier/Band", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "TierValueMax": { "description": "Maximum value of Overdraft Tier/Band", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "EAR": { "description": "EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently\nused interchangeably), being the actual annual interest rate of an Overdraft.", "type": "string", "pattern": "^(-?\\\\d{1,3}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "AgreementLengthMin": { "description": "Specifies the minimum length of a band for a fixed overdraft agreement", "type": "integer" }, "AgreementLengthMax": { "description": "Specifies the maximum length of a band for a fixed overdraft agreement", "type": "integer" }, "AgreementPeriod": { "description": "Specifies the period of a fixed length overdraft agreement", "type": "string", "enum": [ "PACT", "PDAY", "PHYR", "PMTH", "PQTR", "PWEK", "PYER" ] }, "OverdraftInterestChargingCoverage": { "description": "Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is �2k and the interest tiers are:- 0-�500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%*500)+(0.2%*500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the �Whole� of the account balance, and in the 2nd that it is �Tiered�.", "type": "string", "enum": [ "INBA", "INTI", "INWH" ] }, "BankGuaranteedIndicator": { "description": "Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it�s part of a government scheme, or whether the rate may vary dependent on the applicant�s circumstances.", "type": "boolean" }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the Tier/band details", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftFeesCharges": { "type": "array", "items": { "type": "object", "description": "Overdraft fees and charges", "required": [ "OverdraftFeeChargeDetail" ], "properties": { "OverdraftFeeChargeCap": { "type": "array", "items": { "type": "object", "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "required": [ "FeeType", "MinMaxType" ], "properties": { "FeeType": { "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "FBAO", "FBAR", "FBEB", "FBIT", "FBOR", "FBOS", "FBSC", "FBTO", "FBUB", "FBUT", "FTOT", "FTUT" ] }, "minItems": 1 }, "MinMaxType": { "$ref": "#/definitions/OB_MinMaxType1Code" }, "FeeCapOccurrence": { "$ref": "#/definitions/Number_0" }, "FeeCapAmount": { "$ref": "#/definitions/OB_Amount1_0" }, "CappingPeriod": { "$ref": "#/definitions/OB_Period1Code" }, "Notes": { "type": "array", "items": { "description": "Notes related to Overdraft fee charge cap", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "type": "array", "items": { "type": "object", "description": "Other fee type code which is not available in the standard code set", "required": [ "Name", "Description" ], "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } } } } } }, "OverdraftFeeChargeDetail": { "type": "array", "items": { "type": "object", "description": "Details about the fees/charges", "required": [ "FeeType", "ApplicationFrequency" ], "properties": { "FeeType": { "$ref": "#/definitions/OB_OverdraftFeeType1Code" }, "NegotiableIndicator": { "description": "Indicates whether fee and charges are negotiable", "type": "boolean" }, "OverdraftControlIndicator": { "description": "Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.", "type": "boolean" }, "IncrementalBorrowingAmount": { "$ref": "#/definitions/OB_Amount1_1" }, "FeeAmount": { "$ref": "#/definitions/OB_Amount1_2" }, "FeeRate": { "$ref": "#/definitions/OB_Rate1_0" }, "FeeRateType": { "$ref": "#/definitions/OB_InterestRateType1Code_0" }, "ApplicationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_0" }, "CalculationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_1" }, "Notes": { "type": "array", "items": { "description": "Free text for capturing any other info related to Overdraft Fees Charge Details", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftFeeChargeCap": { "type": "array", "items": { "type": "object", "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "required": [ "FeeType", "MinMaxType" ], "properties": { "FeeType": { "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "FBAO", "FBAR", "FBEB", "FBIT", "FBOR", "FBOS", "FBSC", "FBTO", "FBUB", "FBUT", "FTOT", "FTUT" ] }, "minItems": 1 }, "MinMaxType": { "$ref": "#/definitions/OB_MinMaxType1Code" }, "FeeCapOccurrence": { "$ref": "#/definitions/Number_0" }, "FeeCapAmount": { "$ref": "#/definitions/OB_Amount1_0" }, "CappingPeriod": { "$ref": "#/definitions/OB_Period1Code" }, "Notes": { "type": "array", "items": { "description": "Notes related to Overdraft fee charge cap", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "type": "array", "items": { "type": "object", "description": "Other fee type code which is not available in the standard code set", "required": [ "Name", "Description" ], "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } } } } } }, "OtherFeeType": { "$ref": "#/definitions/OB_OtherCodeType1_3" }, "OtherFeeRateType": { "$ref": "#/definitions/OB_OtherCodeType1_4" }, "OtherApplicationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_1" }, "OtherCalculationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_2" } } }, "minItems": 1 } } } } } }, "minItems": 1 }, "OverdraftFeesCharges": { "type": "array", "items": { "type": "object", "description": "Overdraft fees and charges details", "required": [ "OverdraftFeeChargeDetail" ], "properties": { "OverdraftFeeChargeCap": { "type": "array", "items": { "type": "object", "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "required": [ "FeeType", "MinMaxType" ], "properties": { "FeeType": { "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "FBAO", "FBAR", "FBEB", "FBIT", "FBOR", "FBOS", "FBSC", "FBTO", "FBUB", "FBUT", "FTOT", "FTUT" ] }, "minItems": 1 }, "MinMaxType": { "$ref": "#/definitions/OB_MinMaxType1Code" }, "FeeCapOccurrence": { "$ref": "#/definitions/Number_0" }, "FeeCapAmount": { "$ref": "#/definitions/OB_Amount1_0" }, "CappingPeriod": { "$ref": "#/definitions/OB_Period1Code" }, "Notes": { "type": "array", "items": { "description": "Notes related to Overdraft fee charge cap", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "type": "array", "items": { "type": "object", "description": "Other fee type code which is not available in the standard code set", "required": [ "Name", "Description" ], "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } } } } } }, "OverdraftFeeChargeDetail": { "type": "array", "items": { "type": "object", "description": "Details about the fees/charges", "required": [ "FeeType", "ApplicationFrequency" ], "properties": { "FeeType": { "$ref": "#/definitions/OB_OverdraftFeeType1Code" }, "NegotiableIndicator": { "description": "Indicates whether fee and charges are negotiable", "type": "boolean" }, "OverdraftControlIndicator": { "description": "Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.", "type": "boolean" }, "IncrementalBorrowingAmount": { "$ref": "#/definitions/OB_Amount1_1" }, "FeeAmount": { "$ref": "#/definitions/OB_Amount1_2" }, "FeeRate": { "$ref": "#/definitions/OB_Rate1_0" }, "FeeRateType": { "$ref": "#/definitions/OB_InterestRateType1Code_0" }, "ApplicationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_0" }, "CalculationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_1" }, "Notes": { "type": "array", "items": { "description": "Free text for capturing any other info related to Overdraft Fees Charge Details", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftFeeChargeCap": { "type": "array", "items": { "type": "object", "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "required": [ "FeeType", "MinMaxType" ], "properties": { "FeeType": { "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "FBAO", "FBAR", "FBEB", "FBIT", "FBOR", "FBOS", "FBSC", "FBTO", "FBUB", "FBUT", "FTOT", "FTUT" ] }, "minItems": 1 }, "MinMaxType": { "$ref": "#/definitions/OB_MinMaxType1Code" }, "FeeCapOccurrence": { "$ref": "#/definitions/Number_0" }, "FeeCapAmount": { "$ref": "#/definitions/OB_Amount1_0" }, "CappingPeriod": { "$ref": "#/definitions/OB_Period1Code" }, "Notes": { "type": "array", "items": { "description": "Notes related to Overdraft fee charge cap", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "type": "array", "items": { "type": "object", "description": "Other fee type code which is not available in the standard code set", "required": [ "Name", "Description" ], "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } } } } } }, "OtherFeeType": { "$ref": "#/definitions/OB_OtherCodeType1_3" }, "OtherFeeRateType": { "$ref": "#/definitions/OB_OtherCodeType1_4" }, "OtherApplicationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_1" }, "OtherCalculationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_2" } } }, "minItems": 1 } } } } } }, "minItems": 1 } } }, "LoanInterest": { "type": "object", "required": [ "LoanInterestTierBandSet" ], "description": "Details about the interest that may be payable to the SME Loan holders", "properties": { "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the LoanInterest", "type": "string", "minLength": 1, "maxLength": 2000 } }, "LoanInterestTierBandSet": { "type": "array", "items": { "type": "object", "description": "The group of tiers or bands for which debit interest can be applied.", "required": [ "TierBandMethod", "CalculationMethod", "LoanInterestTierBand" ], "properties": { "TierBandMethod": { "description": "The methodology of how credit interest is charged. It can be:-\n1. Banded\nInterest rates are banded. i.e. Increasing rate on whole balance as balance increases.\n2. Tiered\nInterest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.\n3. Whole\nThe same interest rate is applied irrespective of the SME Loan balance", "type": "string", "enum": [ "INBA", "INTI", "INWH" ] }, "Identification": { "description": "Loan interest tierbandset identification. Used by loan providers for internal use purpose.", "type": "string", "minLength": 1, "maxLength": 35 }, "CalculationMethod": { "$ref": "#/definitions/OB_InterestCalculationMethod1Code" }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the Tier Band Set details", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherCalculationMethod": { "$ref": "#/definitions/OB_OtherCodeType1_0" }, "LoanInterestTierBand": { "type": "array", "items": { "type": "object", "description": "Tier Band Details", "required": [ "TierValueMinimum", "TierValueMinTerm", "MinTermPeriod", "FixedVariableInterestRateType", "RepAPR" ], "properties": { "Identification": { "description": "Unique and unambiguous identification of a Tier Band for a SME Loan.", "type": "string", "minLength": 1, "maxLength": 35 }, "TierValueMinimum": { "description": "Minimum loan value for which the loan interest tier applies.", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "TierValueMaximum": { "description": "Maximum loan value for which the loan interest tier applies.", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "TierValueMinTerm": { "description": "Minimum loan term for which the loan interest tier applies.", "type": "integer" }, "MinTermPeriod": { "description": "The unit of period (days, weeks, months etc.) of the Minimum Term", "type": "string", "enum": [ "PACT", "PDAY", "PHYR", "PMTH", "PQTR", "PWEK", "PYER" ] }, "TierValueMaxTerm": { "description": "Maximum loan term for which the loan interest tier applies.", "type": "integer" }, "MaxTermPeriod": { "description": "The unit of period (days, weeks, months etc.) of the Maximum Term", "type": "string", "enum": [ "PACT", "PDAY", "PHYR", "PMTH", "PQTR", "PWEK", "PYER" ] }, "FixedVariableInterestRateType": { "$ref": "#/definitions/OB_InterestFixedVariableType1Code" }, "RepAPR": { "description": "The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. \nFor SME Loan, this APR is the representative APR which includes any account fees.", "type": "string", "pattern": "^(-?\\\\d{1,3}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "LoanProviderInterestRateType": { "description": "Interest rate types, other than APR, which financial institutions may use to describe the annual interest rate payable for the SME Loan.", "type": "string", "enum": [ "INBB", "INFR", "INGR", "INLR", "INNE", "INOT" ] }, "LoanProviderInterestRate": { "description": "Loan provider Interest for the SME Loan product", "type": "string", "pattern": "^(-?\\\\d{1,3}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the Tier Band details", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherLoanProviderInterestRateType": { "type": "object", "required": [ "Name", "Description" ], "description": "Other loan interest rate types which are not available in the standard code list", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "LoanInterestFeesCharges": { "type": "array", "items": { "type": "object", "description": "Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits", "required": [ "LoanInterestFeeChargeDetail" ], "properties": { "LoanInterestFeeChargeDetail": { "type": "array", "items": { "type": "object", "description": "Other fees/charges details", "required": [ "FeeType", "ApplicationFrequency", "CalculationFrequency" ], "properties": { "FeeType": { "$ref": "#/definitions/OB_FeeType1Code" }, "NegotiableIndicator": { "description": "Fee/charge which is usually negotiable rather than a fixed amount", "type": "boolean" }, "FeeAmount": { "$ref": "#/definitions/OB_Amount1_3" }, "FeeRate": { "$ref": "#/definitions/OB_Rate1_1" }, "FeeRateType": { "$ref": "#/definitions/OB_InterestRateType1Code_1" }, "ApplicationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_2" }, "CalculationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_3" }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the fee/charge details.", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "$ref": "#/definitions/OB_OtherFeeChargeDetailType" }, "OtherFeeRateType": { "$ref": "#/definitions/OB_OtherCodeType1_5" }, "OtherApplicationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_6" }, "OtherCalculationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_7" } } }, "minItems": 1 }, "LoanInterestFeeChargeCap": { "type": "array", "items": { "type": "object", "description": "Details about any caps (minimum/maximum charges) that apply to a particular fee/charge", "required": [ "FeeType", "MinMaxType" ], "properties": { "FeeType": { "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "FEPF", "FTOT", "FYAF", "FYAM", "FYAQ", "FYCP", "FYDB", "FYMI", "FYXX" ] }, "minItems": 1 }, "MinMaxType": { "$ref": "#/definitions/OB_MinMaxType1Code" }, "FeeCapOccurrence": { "$ref": "#/definitions/Number_1" }, "FeeCapAmount": { "$ref": "#/definitions/OB_Amount1_4" }, "CappingPeriod": { "$ref": "#/definitions/OB_FeeFrequency1Code_4" }, "Notes": { "type": "array", "items": { "description": "Free text for adding extra details for fee charge cap", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "type": "array", "items": { "type": "object", "description": "Other fee type code which is not available in the standard code set", "required": [ "Name", "Description" ], "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } } } } } } } } } } }, "minItems": 1 }, "LoanInterestFeesCharges": { "type": "array", "items": { "type": "object", "description": "Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits", "required": [ "LoanInterestFeeChargeDetail" ], "properties": { "LoanInterestFeeChargeDetail": { "type": "array", "items": { "type": "object", "description": "Other fees/charges details", "required": [ "FeeType", "ApplicationFrequency", "CalculationFrequency" ], "properties": { "FeeType": { "$ref": "#/definitions/OB_FeeType1Code" }, "NegotiableIndicator": { "description": "Fee/charge which is usually negotiable rather than a fixed amount", "type": "boolean" }, "FeeAmount": { "$ref": "#/definitions/OB_Amount1_3" }, "FeeRate": { "$ref": "#/definitions/OB_Rate1_1" }, "FeeRateType": { "$ref": "#/definitions/OB_InterestRateType1Code_1" }, "ApplicationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_2" }, "CalculationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_3" }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the fee/charge details.", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "$ref": "#/definitions/OB_OtherFeeChargeDetailType" }, "OtherFeeRateType": { "$ref": "#/definitions/OB_OtherCodeType1_5" }, "OtherApplicationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_6" }, "OtherCalculationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_7" } } }, "minItems": 1 }, "LoanInterestFeeChargeCap": { "type": "array", "items": { "type": "object", "description": "Details about any caps (minimum/maximum charges) that apply to a particular fee/charge", "required": [ "FeeType", "MinMaxType" ], "properties": { "FeeType": { "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "FEPF", "FTOT", "FYAF", "FYAM", "FYAQ", "FYCP", "FYDB", "FYMI", "FYXX" ] }, "minItems": 1 }, "MinMaxType": { "$ref": "#/definitions/OB_MinMaxType1Code" }, "FeeCapOccurrence": { "$ref": "#/definitions/Number_1" }, "FeeCapAmount": { "$ref": "#/definitions/OB_Amount1_4" }, "CappingPeriod": { "$ref": "#/definitions/OB_FeeFrequency1Code_4" }, "Notes": { "type": "array", "items": { "description": "Free text for adding extra details for fee charge cap", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "type": "array", "items": { "type": "object", "description": "Other fee type code which is not available in the standard code set", "required": [ "Name", "Description" ], "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } } } } } } } } } } }, "minItems": 1 } } }, "Repayment": { "type": "object", "description": "Repayment details of the Loan product", "properties": { "RepaymentType": { "description": "Repayment type", "type": "string", "enum": [ "USBA", "USBU", "USCI", "USCS", "USER", "USFA", "USFB", "USFI", "USIO", "USOT", "USPF", "USRW", "USSL" ] }, "RepaymentFrequency": { "description": "Repayment frequency", "type": "string", "enum": [ "SMDA", "SMFL", "SMFO", "SMHY", "SMMO", "SMOT", "SMQU", "SMWE", "SMYE" ] }, "AmountType": { "description": "The repayment is for paying just the interest only or both interest and capital or bullet amount or balance to date etc", "type": "string", "enum": [ "RABD", "RABL", "RACI", "RAFC", "RAIO", "RALT", "USOT" ] }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the Repayment", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherRepaymentType": { "type": "object", "required": [ "Name", "Description" ], "description": "Other repayment type which is not in the standard code list", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OtherRepaymentFrequency": { "type": "object", "required": [ "Name", "Description" ], "description": "Other repayment frequency which is not in the standard code list", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OtherAmountType": { "type": "object", "required": [ "Name", "Description" ], "description": "Other amount type which is not in the standard code list", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "RepaymentFeeCharges": { "type": "object", "required": [ "RepaymentFeeChargeDetail" ], "description": "Applicable fee/charges for repayment such as prepayment, full early repayment or non repayment.", "properties": { "RepaymentFeeChargeDetail": { "type": "array", "items": { "type": "object", "description": "Details about specific fees/charges that are applied for repayment", "required": [ "FeeType", "ApplicationFrequency", "CalculationFrequency" ], "properties": { "FeeType": { "$ref": "#/definitions/OB_FeeType1Code" }, "NegotiableIndicator": { "description": "Fee/charge which is usually negotiable rather than a fixed amount", "type": "boolean" }, "FeeAmount": { "$ref": "#/definitions/OB_Amount1_3" }, "FeeRate": { "$ref": "#/definitions/OB_Rate1_1" }, "FeeRateType": { "$ref": "#/definitions/OB_InterestRateType1Code_1" }, "ApplicationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_2" }, "CalculationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_3" }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the fee/charge details.", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "$ref": "#/definitions/OB_OtherFeeChargeDetailType" }, "OtherFeeRateType": { "$ref": "#/definitions/OB_OtherCodeType1_8" }, "OtherApplicationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_6" }, "OtherCalculationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_7" } } }, "minItems": 1 }, "RepaymentFeeChargeCap": { "type": "array", "items": { "type": "object", "description": "RepaymentFeeChargeCap sets daily, weekly, monthly, yearly limits on the fees that are charged", "required": [ "FeeType", "MinMaxType" ], "properties": { "FeeType": { "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "FEPF", "FTOT", "FYAF", "FYAM", "FYAQ", "FYCP", "FYDB", "FYMI", "FYXX" ] }, "minItems": 1 }, "MinMaxType": { "$ref": "#/definitions/OB_MinMaxType1Code" }, "FeeCapOccurrence": { "$ref": "#/definitions/Number_1" }, "FeeCapAmount": { "$ref": "#/definitions/OB_Amount1_4" }, "CappingPeriod": { "$ref": "#/definitions/OB_Period1Code" }, "Notes": { "type": "array", "items": { "description": "Free text for adding extra details for fee charge cap", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "type": "array", "items": { "type": "object", "description": "Other fee type code which is not available in the standard code set", "required": [ "Name", "Description" ], "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } } } } } } } }, "RepaymentHoliday": { "type": "array", "items": { "type": "object", "description": "Details of capital repayment holiday if any", "properties": { "MaxHolidayLength": { "description": "The maximum length/duration of a Repayment Holiday", "type": "integer" }, "MaxHolidayPeriod": { "description": "The unit of period (days, weeks, months etc.) of the repayment holiday", "type": "string", "enum": [ "PACT", "PDAY", "PHYR", "PMTH", "PQTR", "PWEK", "PYER" ] }, "Notes": { "type": "array", "items": { "description": "Free text for adding details for repayment holiday", "type": "string", "minLength": 1, "maxLength": 2000 } } } } } } }, "OtherFeesCharges": { "type": "array", "items": { "type": "object", "description": "Contains details of fees and charges which are not associated with either Overdraft or features/benefits", "required": [ "FeeChargeDetail" ], "properties": { "TariffType": { "description": "TariffType which defines the fee and charges.", "type": "string", "enum": [ "TTEL", "TTMX", "TTOT" ] }, "TariffName": { "description": "Name of the tariff", "type": "string", "minLength": 1, "maxLength": 350 }, "OtherTariffType": { "type": "object", "required": [ "Name", "Description" ], "description": "Other tariff type which is not in the standard list.", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "FeeChargeDetail": { "type": "array", "items": { "type": "object", "description": "Other fees/charges details", "required": [ "FeeCategory", "FeeType", "ApplicationFrequency" ], "properties": { "FeeCategory": { "$ref": "#/definitions/OB_FeeCategory1Code" }, "FeeType": { "$ref": "#/definitions/OB_FeeType1Code" }, "NegotiableIndicator": { "description": "Fee/charge which is usually negotiable rather than a fixed amount", "type": "boolean" }, "FeeAmount": { "$ref": "#/definitions/OB_Amount1_3" }, "FeeRate": { "$ref": "#/definitions/OB_Rate1_1" }, "FeeRateType": { "$ref": "#/definitions/OB_InterestRateType1Code_1" }, "ApplicationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_2" }, "CalculationFrequency": { "$ref": "#/definitions/OB_FeeFrequency1Code_3" }, "Notes": { "type": "array", "items": { "description": "Optional additional notes to supplement the fee/charge details.", "type": "string", "minLength": 1, "maxLength": 2000 } }, "FeeChargeCap": { "type": "array", "items": { "type": "object", "description": "Details about any caps (maximum charges) that apply to a particular or group of fee/charge", "required": [ "FeeType", "MinMaxType" ], "properties": { "FeeType": { "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "FEPF", "FTOT", "FYAF", "FYAM", "FYAQ", "FYCP", "FYDB", "FYMI", "FYXX" ] }, "minItems": 1 }, "MinMaxType": { "$ref": "#/definitions/OB_MinMaxType1Code" }, "FeeCapOccurrence": { "$ref": "#/definitions/Number_1" }, "FeeCapAmount": { "$ref": "#/definitions/OB_Amount1_4" }, "CappingPeriod": { "$ref": "#/definitions/OB_Period1Code" }, "Notes": { "type": "array", "items": { "description": "Free text for adding extra details for fee charge cap", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "type": "array", "items": { "type": "object", "description": "Other fee type code which is not available in the standard code set", "required": [ "Name", "Description" ], "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } } } } } }, "OtherFeeCategoryType": { "$ref": "#/definitions/OB_OtherCodeType1_0" }, "OtherFeeType": { "$ref": "#/definitions/OB_OtherFeeChargeDetailType" }, "OtherFeeRateType": { "$ref": "#/definitions/OB_OtherCodeType1_8" }, "OtherApplicationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_6" }, "OtherCalculationFrequency": { "$ref": "#/definitions/OB_OtherCodeType1_7" }, "FeeApplicableRange": { "type": "object", "description": "Range or amounts or rates for which the fee/charge applies", "properties": { "MinimumAmount": { "description": "Minimum Amount on which fee/charge is applicable (where it is expressed as an amount)", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "MaximumAmount": { "description": "Maximum Amount on which fee is applicable (where it is expressed as an amount)", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "MinimumRate": { "description": "Minimum rate on which fee/charge is applicable(where it is expressed as an rate)", "type": "string", "pattern": "^(-?\\\\d{1,3}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "MaximumRate": { "description": "Maximum rate on which fee/charge is applicable(where it is expressed as an rate)", "type": "string", "pattern": "^(-?\\\\d{1,3}){1}(\\\\.\\\\d{1,4}){0,1}$" } } } } }, "minItems": 1 }, "FeeChargeCap": { "type": "array", "items": { "type": "object", "description": "Details about any caps (maximum charges) that apply to a particular or group of fee/charge", "required": [ "FeeType", "MinMaxType" ], "properties": { "FeeType": { "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "FEPF", "FTOT", "FYAF", "FYAM", "FYAQ", "FYCP", "FYDB", "FYMI", "FYXX" ] }, "minItems": 1 }, "MinMaxType": { "$ref": "#/definitions/OB_MinMaxType1Code" }, "FeeCapOccurrence": { "$ref": "#/definitions/Number_1" }, "FeeCapAmount": { "$ref": "#/definitions/OB_Amount1_4" }, "CappingPeriod": { "$ref": "#/definitions/OB_Period1Code" }, "Notes": { "type": "array", "items": { "description": "Free text for adding extra details for fee charge cap", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "type": "array", "items": { "type": "object", "description": "Other fee type code which is not available in the standard code set", "required": [ "Name", "Description" ], "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } } } } } } } } }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "BCA": { "type": "object", "title": "BCA", "properties": { "ProductDetails": { "type": "object", "title": "ProductDetails", "properties": { "Segment": { "description": "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\n\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nWith respect to BCA products, they are segmented in relation to different markets that they wish to focus on. ", "title": "Segment", "type": "array", "items": { "description": "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\n\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nWith respect to BCA products, they are segmented in relation to different markets that they wish to focus on. ", "type": "string", "enum": [ "ClientAccount", "Standard", "NonCommercialChaitiesClbSoc", "NonCommercialPublicAuthGovt", "Religious", "SectorSpecific", "Startup", "Switcher" ] } }, "FeeFreeLength": { "description": "The length/duration of the fee free period", "title": "FeeFreeLength", "type": "number", "format": "float" }, "FeeFreeLengthPeriod": { "description": "The unit of period (days, weeks, months etc.) of the promotional length", "title": "FeeFreeLengthPeriod", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Optional additional notes to supplement the Core product details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } } }, "additionalProperties": false }, "CreditInterest": { "description": "Details about the interest that may be payable to the BCA account holders", "type": "object", "title": "CreditInterest", "properties": { "TierBandSet": { "description": "The group of tiers or bands for which credit interest can be applied.", "type": "array", "title": "TierBandSet", "items": { "description": "The group of tiers or bands for which credit interest can be applied.", "type": "object", "properties": { "TierBandMethod": { "description": "The methodology of how credit interest is paid/applied. It can be:-\n\n1. Banded\nInterest rates are banded. i.e. Increasing rate on whole balance as balance increases.\n\n2. Tiered\nInterest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.\n\n3. Whole\nThe same interest rate is applied irrespective of the BCA balance", "title": "TierBandMethod", "type": "string", "enum": [ "Banded", "Tiered", "Whole" ] }, "CalculationMethod": { "description": "Methods of calculating interest", "title": "CalculationMethod", "type": "string", "enum": [ "Compound", "SimpleInterest" ] }, "Destination": { "description": "Describes whether accrued interest is payable only to the BCA or to another bank account", "title": "Destination", "type": "string", "enum": [ "PayAway", "SelfCredit" ] }, "Notes": { "description": "Optional additional notes to supplement the Tier Band Set details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "TierBand": { "description": "Tier Band Details", "type": "array", "title": "TierBand", "items": { "description": "Tier Band Details", "type": "object", "properties": { "Identification": { "description": "Unique and unambiguous identification of a Tier Band for a BCA.", "title": "Identification", "type": "string", "minLength": 1, "maxLength": 35 }, "TierValueMinimum": { "description": "Minimum deposit value for which the credit interest tier applies.", "title": "TierValueMinimum", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "TierValueMaximum": { "description": "Maximum deposit value for which the credit interest tier applies.", "title": "TierValueMaximum", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CalculationFrequency": { "description": "How often is credit interest calculated for the account.", "title": "CalculationFrequency", "type": "string", "enum": [ "Daily", "HalfYearly", "Monthly", "Other", "Quarterly", "PerStatementDate", "Weekly", "Yearly" ] }, "ApplicationFrequency": { "description": "How often is interest applied to the BCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's BCA.", "title": "ApplicationFrequency", "type": "string", "enum": [ "Daily", "HalfYearly", "Monthly", "Other", "Quarterly", "PerStatementDate", "Weekly", "Yearly" ] }, "DepositInterestAppliedCoverage": { "description": "Amount on which Interest applied.", "title": "DepositInterestAppliedCoverage", "type": "string", "enum": [ "Banded", "Tiered", "Whole" ] }, "FixedVariableInterestRateType": { "description": "Type of interest rate, Fixed or Variable", "title": "FixedVariableInterestRateType", "type": "string", "enum": [ "Fixed", "Variable" ] }, "AER": { "description": "The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. \n\nRead more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A", "title": "AER", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "BankInterestRateType": { "description": "Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA.", "title": "BankInterestRateType", "type": "string", "enum": [ "Gross", "Other" ] }, "BankInterestRate": { "description": "Bank Interest for the BCA product", "title": "BankInterestRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "Notes": { "description": "Optional additional notes to supplement the Tier Band details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherBankInterestType": { "description": "Other interest rate types which are not available in the standard code list", "type": "object", "title": "OtherBankInterestType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherApplicationFrequency": { "description": "Other application frequencies that are not available in the standard code list", "type": "object", "title": "OtherApplicationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherCalculationFrequency": { "description": "Other calculation frequency which is not available in the standard code set.", "type": "object", "title": "OtherCalculationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] } }, "required": [ "TierValueMinimum", "ApplicationFrequency", "FixedVariableInterestRateType", "AER" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "TierBandMethod", "Destination", "TierBand" ] }, "additionalProperties": false, "minItems": 1 } }, "additionalProperties": false, "required": [ "TierBandSet" ] }, "Overdraft": { "description": "Borrowing details", "type": "object", "title": "Overdraft", "properties": { "Notes": { "description": "Associated Notes about the overdraft rates", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftTierBandSet": { "description": "Tier band set details", "type": "array", "title": "OverdraftTierBandSet", "items": { "description": "Tier band set details", "type": "object", "properties": { "TierBandMethod": { "description": "The methodology of how overdraft is charged. It can be:\n'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). \n'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation\n'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.", "title": "TierBandMethod", "type": "string", "enum": [ "Banded", "Tiered", "Whole" ] }, "OverdraftType": { "description": "An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.", "title": "OverdraftType", "type": "string", "enum": [ "Committed", "OnDemand" ] }, "Identification": { "description": "Unique and unambiguous identification of a Tier Band for a overdraft product.", "title": "Identification", "type": "string", "minLength": 1, "maxLength": 35 }, "AuthorisedIndicator": { "description": "Indicates if the Overdraft is authorised (Y) or unauthorised (N)", "title": "AuthorisedIndicator", "type": "boolean" }, "BufferAmount": { "description": "When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.", "title": "BufferAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Notes": { "description": "Optional additional notes to supplement the overdraft Tier Band Set details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftTierBand": { "description": "Provides overdraft details for a specific tier or band", "type": "array", "title": "OverdraftTierBand", "items": { "description": "Provides overdraft details for a specific tier or band", "type": "object", "properties": { "Identification": { "description": "Unique and unambiguous identification of a Tier Band for a overdraft.", "title": "Identification", "type": "string", "minLength": 1, "maxLength": 35 }, "TierValueMin": { "description": "Minimum value of Overdraft Tier/Band", "title": "TierValueMin", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "TierValueMax": { "description": "Maximum value of Overdraft Tier/Band", "title": "TierValueMax", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "EAR": { "description": "EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently\nused interchangeably), being the actual annual interest rate of an Overdraft.", "title": "EAR", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "AgreementLengthMin": { "description": "Specifies the minimum length of a band for a fixed overdraft agreement", "title": "AgreementLengthMin", "type": "number", "format": "float" }, "AgreementLengthMax": { "description": "Specifies the maximum length of a band for a fixed overdraft agreement", "title": "AgreementLengthMax", "type": "number", "format": "float" }, "AgreementPeriod": { "description": "Specifies the period of a fixed length overdraft agreement", "title": "AgreementPeriod", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "OverdraftInterestChargingCoverage": { "description": "Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is £2k and the interest tiers are:- 0-£500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%*500)+(0.2%*500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the ‘Whole’ of the account balance, and in the 2nd that it is ‘Tiered’.", "title": "OverdraftInterestChargingCoverage", "type": "string", "enum": [ "Banded", "Tiered", "Whole" ] }, "BankGuaranteedIndicator": { "description": "Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.", "title": "BankGuaranteedIndicator", "type": "boolean" }, "Notes": { "description": "Optional additional notes to supplement the Tier/band details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftFeesCharges": { "description": "Overdraft fees and charges", "type": "array", "title": "OverdraftFeesCharges", "items": { "description": "Overdraft fees and charges", "type": "object", "properties": { "OverdraftFeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "type": "array", "title": "OverdraftFeeChargeCap", "items": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "type": "object", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Overdraft fee type", "type": "string", "enum": [ "ArrangedOverdraft", "AnnualReview", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "minItems": 1 }, "MinMaxType": { "description": "Min Max type", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Notes related to Overdraft fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "required": [ "FeeType", "MinMaxType" ] }, "additionalProperties": false }, "OverdraftFeeChargeDetail": { "description": "Details about the fees/charges", "type": "array", "title": "OverdraftFeeChargeDetail", "items": { "description": "Details about the fees/charges", "type": "object", "properties": { "FeeType": { "description": "Overdraft fee type", "title": "FeeType", "type": "string", "enum": [ "ArrangedOverdraft", "AnnualReview", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "NegotiableIndicator": { "description": "Indicates whether fee and charges are negotiable", "title": "NegotiableIndicator", "type": "boolean" }, "OverdraftControlIndicator": { "description": "Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.", "title": "OverdraftControlIndicator", "type": "boolean" }, "IncrementalBorrowingAmount": { "description": "Every additional tranche of an overdraft balance to which an overdraft fee is applied", "title": "IncrementalBorrowingAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "FeeAmount": { "description": "Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)", "title": "FeeAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRate": { "description": "Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRateType": { "description": "Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRateType", "type": "string", "enum": [ "Gross", "Other" ] }, "ApplicationFrequency": { "description": "Frequency at which the overdraft charge is applied to the account", "title": "ApplicationFrequency", "type": "string", "enum": [ "OnClosing", "OnOpening", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAnniversary", "Other", "PerHundredPounds", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "CalculationFrequency": { "description": "How often is the overdraft fee/charge calculated for the account.", "title": "CalculationFrequency", "type": "string", "enum": [ "OnClosing", "OnOpening", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAnniversary", "Other", "PerHundredPounds", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "Notes": { "description": "Free text for capturing any other info related to Overdraft Fees Charge Details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftFeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "type": "array", "title": "OverdraftFeeChargeCap", "items": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "type": "object", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Overdraft fee type", "type": "string", "enum": [ "ArrangedOverdraft", "AnnualReview", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "minItems": 1 }, "MinMaxType": { "description": "Min Max type", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Notes related to Overdraft fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "required": [ "FeeType", "MinMaxType" ] }, "additionalProperties": false }, "OtherFeeType": { "description": "Other Fee type which is not available in the standard code set", "type": "object", "title": "OtherFeeType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherFeeRateType": { "description": "Other fee rate type code which is not available in the standard code set", "type": "object", "title": "OtherFeeRateType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherApplicationFrequency": { "description": "Other application frequencies that are not available in the standard code list", "type": "object", "title": "OtherApplicationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherCalculationFrequency": { "description": "Other calculation frequency which is not available in the standard code set.", "type": "object", "title": "OtherCalculationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] } }, "required": [ "FeeType", "ApplicationFrequency" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "OverdraftFeeChargeDetail" ] }, "additionalProperties": false } }, "required": [ "TierValueMin" ] }, "additionalProperties": false, "minItems": 1 }, "OverdraftFeesCharges": { "description": "Overdraft fees and charges details", "type": "array", "title": "OverdraftFeesCharges", "items": { "description": "Overdraft fees and charges details", "type": "object", "properties": { "OverdraftFeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "type": "array", "title": "OverdraftFeeChargeCap", "items": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "type": "object", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Overdraft fee type", "type": "string", "enum": [ "ArrangedOverdraft", "AnnualReview", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "minItems": 1 }, "MinMaxType": { "description": "Min Max type", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Notes related to Overdraft fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "required": [ "FeeType", "MinMaxType" ] }, "additionalProperties": false }, "OverdraftFeeChargeDetail": { "description": "Details about the fees/charges", "type": "array", "title": "OverdraftFeeChargeDetail", "items": { "description": "Details about the fees/charges", "type": "object", "properties": { "FeeType": { "description": "Overdraft fee type", "title": "FeeType", "type": "string", "enum": [ "ArrangedOverdraft", "AnnualReview", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "NegotiableIndicator": { "description": "Indicates whether fee and charges are negotiable", "title": "NegotiableIndicator", "type": "boolean" }, "OverdraftControlIndicator": { "description": "Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not.", "title": "OverdraftControlIndicator", "type": "boolean" }, "IncrementalBorrowingAmount": { "description": "Every additional tranche of an overdraft balance to which an overdraft fee is applied", "title": "IncrementalBorrowingAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "FeeAmount": { "description": "Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)", "title": "FeeAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRate": { "description": "Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRateType": { "description": "Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRateType", "type": "string", "enum": [ "Gross", "Other" ] }, "ApplicationFrequency": { "description": "Frequency at which the overdraft charge is applied to the account", "title": "ApplicationFrequency", "type": "string", "enum": [ "OnClosing", "OnOpening", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAnniversary", "Other", "PerHundredPounds", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "CalculationFrequency": { "description": "How often is the overdraft fee/charge calculated for the account.", "title": "CalculationFrequency", "type": "string", "enum": [ "OnClosing", "OnOpening", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAnniversary", "Other", "PerHundredPounds", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "Notes": { "description": "Free text for capturing any other info related to Overdraft Fees Charge Details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftFeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "type": "array", "title": "OverdraftFeeChargeCap", "items": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.", "type": "object", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Overdraft fee type", "type": "string", "enum": [ "ArrangedOverdraft", "AnnualReview", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "minItems": 1 }, "MinMaxType": { "description": "Min Max type", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Notes related to Overdraft fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "required": [ "FeeType", "MinMaxType" ] }, "additionalProperties": false }, "OtherFeeType": { "description": "Other Fee type which is not available in the standard code set", "type": "object", "title": "OtherFeeType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherFeeRateType": { "description": "Other fee rate type code which is not available in the standard code set", "type": "object", "title": "OtherFeeRateType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherApplicationFrequency": { "description": "Other application frequencies that are not available in the standard code list", "type": "object", "title": "OtherApplicationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherCalculationFrequency": { "description": "Other calculation frequency which is not available in the standard code set.", "type": "object", "title": "OtherCalculationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] } }, "required": [ "FeeType", "ApplicationFrequency" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "OverdraftFeeChargeDetail" ] }, "additionalProperties": false } }, "required": [ "TierBandMethod", "OverdraftTierBand" ] }, "additionalProperties": false, "minItems": 1 } }, "additionalProperties": false, "required": [ "OverdraftTierBandSet" ] }, "OtherFeesCharges": { "description": "Contains details of fees and charges which are not associated with either Overdraft or features/benefits", "type": "array", "title": "OtherFeesCharges", "items": { "description": "Contains details of fees and charges which are not associated with either Overdraft or features/benefits", "type": "object", "properties": { "TariffType": { "description": "TariffType which defines the fee and charges.", "title": "TariffType", "type": "string", "enum": [ "Electronic", "Mixed", "Other" ] }, "TariffName": { "description": "Name of the tariff", "title": "TariffName", "type": "string", "minLength": 1, "maxLength": 350 }, "OtherTariffType": { "description": "Other tariff type which is not in the standard list.", "type": "object", "title": "OtherTariffType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "FeeChargeDetail": { "description": "Other fees/charges details", "type": "array", "title": "FeeChargeDetail", "items": { "description": "Other fees/charges details", "type": "object", "properties": { "FeeCategory": { "description": "Categorisation of fees and charges into standard categories.", "title": "FeeCategory", "type": "string", "enum": [ "Other", "Servicing" ] }, "FeeType": { "description": "Fee/Charge Type", "title": "FeeType", "type": "string", "enum": [ "Other", "ServiceCAccountFee", "ServiceCAccountFeeMonthly", "ServiceCAccountFeeQuarterly", "ServiceCFixedTariff", "ServiceCBusiDepAccBreakage", "ServiceCMinimumMonthlyFee", "ServiceCOther" ] }, "NegotiableIndicator": { "description": "Fee/charge which is usually negotiable rather than a fixed amount", "title": "NegotiableIndicator", "type": "boolean" }, "FeeAmount": { "description": "Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)", "title": "FeeAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRate": { "description": "Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRateType": { "description": "Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRateType", "type": "string", "enum": [ "Gross", "Other" ] }, "ApplicationFrequency": { "description": "How frequently the fee/charge is applied to the account", "title": "ApplicationFrequency", "type": "string", "enum": [ "OnClosing", "OnOpening", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAnniversary", "Other", "PerHundredPounds", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "CalculationFrequency": { "description": "How frequently the fee/charge is calculated", "title": "CalculationFrequency", "type": "string", "enum": [ "OnClosing", "OnOpening", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAnniversary", "Other", "PerHundredPounds", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "Notes": { "description": "Optional additional notes to supplement the fee/charge details.", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "FeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular or group of fee/charge", "type": "array", "title": "FeeChargeCap", "items": { "description": "Details about any caps (maximum charges) that apply to a particular or group of fee/charge", "type": "object", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "Other", "ServiceCAccountFee", "ServiceCAccountFeeMonthly", "ServiceCAccountFeeQuarterly", "ServiceCFixedTariff", "ServiceCBusiDepAccBreakage", "ServiceCMinimumMonthlyFee", "ServiceCOther" ] }, "minItems": 1 }, "MinMaxType": { "description": "Min Max type", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Free text for adding extra details for fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "required": [ "FeeType", "MinMaxType" ] }, "additionalProperties": false }, "OtherFeeCategoryType": { "type": "object", "title": "OtherFeeCategoryType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherFeeType": { "description": "Other Fee/charge type which is not available in the standard code set", "type": "object", "title": "OtherFeeType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "FeeCategory": { "description": "Categorisation of fees and charges into standard categories.", "title": "FeeCategory", "type": "string", "enum": [ "Other", "Servicing" ] }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "FeeCategory", "Name", "Description" ] }, "OtherFeeRateType": { "description": "Other fee rate type which is not available in the standard code set", "type": "object", "title": "OtherFeeRateType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherApplicationFrequency": { "description": "Other application frequencies not covered in the standard code list", "type": "object", "title": "OtherApplicationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherCalculationFrequency": { "description": "Other calculation frequency which is not available in standard code set.", "type": "object", "title": "OtherCalculationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "FeeApplicableRange": { "description": "Range or amounts or rates for which the fee/charge applies", "type": "object", "title": "FeeApplicableRange", "properties": { "MinimumAmount": { "description": "Minimum Amount on which fee/charge is applicable (where it is expressed as an amount)", "title": "MinimumAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "MaximumAmount": { "description": "Maximum Amount on which fee is applicable (where it is expressed as an amount)", "title": "MaximumAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "MinimumRate": { "description": "Minimum rate on which fee/charge is applicable(where it is expressed as an rate)", "title": "MinimumRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "MaximumRate": { "description": "Maximum rate on which fee/charge is applicable(where it is expressed as an rate)", "title": "MaximumRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" } }, "additionalProperties": false } }, "required": [ "FeeCategory", "FeeType", "ApplicationFrequency" ] }, "additionalProperties": false, "minItems": 1 }, "FeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular or group of fee/charge", "type": "array", "title": "FeeChargeCap", "items": { "description": "Details about any caps (maximum charges) that apply to a particular or group of fee/charge", "type": "object", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "Other", "ServiceCAccountFee", "ServiceCAccountFeeMonthly", "ServiceCAccountFeeQuarterly", "ServiceCFixedTariff", "ServiceCBusiDepAccBreakage", "ServiceCMinimumMonthlyFee", "ServiceCOther" ] }, "minItems": 1 }, "MinMaxType": { "description": "Min Max type", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Free text for adding extra details for fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "required": [ "FeeType", "MinMaxType" ] }, "additionalProperties": false } }, "required": [ "FeeChargeDetail" ] }, "additionalProperties": false } }, "additionalProperties": false }, "PCA": { "type": "object", "title": "PCA", "properties": { "ProductDetails": { "type": "object", "title": "ProductDetails", "properties": { "Segment": { "description": "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\n\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nWith respect to PCA products, they are segmented in relation to different markets that they wish to focus on. ", "title": "Segment", "type": "array", "items": { "description": "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\n\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nWith respect to PCA products, they are segmented in relation to different markets that they wish to focus on. ", "type": "string", "enum": [ "Basic", "BenefitAndReward", "CreditInterest", "Cashback", "General", "Graduate", "Other", "Overdraft", "Packaged", "Premium", "Reward", "Student", "YoungAdult", "Youth" ] } }, "MonthlyMaximumCharge": { "description": "The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order", "title": "MonthlyMaximumCharge", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Notes": { "description": "Optional additional notes to supplement the Core product details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } } }, "additionalProperties": false }, "CreditInterest": { "description": "Details about the interest that may be payable to the PCA account holders", "type": "object", "title": "CreditInterest", "properties": { "TierBandSet": { "description": "The group of tiers or bands for which credit interest can be applied.", "type": "array", "title": "TierBandSet", "items": { "description": "The group of tiers or bands for which credit interest can be applied.", "type": "object", "properties": { "TierBandMethod": { "description": "The methodology of how credit interest is charged. It can be:-\n\n1. Banded\nInterest rates are banded. i.e. Increasing rate on whole balance as balance increases.\n\n2. Tiered\nInterest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance.\n\n3. Whole\nThe same interest rate is applied irrespective of the PCA balance", "title": "TierBandMethod", "type": "string", "enum": [ "Tiered", "Whole" ] }, "CalculationMethod": { "description": "Methods of calculating interest", "title": "CalculationMethod", "type": "string", "enum": [ "Compound", "SimpleInterest" ] }, "Destination": { "description": "Describes whether accrued interest is payable only to the PCA or to another bank account", "title": "Destination", "type": "string", "enum": [ "PayAway", "SelfCredit" ] }, "Notes": { "description": "Optional additional notes to supplement the Tier Band Set details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "TierBand": { "description": "Tier Band Details", "type": "array", "title": "TierBand", "items": { "description": "Tier Band Details", "type": "object", "properties": { "Identification": { "description": "Unique and unambiguous identification of a Tier Band for a PCA.", "title": "Identification", "type": "string", "minLength": 1, "maxLength": 35 }, "TierValueMinimum": { "description": "Minimum deposit value for which the credit interest tier applies.", "title": "TierValueMinimum", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "TierValueMaximum": { "description": "Maximum deposit value for which the credit interest tier applies.", "title": "TierValueMaximum", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CalculationFrequency": { "description": "How often is credit interest calculated for the account.", "title": "CalculationFrequency", "type": "string", "enum": [ "PerAcademicTerm", "Daily", "HalfYearly", "Monthly", "Other", "Quarterly", "PerStatementDate", "Weekly", "Yearly" ] }, "ApplicationFrequency": { "description": "How often is interest applied to the PCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's PCA.", "title": "ApplicationFrequency", "type": "string", "enum": [ "PerAcademicTerm", "Daily", "HalfYearly", "Monthly", "Other", "Quarterly", "PerStatementDate", "Weekly", "Yearly" ] }, "DepositInterestAppliedCoverage": { "description": "Amount on which Interest applied.", "title": "DepositInterestAppliedCoverage", "type": "string", "enum": [ "Tiered", "Whole" ] }, "FixedVariableInterestRateType": { "description": "Type of interest rate, Fixed or Variable", "title": "FixedVariableInterestRateType", "type": "string", "enum": [ "Fixed", "Variable" ] }, "AER": { "description": "The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. \n\nRead more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A", "title": "AER", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "BankInterestRateType": { "description": "Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA.", "title": "BankInterestRateType", "type": "string", "enum": [ "LinkedBaseRate", "Gross", "Net", "Other" ] }, "BankInterestRate": { "description": "Bank Interest for the PCA product", "title": "BankInterestRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "Notes": { "description": "Optional additional notes to supplement the Tier Band details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherBankInterestType": { "description": "Other interest rate types which are not available in the standard code list", "type": "object", "title": "OtherBankInterestType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherApplicationFrequency": { "description": "Other application frequencies that are not available in the standard code list", "type": "object", "title": "OtherApplicationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherCalculationFrequency": { "description": "Other calculation frequency which is not available in the standard code set.", "type": "object", "title": "OtherCalculationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] } }, "required": [ "TierValueMinimum", "ApplicationFrequency", "FixedVariableInterestRateType", "AER" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "TierBandMethod", "TierBand" ] }, "additionalProperties": false, "minItems": 1 } }, "additionalProperties": false, "required": [ "TierBandSet" ] }, "Overdraft": { "description": "Details about Overdraft rates, fees & charges", "type": "object", "title": "Overdraft", "properties": { "Notes": { "description": "Associated Notes about the overdraft rates", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftTierBandSet": { "description": "Tier band set details", "type": "array", "title": "OverdraftTierBandSet", "items": { "description": "Tier band set details", "type": "object", "properties": { "TierBandMethod": { "description": "The methodology of how overdraft is charged. It can be:\n'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). \n'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation\n'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation.", "title": "TierBandMethod", "type": "string", "enum": [ "Tiered", "Whole", "Banded" ] }, "OverdraftType": { "description": "An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time.", "title": "OverdraftType", "type": "string", "enum": [ "Committed", "OnDemand", "Other" ] }, "Identification": { "description": "Unique and unambiguous identification of a Tier Band for a overdraft product.", "title": "Identification", "type": "string", "minLength": 1, "maxLength": 35 }, "AuthorisedIndicator": { "description": "Indicates if the Overdraft is authorised (Y) or unauthorised (N)", "title": "AuthorisedIndicator", "type": "boolean" }, "BufferAmount": { "description": "When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.", "title": "BufferAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Notes": { "description": "Optional additional notes to supplement the overdraft Tier Band Set details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftTierBand": { "description": "Provides overdraft details for a specific tier or band", "type": "array", "title": "OverdraftTierBand", "items": { "description": "Provides overdraft details for a specific tier or band", "type": "object", "properties": { "Identification": { "description": "Unique and unambiguous identification of a Tier Band for a overdraft.", "title": "Identification", "type": "string", "minLength": 1, "maxLength": 35 }, "TierValueMin": { "description": "Minimum value of Overdraft Tier/Band", "title": "TierValueMin", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "TierValueMax": { "description": "Maximum value of Overdraft Tier/Band", "title": "TierValueMax", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "OverdraftInterestChargingCoverage": { "description": "Interest charged on whole amount or tiered/banded", "title": "OverdraftInterestChargingCoverage", "type": "string", "enum": [ "Tiered", "Whole" ] }, "BankGuaranteedIndicator": { "description": "Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically", "title": "BankGuaranteedIndicator", "type": "boolean" }, "EAR": { "description": "EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently\nused interchangeably), being the actual annual interest rate of an Overdraft.", "title": "EAR", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "Notes": { "description": "Optional additional notes to supplement the Tier/band details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OverdraftFeesCharges": { "description": "Overdraft fees and charges", "type": "array", "title": "OverdraftFeesCharges", "items": { "description": "Overdraft fees and charges", "type": "object", "properties": { "OverdraftFeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge", "type": "array", "title": "OverdraftFeeChargeCap", "items": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge", "type": "object", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Overdraft fee type", "type": "string", "enum": [ "ArrangedOverdraft", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "AnnualReview", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "minItems": 1 }, "OverdraftControlIndicator": { "description": "Specifies for the overdraft control feature/benefit", "title": "OverdraftControlIndicator", "type": "boolean" }, "MinMaxType": { "description": "Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "AcademicTerm", "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Notes related to Overdraft fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "required": [ "FeeType", "MinMaxType" ] }, "additionalProperties": false }, "OverdraftFeeChargeDetail": { "description": "Details about the fees/charges", "type": "array", "title": "OverdraftFeeChargeDetail", "items": { "description": "Details about the fees/charges", "type": "object", "properties": { "FeeType": { "description": "Overdraft fee type", "title": "FeeType", "type": "string", "enum": [ "ArrangedOverdraft", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "AnnualReview", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "OverdraftControlIndicator": { "description": "Specifies for the overdraft control feature/benefit", "title": "OverdraftControlIndicator", "type": "boolean" }, "IncrementalBorrowingAmount": { "description": "Every additional tranche of an overdraft balance to which an overdraft fee is applied", "title": "IncrementalBorrowingAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "FeeAmount": { "description": "Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)", "title": "FeeAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRate": { "description": "Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRateType": { "description": "Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRateType", "type": "string", "enum": [ "LinkedBaseRate", "Gross", "Net", "Other" ] }, "ApplicationFrequency": { "description": "Frequency at which the overdraft charge is applied to the account", "title": "ApplicationFrequency", "type": "string", "enum": [ "AccountClosing", "AccountOpening", "AcademicTerm", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAccountAnniversary", "Other", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "CalculationFrequency": { "description": "How often is the overdraft fee/charge calculated for the account.", "title": "CalculationFrequency", "type": "string", "enum": [ "AccountClosing", "AccountOpening", "AcademicTerm", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAccountAnniversary", "Other", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "Notes": { "description": "Free text for capturing any other info related to Overdraft Fees Charge Details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other Fee type which is not available in the standard code set", "type": "object", "title": "OtherFeeType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherFeeRateType": { "description": "Other fee rate type code which is not available in the standard code set", "type": "object", "title": "OtherFeeRateType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherApplicationFrequency": { "description": "Other application frequencies that are not available in the standard code list", "type": "object", "title": "OtherApplicationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherCalculationFrequency": { "description": "Other calculation frequency which is not available in the standard code set.", "type": "object", "title": "OtherCalculationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OverdraftFeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge", "type": "object", "title": "OverdraftFeeChargeCap", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Overdraft fee type", "type": "string", "enum": [ "ArrangedOverdraft", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "AnnualReview", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "minItems": 1 }, "OverdraftControlIndicator": { "description": "Specifies for the overdraft control feature/benefit", "title": "OverdraftControlIndicator", "type": "boolean" }, "MinMaxType": { "description": "Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "AcademicTerm", "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Notes related to Overdraft fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "FeeType", "MinMaxType" ] } }, "required": [ "FeeType", "ApplicationFrequency" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "OverdraftFeeChargeDetail" ] }, "additionalProperties": false } }, "required": [ "TierValueMin" ] }, "additionalProperties": false, "minItems": 1 }, "OverdraftFeesCharges": { "description": "Overdraft fees and charges details", "type": "array", "title": "OverdraftFeesCharges", "items": { "description": "Overdraft fees and charges details", "type": "object", "properties": { "OverdraftFeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge", "type": "array", "title": "OverdraftFeeChargeCap", "items": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge", "type": "object", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Overdraft fee type", "type": "string", "enum": [ "ArrangedOverdraft", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "AnnualReview", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "minItems": 1 }, "OverdraftControlIndicator": { "description": "Specifies for the overdraft control feature/benefit", "title": "OverdraftControlIndicator", "type": "boolean" }, "MinMaxType": { "description": "Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "AcademicTerm", "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Notes related to Overdraft fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "required": [ "FeeType", "MinMaxType" ] }, "additionalProperties": false }, "OverdraftFeeChargeDetail": { "description": "Details about the fees/charges", "type": "array", "title": "OverdraftFeeChargeDetail", "items": { "description": "Details about the fees/charges", "type": "object", "properties": { "FeeType": { "description": "Overdraft fee type", "title": "FeeType", "type": "string", "enum": [ "ArrangedOverdraft", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "AnnualReview", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "OverdraftControlIndicator": { "description": "Specifies for the overdraft control feature/benefit", "title": "OverdraftControlIndicator", "type": "boolean" }, "IncrementalBorrowingAmount": { "description": "Every additional tranche of an overdraft balance to which an overdraft fee is applied", "title": "IncrementalBorrowingAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "FeeAmount": { "description": "Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)", "title": "FeeAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRate": { "description": "Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRateType": { "description": "Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRateType", "type": "string", "enum": [ "LinkedBaseRate", "Gross", "Net", "Other" ] }, "ApplicationFrequency": { "description": "Frequency at which the overdraft charge is applied to the account", "title": "ApplicationFrequency", "type": "string", "enum": [ "AccountClosing", "AccountOpening", "AcademicTerm", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAccountAnniversary", "Other", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "CalculationFrequency": { "description": "How often is the overdraft fee/charge calculated for the account.", "title": "CalculationFrequency", "type": "string", "enum": [ "AccountClosing", "AccountOpening", "AcademicTerm", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAccountAnniversary", "Other", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "Notes": { "description": "Free text for capturing any other info related to Overdraft Fees Charge Details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other Fee type which is not available in the standard code set", "type": "object", "title": "OtherFeeType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherFeeRateType": { "description": "Other fee rate type code which is not available in the standard code set", "type": "object", "title": "OtherFeeRateType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherApplicationFrequency": { "description": "Other application frequencies that are not available in the standard code list", "type": "object", "title": "OtherApplicationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherCalculationFrequency": { "description": "Other calculation frequency which is not available in the standard code set.", "type": "object", "title": "OtherCalculationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OverdraftFeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge", "type": "object", "title": "OverdraftFeeChargeCap", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Overdraft fee type", "type": "string", "enum": [ "ArrangedOverdraft", "EmergencyBorrowing", "BorrowingItem", "OverdraftRenewal", "AnnualReview", "OverdraftSetup", "Surcharge", "TempOverdraft", "UnauthorisedBorrowing", "UnauthorisedPaidTrans", "Other", "UnauthorisedUnpaidTrans" ] }, "minItems": 1 }, "OverdraftControlIndicator": { "description": "Specifies for the overdraft control feature/benefit", "title": "OverdraftControlIndicator", "type": "boolean" }, "MinMaxType": { "description": "Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "AcademicTerm", "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Notes related to Overdraft fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "FeeType", "MinMaxType" ] } }, "required": [ "FeeType", "ApplicationFrequency" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "OverdraftFeeChargeDetail" ] }, "additionalProperties": false } }, "required": [ "TierBandMethod", "OverdraftTierBand" ] }, "additionalProperties": false, "minItems": 1 } }, "additionalProperties": false, "required": [ "OverdraftTierBandSet" ] }, "OtherFeesCharges": { "description": "Contains details of fees and charges which are not associated with either borrowing or features/benefits", "type": "object", "title": "OtherFeesCharges", "properties": { "FeeChargeDetail": { "description": "Other fees/charges details", "type": "array", "title": "FeeChargeDetail", "items": { "description": "Other fees/charges details", "type": "object", "properties": { "FeeCategory": { "description": "Categorisation of fees and charges into standard categories.", "title": "FeeCategory", "type": "string", "enum": [ "Other", "Servicing" ] }, "FeeType": { "description": "Fee/Charge Type", "title": "FeeType", "type": "string", "enum": [ "ServiceCAccountFee", "ServiceCAccountFeeMonthly", "ServiceCOther", "Other" ] }, "FeeAmount": { "description": "Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)", "title": "FeeAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRate": { "description": "Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "FeeRateType": { "description": "Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)", "title": "FeeRateType", "type": "string", "enum": [ "LinkedBaseRate", "Gross", "Net", "Other" ] }, "ApplicationFrequency": { "description": "How frequently the fee/charge is applied to the account", "title": "ApplicationFrequency", "type": "string", "enum": [ "AccountClosing", "AccountOpening", "AcademicTerm", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAccountAnniversary", "Other", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "CalculationFrequency": { "description": "How frequently the fee/charge is calculated", "title": "CalculationFrequency", "type": "string", "enum": [ "AccountClosing", "AccountOpening", "AcademicTerm", "ChargingPeriod", "Daily", "PerItem", "Monthly", "OnAccountAnniversary", "Other", "PerHour", "PerOccurrence", "PerSheet", "PerTransaction", "PerTransactionAmount", "PerTransactionPercentage", "Quarterly", "SixMonthly", "StatementMonthly", "Weekly", "Yearly" ] }, "Notes": { "description": "Optional additional notes to supplement the fee/charge details.", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeCategoryType": { "type": "object", "title": "OtherFeeCategoryType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherFeeType": { "description": "Other Fee/charge type which is not available in the standard code set", "type": "object", "title": "OtherFeeType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "FeeCategory": { "description": "Categorisation of fees and charges into standard categories.", "title": "FeeCategory", "type": "string", "enum": [ "Other", "Servicing" ] }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "FeeCategory", "Name", "Description" ] }, "OtherFeeRateType": { "description": "Other fee rate type which is not available in the standard code set", "type": "object", "title": "OtherFeeRateType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherApplicationFrequency": { "description": "Other application frequencies not covered in the standard code list", "type": "object", "title": "OtherApplicationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "OtherCalculationFrequency": { "description": "Other calculation frequency which is not available in standard code set.", "type": "object", "title": "OtherCalculationFrequency", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "FeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge", "type": "array", "title": "FeeChargeCap", "items": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge", "type": "object", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "ServiceCAccountFee", "ServiceCAccountFeeMonthly", "ServiceCOther", "Other" ] }, "minItems": 1 }, "MinMaxType": { "description": "Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "AcademicTerm", "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Free text for adding extra details for fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "required": [ "FeeType", "MinMaxType" ] }, "additionalProperties": false }, "FeeApplicableRange": { "description": "Range or amounts or rates for which the fee/charge applies", "type": "object", "title": "FeeApplicableRange", "properties": { "MinimumAmount": { "description": "Minimum Amount on which fee/charge is applicable (where it is expressed as an amount)", "title": "MinimumAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "MaximumAmount": { "description": "Maximum Amount on which fee is applicable (where it is expressed as an amount)", "title": "MaximumAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "MinimumRate": { "description": "Minimum rate on which fee/charge is applicable(where it is expressed as an rate)", "title": "MinimumRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "MaximumRate": { "description": "Maximum rate on which fee/charge is applicable(where it is expressed as an rate)", "title": "MaximumRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" } }, "additionalProperties": false } }, "required": [ "FeeCategory", "FeeType", "ApplicationFrequency" ] }, "additionalProperties": false, "minItems": 1 }, "FeeChargeCap": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge", "type": "array", "title": "FeeChargeCap", "items": { "description": "Details about any caps (maximum charges) that apply to a particular fee/charge", "type": "object", "properties": { "FeeType": { "description": "Fee/charge type which is being capped", "title": "FeeType", "type": "array", "items": { "description": "Fee/charge type which is being capped", "type": "string", "enum": [ "ServiceCAccountFee", "ServiceCAccountFeeMonthly", "ServiceCOther", "Other" ] }, "minItems": 1 }, "MinMaxType": { "description": "Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "FeeCapOccurrence": { "description": "fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount", "title": "FeeCapOccurrence", "type": "number", "format": "float" }, "FeeCapAmount": { "description": "Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)", "title": "FeeCapAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "CappingPeriod": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "title": "CappingPeriod", "type": "string", "enum": [ "AcademicTerm", "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Free text for adding extra details for fee charge cap", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherFeeType": { "description": "Other fee type code which is not available in the standard code set", "type": "array", "title": "OtherFeeType", "items": { "description": "Other fee type code which is not available in the standard code set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false } }, "required": [ "FeeType", "MinMaxType" ] }, "additionalProperties": false } }, "additionalProperties": false, "required": [ "FeeChargeDetail" ] } }, "additionalProperties": false } } } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadScheduledPayment2": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "ScheduledPayment": { "type": "array", "items": { "$ref": "#/definitions/OBScheduledPayment2" } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadStandingOrder4": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "StandingOrder": { "type": "array", "items": { "$ref": "#/definitions/OBStandingOrder4" } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadStandingOrder5": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "StandingOrder": { "type": "array", "items": { "$ref": "#/definitions/OBStandingOrder5" } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadStatement1": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "$ref": "#/definitions/OBReadDataStatement2" }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadStatement2": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "$ref": "#/definitions/OBReadDataStatement2" }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadTransaction4": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "$ref": "#/definitions/OBReadDataTransaction5" }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBReadTransaction5": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "$ref": "#/definitions/OBReadDataTransaction5" }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBRisk2": { "description": "The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.", "type": "object", "properties": {}, "additionalProperties": false }, "OBScheduledPayment2": { "type": "object", "required": [ "AccountId", "ScheduledPaymentDateTime", "ScheduledType", "InstructedAmount" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "ScheduledPaymentId": { "$ref": "#/definitions/ScheduledPaymentId" }, "ScheduledPaymentDateTime": { "$ref": "#/definitions/ScheduledPaymentDateTime" }, "ScheduledType": { "$ref": "#/definitions/OBExternalScheduleType1Code" }, "Reference": { "$ref": "#/definitions/Reference" }, "InstructedAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_9" }, "CreditorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5_1" }, "CreditorAccount": { "$ref": "#/definitions/OBCashAccount5_0" } } }, "OBScheduledPayment2Basic": { "type": "object", "required": [ "AccountId", "ScheduledPaymentDateTime", "ScheduledType", "InstructedAmount" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "ScheduledPaymentId": { "$ref": "#/definitions/ScheduledPaymentId" }, "ScheduledPaymentDateTime": { "$ref": "#/definitions/ScheduledPaymentDateTime" }, "ScheduledType": { "$ref": "#/definitions/OBExternalScheduleType1Code" }, "Reference": { "$ref": "#/definitions/Reference" }, "InstructedAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_9" } } }, "OBScheduledPayment2Detail": { "type": "object", "required": [ "AccountId", "ScheduledPaymentDateTime", "ScheduledType", "InstructedAmount", "CreditorAccount" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "ScheduledPaymentId": { "$ref": "#/definitions/ScheduledPaymentId" }, "ScheduledPaymentDateTime": { "$ref": "#/definitions/ScheduledPaymentDateTime" }, "ScheduledType": { "$ref": "#/definitions/OBExternalScheduleType1Code" }, "Reference": { "$ref": "#/definitions/Reference" }, "InstructedAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_9" }, "CreditorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5_1" }, "CreditorAccount": { "$ref": "#/definitions/OBCashAccount5_0" } } }, "OBStandingOrder4": { "type": "object", "required": [ "AccountId", "Frequency" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "StandingOrderId": { "$ref": "#/definitions/StandingOrderId" }, "Frequency": { "$ref": "#/definitions/Frequency_0" }, "Reference": { "$ref": "#/definitions/Reference" }, "FirstPaymentDateTime": { "$ref": "#/definitions/FirstPaymentDateTime" }, "NextPaymentDateTime": { "$ref": "#/definitions/NextPaymentDateTime" }, "FinalPaymentDateTime": { "$ref": "#/definitions/FinalPaymentDateTime" }, "StandingOrderStatusCode": { "$ref": "#/definitions/OBExternalStandingOrderStatus1Code" }, "FirstPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_0" }, "NextPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_1" }, "FinalPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_2" }, "CreditorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5_1" }, "CreditorAccount": { "$ref": "#/definitions/OBCashAccount5_0" }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "OBStandingOrder4Basic": { "type": "object", "required": [ "AccountId", "Frequency" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "StandingOrderId": { "$ref": "#/definitions/StandingOrderId" }, "Frequency": { "$ref": "#/definitions/Frequency_0" }, "Reference": { "$ref": "#/definitions/Reference" }, "FirstPaymentDateTime": { "$ref": "#/definitions/FirstPaymentDateTime" }, "NextPaymentDateTime": { "$ref": "#/definitions/NextPaymentDateTime" }, "FinalPaymentDateTime": { "$ref": "#/definitions/FinalPaymentDateTime" }, "StandingOrderStatusCode": { "$ref": "#/definitions/OBExternalStandingOrderStatus1Code" }, "FirstPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_0" }, "NextPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_1" }, "FinalPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_2" }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "OBStandingOrder4Detail": { "type": "object", "required": [ "AccountId", "Frequency", "CreditorAccount" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "StandingOrderId": { "$ref": "#/definitions/StandingOrderId" }, "Frequency": { "$ref": "#/definitions/Frequency_0" }, "Reference": { "$ref": "#/definitions/Reference" }, "FirstPaymentDateTime": { "$ref": "#/definitions/FirstPaymentDateTime" }, "NextPaymentDateTime": { "$ref": "#/definitions/NextPaymentDateTime" }, "FinalPaymentDateTime": { "$ref": "#/definitions/FinalPaymentDateTime" }, "StandingOrderStatusCode": { "$ref": "#/definitions/OBExternalStandingOrderStatus1Code" }, "FirstPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_0" }, "NextPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_1" }, "FinalPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_2" }, "CreditorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5_1" }, "CreditorAccount": { "$ref": "#/definitions/OBCashAccount5_0" }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "OBStandingOrder5": { "type": "object", "required": [ "AccountId", "Frequency" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "StandingOrderId": { "$ref": "#/definitions/StandingOrderId" }, "Frequency": { "$ref": "#/definitions/Frequency_1" }, "Reference": { "$ref": "#/definitions/Reference" }, "FirstPaymentDateTime": { "$ref": "#/definitions/FirstPaymentDateTime" }, "NextPaymentDateTime": { "$ref": "#/definitions/NextPaymentDateTime" }, "FinalPaymentDateTime": { "$ref": "#/definitions/FinalPaymentDateTime" }, "StandingOrderStatusCode": { "$ref": "#/definitions/OBExternalStandingOrderStatus1Code" }, "FirstPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_0" }, "NextPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_1" }, "FinalPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_2" }, "CreditorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5_1" }, "CreditorAccount": { "$ref": "#/definitions/OBCashAccount5_0" }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "OBStandingOrder5Basic": { "type": "object", "required": [ "AccountId", "Frequency" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "StandingOrderId": { "$ref": "#/definitions/StandingOrderId" }, "Frequency": { "$ref": "#/definitions/Frequency_1" }, "Reference": { "$ref": "#/definitions/Reference" }, "FirstPaymentDateTime": { "$ref": "#/definitions/FirstPaymentDateTime" }, "NextPaymentDateTime": { "$ref": "#/definitions/NextPaymentDateTime" }, "FinalPaymentDateTime": { "$ref": "#/definitions/FinalPaymentDateTime" }, "StandingOrderStatusCode": { "$ref": "#/definitions/OBExternalStandingOrderStatus1Code" }, "FirstPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_0" }, "NextPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_1" }, "FinalPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_2" }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "OBStandingOrder5Detail": { "type": "object", "required": [ "AccountId", "Frequency", "CreditorAccount" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "StandingOrderId": { "$ref": "#/definitions/StandingOrderId" }, "Frequency": { "$ref": "#/definitions/Frequency_1" }, "Reference": { "$ref": "#/definitions/Reference" }, "FirstPaymentDateTime": { "$ref": "#/definitions/FirstPaymentDateTime" }, "NextPaymentDateTime": { "$ref": "#/definitions/NextPaymentDateTime" }, "FinalPaymentDateTime": { "$ref": "#/definitions/FinalPaymentDateTime" }, "StandingOrderStatusCode": { "$ref": "#/definitions/OBExternalStandingOrderStatus1Code" }, "FirstPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_0" }, "NextPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_1" }, "FinalPaymentAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_2" }, "CreditorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification5_1" }, "CreditorAccount": { "$ref": "#/definitions/OBCashAccount5_0" }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "OBStatement2": { "type": "object", "description": "Provides further details on a statement resource.", "required": [ "AccountId", "Type", "StartDateTime", "EndDateTime", "CreationDateTime" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "StatementId": { "$ref": "#/definitions/StatementId" }, "StatementReference": { "$ref": "#/definitions/StatementReference" }, "Type": { "$ref": "#/definitions/OBExternalStatementType1Code" }, "StartDateTime": { "$ref": "#/definitions/StartDateTime" }, "EndDateTime": { "$ref": "#/definitions/EndDateTime" }, "CreationDateTime": { "$ref": "#/definitions/CreationDateTime" }, "StatementDescription": { "type": "array", "items": { "description": "Other descriptions that may be available for the statement resource.", "type": "string", "minLength": 1, "maxLength": 500 } }, "StatementBenefit": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a benefit or reward amount for the statement resource.", "required": [ "Type", "Amount" ], "properties": { "Type": { "$ref": "#/definitions/OBExternalStatementBenefitType1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_3" } } } }, "StatementFee": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a fee for the statement resource.", "required": [ "CreditDebitIndicator", "Type", "Amount" ], "properties": { "Description": { "$ref": "#/definitions/Description_1" }, "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_0" }, "Type": { "$ref": "#/definitions/OBExternalStatementFeeType1Code" }, "Rate": { "$ref": "#/definitions/OBRate1_0" }, "RateType": { "$ref": "#/definitions/OBExternalStatementFeeRateType1Code" }, "Frequency": { "$ref": "#/definitions/OBExternalStatementFeeFrequency1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_4" } } } }, "StatementInterest": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic interest amount related to the statement resource.", "required": [ "CreditDebitIndicator", "Type", "Amount" ], "properties": { "Description": { "$ref": "#/definitions/Description_2" }, "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_0" }, "Type": { "$ref": "#/definitions/OBExternalStatementInterestType1Code" }, "Rate": { "$ref": "#/definitions/OBRate1_1" }, "RateType": { "$ref": "#/definitions/OBExternalStatementInterestRateType1Code" }, "Frequency": { "$ref": "#/definitions/OBExternalStatementInterestFrequency1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_5" } } } }, "StatementAmount": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic amount for the statement resource.", "required": [ "CreditDebitIndicator", "Type", "Amount" ], "properties": { "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_0" }, "Type": { "$ref": "#/definitions/OBExternalStatementAmountType1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_6" } } } }, "StatementDateTime": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic date time for the statement resource.", "required": [ "DateTime", "Type" ], "properties": { "DateTime": { "$ref": "#/definitions/DateTime" }, "Type": { "$ref": "#/definitions/OBExternalStatementDateTimeType1Code" } } } }, "StatementRate": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic rate related to the statement resource.", "required": [ "Rate", "Type" ], "properties": { "Rate": { "$ref": "#/definitions/OBExternalStatementRateType1Code" }, "Type": { "$ref": "#/definitions/Type_0" } } } }, "StatementValue": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic number value related to the statement resource.", "required": [ "Value", "Type" ], "properties": { "Value": { "$ref": "#/definitions/OBExternalStatementValueType1Code" }, "Type": { "$ref": "#/definitions/Type_1" } } } } } }, "OBStatement2Basic": { "type": "object", "description": "Provides further details on a statement resource.", "required": [ "AccountId", "Type", "StartDateTime", "EndDateTime", "CreationDateTime" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "StatementId": { "$ref": "#/definitions/StatementId" }, "StatementReference": { "$ref": "#/definitions/StatementReference" }, "Type": { "$ref": "#/definitions/OBExternalStatementType1Code" }, "StartDateTime": { "$ref": "#/definitions/StartDateTime" }, "EndDateTime": { "$ref": "#/definitions/EndDateTime" }, "CreationDateTime": { "$ref": "#/definitions/CreationDateTime" }, "StatementDescription": { "type": "array", "items": { "description": "Other descriptions that may be available for the statement resource.", "type": "string", "minLength": 1, "maxLength": 500 } }, "StatementBenefit": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a benefit or reward amount for the statement resource.", "required": [ "Type", "Amount" ], "properties": { "Type": { "$ref": "#/definitions/OBExternalStatementBenefitType1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_3" } } } }, "StatementFee": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a fee for the statement resource.", "required": [ "CreditDebitIndicator", "Type", "Amount" ], "properties": { "Description": { "$ref": "#/definitions/Description_1" }, "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_0" }, "Type": { "$ref": "#/definitions/OBExternalStatementFeeType1Code" }, "Rate": { "$ref": "#/definitions/OBRate1_0" }, "RateType": { "$ref": "#/definitions/OBExternalStatementFeeRateType1Code" }, "Frequency": { "$ref": "#/definitions/OBExternalStatementFeeFrequency1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_4" } } } }, "StatementInterest": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic interest amount related to the statement resource.", "required": [ "CreditDebitIndicator", "Type", "Amount" ], "properties": { "Description": { "$ref": "#/definitions/Description_2" }, "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_0" }, "Type": { "$ref": "#/definitions/OBExternalStatementInterestType1Code" }, "Rate": { "$ref": "#/definitions/OBRate1_1" }, "RateType": { "$ref": "#/definitions/OBExternalStatementInterestRateType1Code" }, "Frequency": { "$ref": "#/definitions/OBExternalStatementInterestFrequency1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_5" } } } }, "StatementDateTime": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic date time for the statement resource.", "required": [ "DateTime", "Type" ], "properties": { "DateTime": { "$ref": "#/definitions/DateTime" }, "Type": { "$ref": "#/definitions/OBExternalStatementDateTimeType1Code" } } } }, "StatementRate": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic rate related to the statement resource.", "required": [ "Rate", "Type" ], "properties": { "Rate": { "$ref": "#/definitions/OBExternalStatementRateType1Code" }, "Type": { "$ref": "#/definitions/Type_0" } } } }, "StatementValue": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic number value related to the statement resource.", "required": [ "Value", "Type" ], "properties": { "Value": { "$ref": "#/definitions/OBExternalStatementValueType1Code" }, "Type": { "$ref": "#/definitions/Type_1" } } } } } }, "OBStatement2Detail": { "type": "object", "description": "Provides further details on a statement resource.", "required": [ "AccountId", "Type", "StartDateTime", "EndDateTime", "CreationDateTime" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "StatementId": { "$ref": "#/definitions/StatementId" }, "StatementReference": { "$ref": "#/definitions/StatementReference" }, "Type": { "$ref": "#/definitions/OBExternalStatementType1Code" }, "StartDateTime": { "$ref": "#/definitions/StartDateTime" }, "EndDateTime": { "$ref": "#/definitions/EndDateTime" }, "CreationDateTime": { "$ref": "#/definitions/CreationDateTime" }, "StatementDescription": { "type": "array", "items": { "description": "Other descriptions that may be available for the statement resource.", "type": "string", "minLength": 1, "maxLength": 500 } }, "StatementBenefit": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a benefit or reward amount for the statement resource.", "required": [ "Type", "Amount" ], "properties": { "Type": { "$ref": "#/definitions/OBExternalStatementBenefitType1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_3" } } } }, "StatementFee": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a fee for the statement resource.", "required": [ "CreditDebitIndicator", "Type", "Amount" ], "properties": { "Description": { "$ref": "#/definitions/Description_1" }, "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_0" }, "Type": { "$ref": "#/definitions/OBExternalStatementFeeType1Code" }, "Rate": { "$ref": "#/definitions/OBRate1_0" }, "RateType": { "$ref": "#/definitions/OBExternalStatementFeeRateType1Code" }, "Frequency": { "$ref": "#/definitions/OBExternalStatementFeeFrequency1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_4" } } } }, "StatementInterest": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic interest amount related to the statement resource.", "required": [ "CreditDebitIndicator", "Type", "Amount" ], "properties": { "Description": { "$ref": "#/definitions/Description_2" }, "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_0" }, "Type": { "$ref": "#/definitions/OBExternalStatementInterestType1Code" }, "Rate": { "$ref": "#/definitions/OBRate1_1" }, "RateType": { "$ref": "#/definitions/OBExternalStatementInterestRateType1Code" }, "Frequency": { "$ref": "#/definitions/OBExternalStatementInterestFrequency1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_5" } } } }, "StatementAmount": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic amount for the statement resource.", "required": [ "CreditDebitIndicator", "Type", "Amount" ], "properties": { "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_0" }, "Type": { "$ref": "#/definitions/OBExternalStatementAmountType1Code" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_6" } } } }, "StatementDateTime": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic date time for the statement resource.", "required": [ "DateTime", "Type" ], "properties": { "DateTime": { "$ref": "#/definitions/DateTime" }, "Type": { "$ref": "#/definitions/OBExternalStatementDateTimeType1Code" } } } }, "StatementRate": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic rate related to the statement resource.", "required": [ "Rate", "Type" ], "properties": { "Rate": { "$ref": "#/definitions/OBExternalStatementRateType1Code" }, "Type": { "$ref": "#/definitions/Type_0" } } } }, "StatementValue": { "type": "array", "items": { "type": "object", "description": "Set of elements used to provide details of a generic number value related to the statement resource.", "required": [ "Value", "Type" ], "properties": { "Value": { "$ref": "#/definitions/OBExternalStatementValueType1Code" }, "Type": { "$ref": "#/definitions/Type_1" } } } } } }, "OBSupplementaryData1": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Additional information that can not be captured in the structured fields and/or any other specific block." }, "OBTransaction5": { "type": "object", "description": "Provides further details on an entry in the report.", "required": [ "AccountId", "CreditDebitIndicator", "Status", "BookingDateTime", "Amount" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "TransactionId": { "$ref": "#/definitions/TransactionId" }, "TransactionReference": { "$ref": "#/definitions/TransactionReference" }, "StatementReference": { "type": "array", "items": { "$ref": "#/definitions/StatementReference" } }, "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_1" }, "Status": { "$ref": "#/definitions/OBEntryStatus1Code" }, "BookingDateTime": { "$ref": "#/definitions/BookingDateTime" }, "ValueDateTime": { "$ref": "#/definitions/ValueDateTime" }, "TransactionInformation": { "$ref": "#/definitions/TransactionInformation" }, "AddressLine": { "$ref": "#/definitions/AddressLine" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_7" }, "ChargeAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_8" }, "CurrencyExchange": { "$ref": "#/definitions/OBCurrencyExchange5" }, "BankTransactionCode": { "$ref": "#/definitions/OBBankTransactionCodeStructure1" }, "ProprietaryBankTransactionCode": { "$ref": "#/definitions/ProprietaryBankTransactionCodeStructure1" }, "Balance": { "$ref": "#/definitions/OBTransactionCashBalance" }, "MerchantDetails": { "$ref": "#/definitions/OBMerchantDetails1" }, "CreditorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification6_0" }, "CreditorAccount": { "$ref": "#/definitions/OBCashAccount6_0" }, "DebtorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification6_1" }, "DebtorAccount": { "$ref": "#/definitions/OBCashAccount6_1" }, "CardInstrument": { "$ref": "#/definitions/OBTransactionCardInstrument1" }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "OBTransaction5Basic": { "type": "object", "description": "Provides further details on an entry in the report.", "required": [ "AccountId", "CreditDebitIndicator", "Status", "BookingDateTime", "Amount" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "TransactionId": { "$ref": "#/definitions/TransactionId" }, "TransactionReference": { "$ref": "#/definitions/TransactionReference" }, "StatementReference": { "type": "array", "items": { "$ref": "#/definitions/StatementReference" } }, "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_1" }, "Status": { "$ref": "#/definitions/OBEntryStatus1Code" }, "BookingDateTime": { "$ref": "#/definitions/BookingDateTime" }, "ValueDateTime": { "$ref": "#/definitions/ValueDateTime" }, "AddressLine": { "$ref": "#/definitions/AddressLine" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_7" }, "ChargeAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_8" }, "CurrencyExchange": { "$ref": "#/definitions/OBCurrencyExchange5" }, "BankTransactionCode": { "$ref": "#/definitions/OBBankTransactionCodeStructure1" }, "ProprietaryBankTransactionCode": { "$ref": "#/definitions/ProprietaryBankTransactionCodeStructure1" }, "CardInstrument": { "$ref": "#/definitions/OBTransactionCardInstrument1" }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "OBTransaction5Detail": { "type": "object", "description": "Provides further details on an entry in the report.", "required": [ "AccountId", "CreditDebitIndicator", "Status", "BookingDateTime", "Amount" ], "properties": { "AccountId": { "$ref": "#/definitions/AccountId" }, "TransactionId": { "$ref": "#/definitions/TransactionId" }, "TransactionReference": { "$ref": "#/definitions/TransactionReference" }, "StatementReference": { "type": "array", "items": { "$ref": "#/definitions/StatementReference" } }, "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_1" }, "Status": { "$ref": "#/definitions/OBEntryStatus1Code" }, "BookingDateTime": { "$ref": "#/definitions/BookingDateTime" }, "ValueDateTime": { "$ref": "#/definitions/ValueDateTime" }, "TransactionInformation": { "$ref": "#/definitions/TransactionInformation" }, "AddressLine": { "$ref": "#/definitions/AddressLine" }, "Amount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_7" }, "ChargeAmount": { "$ref": "#/definitions/OBActiveOrHistoricCurrencyAndAmount_8" }, "CurrencyExchange": { "$ref": "#/definitions/OBCurrencyExchange5" }, "BankTransactionCode": { "$ref": "#/definitions/OBBankTransactionCodeStructure1" }, "ProprietaryBankTransactionCode": { "$ref": "#/definitions/ProprietaryBankTransactionCodeStructure1" }, "Balance": { "$ref": "#/definitions/OBTransactionCashBalance" }, "MerchantDetails": { "$ref": "#/definitions/OBMerchantDetails1" }, "CreditorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification6_0" }, "CreditorAccount": { "$ref": "#/definitions/OBCashAccount6_0" }, "DebtorAgent": { "$ref": "#/definitions/OBBranchAndFinancialInstitutionIdentification6_1" }, "DebtorAccount": { "$ref": "#/definitions/OBCashAccount6_1" }, "CardInstrument": { "$ref": "#/definitions/OBTransactionCardInstrument1" }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "OBTransactionCardInstrument1": { "type": "object", "required": [ "CardSchemeName" ], "description": "Set of elements to describe the card instrument used in the transaction.", "properties": { "CardSchemeName": { "description": "Name of the card scheme.", "type": "string", "enum": [ "AmericanExpress", "Diners", "Discover", "MasterCard", "VISA" ] }, "AuthorisationType": { "description": "The card authorisation type.", "type": "string", "enum": [ "ConsumerDevice", "Contactless", "None", "PIN" ] }, "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 } } }, "OBTransactionCashBalance": { "type": "object", "required": [ "CreditDebitIndicator", "Type", "Amount" ], "description": "Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account.", "properties": { "CreditDebitIndicator": { "$ref": "#/definitions/OBCreditDebitCode_2" }, "Type": { "$ref": "#/definitions/OBBalanceType1Code" }, "Amount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "Amount of money of the cash balance after a transaction entry is applied to the account..", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode_1" } } } } }, "OB_Amount1_0": { "description": "Cap amount charged for a fee/charge", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "OB_Amount1_1": { "description": "Every additional tranche of an overdraft balance to which an overdraft fee is applied", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "OB_Amount1_2": { "description": "Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate)", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "OB_Amount1_3": { "description": "Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "OB_Amount1_4": { "description": "Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate)", "type": "string", "pattern": "^(-?\\\\d{1,14}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "OB_CodeMnemonic": { "description": "The four letter Mnemonic used within an XML file to identify a code", "type": "string", "pattern": "^\\\\w{0,4}$" }, "OB_FeeCategory1Code": { "description": "Categorisation of fees and charges into standard categories.", "type": "string", "enum": [ "FCOT", "FCRE", "FCSV" ] }, "OB_FeeFrequency1Code_0": { "description": "Frequency at which the overdraft charge is applied to the account", "type": "string", "enum": [ "FEAC", "FEAO", "FECP", "FEDA", "FEHO", "FEI", "FEMO", "FEOA", "FEOT", "FEPC", "FEPH", "FEPO", "FEPS", "FEPT", "FEPTA", "FEPTP", "FEQU", "FESM", "FEST", "FEWE", "FEYE" ] }, "OB_FeeFrequency1Code_1": { "description": "How often is the overdraft fee/charge calculated for the account.", "type": "string", "enum": [ "FEAC", "FEAO", "FECP", "FEDA", "FEHO", "FEI", "FEMO", "FEOA", "FEOT", "FEPC", "FEPH", "FEPO", "FEPS", "FEPT", "FEPTA", "FEPTP", "FEQU", "FESM", "FEST", "FEWE", "FEYE" ] }, "OB_FeeFrequency1Code_2": { "description": "How frequently the fee/charge is applied to the account", "type": "string", "enum": [ "FEAC", "FEAO", "FECP", "FEDA", "FEHO", "FEI", "FEMO", "FEOA", "FEOT", "FEPC", "FEPH", "FEPO", "FEPS", "FEPT", "FEPTA", "FEPTP", "FEQU", "FESM", "FEST", "FEWE", "FEYE" ] }, "OB_FeeFrequency1Code_3": { "description": "How frequently the fee/charge is calculated", "type": "string", "enum": [ "FEAC", "FEAO", "FECP", "FEDA", "FEHO", "FEI", "FEMO", "FEOA", "FEOT", "FEPC", "FEPH", "FEPO", "FEPS", "FEPT", "FEPTA", "FEPTP", "FEQU", "FESM", "FEST", "FEWE", "FEYE" ] }, "OB_FeeFrequency1Code_4": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "type": "string", "enum": [ "FEAC", "FEAO", "FECP", "FEDA", "FEHO", "FEI", "FEMO", "FEOA", "FEOT", "FEPC", "FEPH", "FEPO", "FEPS", "FEPT", "FEPTA", "FEPTP", "FEQU", "FESM", "FEST", "FEWE", "FEYE" ] }, "OB_FeeType1Code": { "description": "Fee/Charge Type", "type": "string", "enum": [ "FEPF", "FTOT", "FYAF", "FYAM", "FYAQ", "FYCP", "FYDB", "FYMI", "FYXX" ] }, "OB_InterestCalculationMethod1Code": { "description": "Methods of calculating interest", "type": "string", "enum": [ "ITCO", "ITOT", "ITSI" ] }, "OB_InterestFixedVariableType1Code": { "description": "Type of interest rate, Fixed or Variable", "type": "string", "enum": [ "INFI", "INVA" ] }, "OB_InterestRateType1Code_0": { "description": "Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)", "type": "string", "enum": [ "INBB", "INFR", "INGR", "INLR", "INNE", "INOT" ] }, "OB_InterestRateType1Code_1": { "description": "Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount)", "type": "string", "enum": [ "INBB", "INFR", "INGR", "INLR", "INNE", "INOT" ] }, "OB_MinMaxType1Code": { "description": "Min Max type", "type": "string", "enum": [ "FMMN", "FMMX" ] }, "OB_OtherCodeType1_0": { "type": "object", "required": [ "Name", "Description" ], "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OB_OtherCodeType1_1": { "type": "object", "required": [ "Name", "Description" ], "description": "Other application frequencies that are not available in the standard code list", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OB_OtherCodeType1_2": { "type": "object", "required": [ "Name", "Description" ], "description": "Other calculation frequency which is not available in the standard code set.", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OB_OtherCodeType1_3": { "type": "object", "required": [ "Name", "Description" ], "description": "Other Fee type which is not available in the standard code set", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OB_OtherCodeType1_4": { "type": "object", "required": [ "Name", "Description" ], "description": "Other fee rate type code which is not available in the standard code set", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OB_OtherCodeType1_5": { "type": "object", "required": [ "Name", "Description" ], "description": "Other fee rate type which is not in the standard rate type list", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OB_OtherCodeType1_6": { "type": "object", "required": [ "Name", "Description" ], "description": "Other application frequencies not covered in the standard code list", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OB_OtherCodeType1_7": { "type": "object", "required": [ "Name", "Description" ], "description": "Other calculation frequency which is not available in standard code set.", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OB_OtherCodeType1_8": { "type": "object", "required": [ "Name", "Description" ], "description": "Other fee rate type which is not available in the standard code set", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OB_OtherFeeChargeDetailType": { "type": "object", "required": [ "FeeCategory", "Name", "Description" ], "description": "Other Fee/charge type which is not available in the standard code set", "properties": { "Code": { "$ref": "#/definitions/OB_CodeMnemonic" }, "FeeCategory": { "$ref": "#/definitions/OB_FeeCategory1Code" }, "Name": { "$ref": "#/definitions/Name_3" }, "Description": { "$ref": "#/definitions/Description_3" } } }, "OB_OverdraftFeeType1Code": { "description": "Overdraft fee type", "type": "string", "enum": [ "FBAO", "FBAR", "FBEB", "FBIT", "FBOR", "FBOS", "FBSC", "FBTO", "FBUB", "FBUT", "FTOT", "FTUT" ] }, "OB_Period1Code": { "description": "Period e.g. day, week, month etc. for which the fee/charge is capped", "type": "string", "enum": [ "PACT", "PDAY", "PHYR", "PMTH", "PQTR", "PWEK", "PYER" ] }, "OB_Rate1_0": { "description": "Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount)", "type": "string", "pattern": "^(-?\\\\d{1,3}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "OB_Rate1_1": { "description": "Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount)", "type": "string", "pattern": "^(-?\\\\d{1,3}){1}(\\\\.\\\\d{1,4}){0,1}$" }, "PartyId": { "description": "A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.", "type": "string", "minLength": 1, "maxLength": 40 }, "PartyNumber": { "description": "Number assigned by an agent to identify its customer.", "type": "string", "minLength": 1, "maxLength": 35 }, "PhoneNumber_0": { "description": "Collection of information that identifies a phone number, as defined by telecom services.", "type": "string", "pattern": "\\+[0-9]{1,3}-[0-9()+\\-]{1,30}" }, "PhoneNumber_1": { "description": "Collection of information that identifies a mobile phone number, as defined by telecom services.", "type": "string", "pattern": "\\+[0-9]{1,3}-[0-9()+\\-]{1,30}" }, "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 }, "ProprietaryBankTransactionCodeStructure1": { "type": "object", "required": [ "Code" ], "description": "Set of elements to fully identify a proprietary bank transaction code.", "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 } } }, "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 }, "ScheduledPaymentDateTime": { "description": "The date on which the scheduled payment will be made.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" }, "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 }, "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 }, "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 }, "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. \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" }, "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 }, "StatusUpdateDateTime": { "description": "Date and time at which the resource status was updated.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" }, "StreetName": { "description": "Name of a street or thoroughfare.", "type": "string", "minLength": 1, "maxLength": 70 }, "TownName": { "description": "Name of a built-up area, with defined boundaries, and a local government.", "type": "string", "minLength": 1, "maxLength": 35 }, "TransactionId": { "description": "Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.", "type": "string", "minLength": 1, "maxLength": 210 }, "TransactionInformation": { "description": "Further details of the transaction. \nThis is the transaction narrative, which is unstructured text.", "type": "string", "minLength": 1, "maxLength": 500 }, "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": 35 }, "Type_0": { "description": "Statement rate type, in a coded form.", "type": "string", "minLength": 1, "maxLength": 40 }, "Type_1": { "description": "Statement value type, in a coded form.", "type": "string", "minLength": 1, "maxLength": 40 }, "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.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" } } }