openapi: 3.0.0 info: title: Account Information API description: > In this document, you'll find the steps your organization needs to take to use our API services. Included in this guide are details of request and response messages used to support your organization’s integration. The intended audience for this document are **Technical Architects**, **Development Engineers**, **Test Engineers**, and **Operation & Maintenance Engineers** involved in development and support of your organization’s integration. Setting up our API Services is best completed with the assistance of your organization’s IT team, or someone with experience and knowledge of application programming interfaces. This should include experience with **JSON payloads**, **security** and **public key infrastructure (PKI)**. This Document describes the following request and response structure of HSBCnet - Account Information API. For detail implementation guidelines, please refer to the respective section from [develop.hsbc.com](https://develop.hsbc.com/ob-api-documentation/account-information-uk-personal-v319) version: 3.1.11 x-konfig-ignore: potential-incorrect-type: true servers: - url: https://sandbox.ob.hsbcnet.com/mock/ce/obie/open-banking/v3.1/aisp tags: - description: Manage Account Access Consents name: Account Access Consents - name: Accounts - description: Get Scheduled Payments name: Scheduled Payments - description: Get Standing Orders name: Standing Orders - description: Get Transactions name: Transactions - description: Get Balances name: Balances - description: Get Beneficiaries name: Beneficiaries - description: Get Parties name: Parties - description: Get Products name: Products - name: Direct Debits paths: /account-access-consents: post: tags: - Account Access Consents summary: Create Account Access Consents operationId: AccountAccessConsents_createConsent security: - BearerAuth: [] - TPPOAuth2Security: - accounts description: >- This endpoint enables TPP to create account access consent. Supports all product types -Personal Current Account, Savings Account, Credit Cards, Foreign Currency Accounts, Global Money, Working Capital parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: content: application/json: schema: $ref: '#/components/schemas/OBReadConsent1' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadConsent1' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadConsent1' required: true responses: '201': $ref: '#/components/responses/201AccountAccessConsentsCreated' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '415': $ref: '#/components/responses/415Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /account-access-consents/{ConsentId}: get: tags: - Account Access Consents summary: Get Account Access Consents operationId: AccountAccessConsents_getByConsentId security: - BearerAuth: [] - TPPOAuth2Security: - accounts description: >- This endpoint enables TPP to get account access consent by ConsentId. Supports all product types -Personal Current Account, Savings Account, Credit Cards, Foreign Currency Accounts, Global Money Working Capital parameters: - $ref: '#/components/parameters/ConsentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountAccessConsentsConsentIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' delete: tags: - Account Access Consents summary: Delete Account Access Consents operationId: AccountAccessConsents_deleteConsent security: - BearerAuth: [] - TPPOAuth2Security: - accounts description: This endpoint enables TPP to delete account access consent parameters: - $ref: '#/components/parameters/ConsentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '204': $ref: '#/components/responses/204AccountAccessConsentsConsentIdDeleted' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /accounts: get: tags: - Accounts summary: Get Accounts operationId: Accounts_getAll security: - BearerAuth: [] - PSUOAuth2Security: - accounts description: >- This endpoint enables to get Accounts. Supports all product types -Personal Current Account, Savings Account, Credit Cards, Foreign Currency Accounts, Global Money, Working Capital parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /accounts/{AccountId}: get: tags: - Accounts summary: Get Accounts by AccountId operationId: Accounts_getBalancesByAccountId security: - BearerAuth: [] - PSUOAuth2Security: - accounts description: >- This endpoint enables to get Balances by AccountId. Supports all product types -Personal Current Account, Savings Account, Credit Cards, Foreign Currency Accounts, Global Money, Working Capital parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /accounts/{AccountId}/balances: get: tags: - Balances summary: Get Account Balances operationId: Balances_getByAccountId security: - BearerAuth: [] - PSUOAuth2Security: - accounts description: >- This endpoint enables to get Balances by AccountId. Supports all product types -Personal Current Account, Savings Account, Credit Cards, Foreign Currency Accounts, Global Money, Working Capital parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdBalancesRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /accounts/{AccountId}/direct-debits: get: tags: - Direct Debits summary: Get Account Direct Debits operationId: DirectDebits_getByAccountId security: - BearerAuth: [] - PSUOAuth2Security: - accounts description: >- This endpoint enables to get Direct Debits by AccountId. Supported product type is Personal Current Account parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdDirectDebitsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /accounts/{AccountId}/scheduled-payments: get: tags: - Scheduled Payments summary: Get Account Scheduled Payments operationId: ScheduledPayments_getByAccountId security: - BearerAuth: [] - PSUOAuth2Security: - accounts description: >- This endpoint enables to get Scheduled Payments by AccountId. Supported product types -Personal Current Account, Savings Account, Foreign Currency Accounts, Global Money. parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdScheduledPaymentsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /accounts/{AccountId}/standing-orders: get: tags: - Standing Orders summary: Get Account Standing Orders operationId: StandingOrders_getByAccountId security: - BearerAuth: [] - PSUOAuth2Security: - accounts description: >- This endpoint enables to get Standing Orders by AccountId. Supported product types -Personal Current Account, Foreign Currency Accounts. parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStandingOrdersRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /accounts/{AccountId}/transactions: get: tags: - Transactions summary: Get Account Transactions operationId: Transactions_getByAccountId security: - BearerAuth: [] - PSUOAuth2Security: - accounts description: >- This endpoint enables to get account Transactions by AccountId. Supports all product types -Personal Current Account, Savings Account, Credit Cards, Foreign Currency Accounts, Global Money, Working Capital parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/FromBookingDateTimeParam' - $ref: '#/components/parameters/ToBookingDateTimeParam' responses: '200': $ref: '#/components/responses/200AccountsAccountIdTransactionsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /accounts/{AccountId}/beneficiaries: get: tags: - Beneficiaries summary: Get Account Beneficiaries operationId: Beneficiaries_getByAccountId security: - BearerAuth: [] - PSUOAuth2Security: - accounts description: This endpoint enables to get Beneficiaries by AccountId parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdBeneficiariesRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /accounts/{AccountId}/parties: get: tags: - Parties summary: Get Account Parties operationId: Parties_getByAccountId security: - BearerAuth: [] - PSUOAuth2Security: - accounts description: This endpoint enables to get Parties by AccountId parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdPartiesRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' /accounts/{AccountId}/product: get: tags: - Products summary: Get Account Products operationId: Products_getByAccountId security: - BearerAuth: [] - PSUOAuth2Security: - accounts description: This endpoint enables to get Products by AccountId parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdProductRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' components: parameters: FromBookingDateTimeParam: description: >- The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. in: query name: fromBookingDateTime schema: type: string format: date-time example: '2023-01-04T13:21:07+00:00' ToBookingDateTimeParam: description: >- The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. in: query name: toBookingDateTime schema: type: string format: date-time example: '2023-02-04T13:21:07+00:00' FromStatementDateTimeParam: description: >- The UTC ISO 8601 Date Time to filter statements FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. in: query name: fromStatementDateTime schema: type: string format: date-time example: '2023-01-04T13:21:07+00:00' ToStatementDateTimeParam: description: >- The UTC ISO 8601 Date Time to filter statements TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. in: query name: toStatementDateTime schema: type: string format: date-time example: '2023-02-04T13:21:07+00:00' ConsentId: description: ConsentId name: ConsentId in: path required: true schema: type: string example: 7404e99b-1a4d-4b08-b441-c327661527f0 AccountId: description: AccountId name: AccountId in: path required: true schema: type: string example: ThR-RpLMV5lZzDu8vrfEFg StatementId: description: StatementId name: StatementId in: path required: true schema: type: string example: StatementId Authorization1: description: >- An authorisation token which was obtained from an authorisation server using Client Credentials Grant (https://www.rfc-editor.org/rfc/rfc6749#section-4.4). The obtained token must be sent using 'Bearer' scheme (https://tools.ietf.org/html/rfc6750#section-2) for this request in: header name: Authorization required: true example: Bearer LbGDbcFVVfE-ngpjj8KaH5wrEfg schema: type: string Authorization2: description: >- An authorisation token which was obtained from an authorisation server using Authorisation Code Grant (https://www.rfc-editor.org/rfc/rfc6749#section-4.1). The obtained token must be sent using 'Bearer' scheme (https://tools.ietf.org/html/rfc6750#section-2) for this request in: header name: Authorization required: true example: Bearer GtbuGXK9ByYYHX-Fg9cT_8b31S8 schema: type: string x-customer-user-agent: description: Indicates the user-agent that the PSU is using. in: header name: x-customer-user-agent required: false schema: type: string example: >- Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36 x-fapi-customer-ip-address: description: The PSU's IP address if the PSU is currently logged in with the TPP. in: header name: x-fapi-customer-ip-address required: false schema: type: string pattern: >- ^((((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\s?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))\s?),?\s?)+$ example: 12.201.45.125 x-fapi-auth-date: description: >- The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC in: header name: x-fapi-auth-date required: false schema: type: string 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)$ example: Tue, 18 Apr 2023 14:42:25 UTC x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. in: header name: x-fapi-interaction-id required: false schema: type: string example: 20177a90-5e29-43ba-bea0-cc6c344a9d32 x-idempotency-key: description: | Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. name: x-idempotency-key in: header required: true schema: type: string maxLength: 40 pattern: ^(?!\s)(.*)(\S)$ example: igxlwFGgIk015ImMlH4d x-jws-signature: description: A detached JWS signature of the body of the payload. in: header name: x-jws-signature required: true schema: type: string example: >- eyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCI6MTY3MzMzNjQ0OSwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC90YW4iOiJkd3U5OTZ2dzIxOTFmLmNsb3VkZnJvbnQubmV0IiwiY3JpdCI6WyJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lhdCIsImh0dHA6XC9cL29wZW5iYW5raW5nLm9yZy51a1wvdGFuIiwiaHR0cDpcL1wvb3BlbmJhbmtpbmcub3JnLnVrXC9pc3MiXSwia2lkIjoiZXh0ZXJuYWxfMjAyMiIsInR5cCI6IkpPU0UiLCJodHRwOlwvXC9vcGVuYmFua2luZy5vcmcudWtcL2lzcyI6IkM9R0IsTD1Mb25kb24sTz1IU0JDIEdyb3VwIE1hbmFnZW1lbnQgU2VydmljZXMgTGltaXRlZCxPVT1PcGVuIEJhbmtpbmcgU2hhcmVkIFNlcnZpY2VzLENOPVByZXByb2QtUFNEMi1FeHRlcm5hbC1TaWduYXR1cmUuaHNiYy5jby51ayIsImFsZyI6IlBTMjU2In0..VKQA7mVLNwGPUpAngcvtyumGa9heFwrVSatjlnbnDBpeJnNH9JAo66IqyG0VKFlVE53K-RY47ka7h2ugAAjJnzkGhqxVmvI5K0UdIH7h1ctasTZzU9He6jI-HI5YIR0Mz7myVTDDiP0BHg22WyftzdudaXkgyRJNk8BEHpLWO4kWMuXX6AO6u0rjnsMf1lYuroAe18N2M5XTbWJ0CbJvQfNL_OgPbKpAhzF-tuNoN_9qnYXa2oP-K2GbaW6Chmu4DKIcLX5vswAmXbQuIRfeckou3rk4-VDAmeA1Izm-P1pYsVFAjOVHK1sYHnwbQBY8GMutYsCOn5ZRCtMy1C_IjA responses: 201AccountAccessConsentsCreated: description: Created headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 20177a90-5e29-43ba-bea0-cc6c344a9d32 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadConsentResponse1' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadConsentResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadConsentResponse1' 200AccountAccessConsentsConsentIdRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 20177a90-5e29-43ba-bea0-cc6c344a9d32 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadConsentResponse1' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadConsentResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadConsentResponse1' 204AccountAccessConsentsConsentIdDeleted: description: No Content headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 20177a90-5e29-43ba-bea0-cc6c344a9d32 schema: type: string 200AccountsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 20177a90-5e29-43ba-bea0-cc6c344a9d32 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadAccount6' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadAccount6' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadAccount6' 200AccountsAccountIdRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 20177a90-5e29-43ba-bea0-cc6c344a9d32 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadAccount6' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadAccount6' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadAccount6' 200AccountsAccountIdBalancesRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 20177a90-5e29-43ba-bea0-cc6c344a9d32 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadBalance1' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadBalance1' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadBalance1' 200BalancesRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 20177a90-5e29-43ba-bea0-cc6c344a9d32 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadBalance1' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadBalance1' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadBalance1' 200AccountsAccountIdBeneficiariesRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 20177a90-5e29-43ba-bea0-cc6c344a9d32 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadBeneficiary5' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadBeneficiary5' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadBeneficiary5' 200BeneficiariesRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 20177a90-5e29-43ba-bea0-cc6c344a9d32 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadBeneficiary5' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadBeneficiary5' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadBeneficiary5' 200AccountsAccountIdDirectDebitsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadDirectDebit2' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadDirectDebit2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadDirectDebit2' 200DirectDebitsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadDirectDebit2' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadDirectDebit2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadDirectDebit2' 200AccountsAccountIdOffersRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadOffer1' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadOffer1' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadOffer1' 200OffersRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadOffer1' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadOffer1' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadOffer1' 200AccountsAccountIdPartiesRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadParty3' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadParty3' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadParty3' 200AccountsAccountIdPartyRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadParty2' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadParty2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadParty2' 200AccountsAccountIdProductRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadProduct2' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadProduct2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadProduct2' 200ProductsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadProduct2' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadProduct2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadProduct2' 200AccountsAccountIdScheduledPaymentsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadScheduledPayment3' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadScheduledPayment3' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadScheduledPayment3' 200ScheduledPaymentsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadScheduledPayment3' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadScheduledPayment3' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadScheduledPayment3' 200AccountsAccountIdStandingOrdersRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadStandingOrder6' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadStandingOrder6' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadStandingOrder6' 200StandingOrdersRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: 7507f324-b4e6-43f4-8497-153930017bd9 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadStandingOrder6' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadStandingOrder6' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadStandingOrder6' 200AccountsAccountIdStatementsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadStatement2' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadStatement2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadStatement2' 200AccountsAccountIdStatementsStatementIdRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadStatement2' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadStatement2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadStatement2' 200AccountsAccountIdStatementsStatementIdFileRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 schema: type: string content: application/json: schema: $ref: '#/components/schemas/File' application/json; charset=utf-8: schema: $ref: '#/components/schemas/File' application/jose+jwe: schema: $ref: '#/components/schemas/File' 200AccountsAccountIdStatementsStatementIdTransactionsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadTransaction6' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadTransaction6' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadTransaction6' 200StatementsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadStatement2' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadStatement2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadStatement2' 200AccountsAccountIdTransactionsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadTransaction6' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadTransaction6' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadTransaction6' 200TransactionsRead: description: OK headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadTransaction6' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadTransaction6' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadTransaction6' 400Error: description: Bad request headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 401Error: description: Unauthorized headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 403Error: description: Forbidden headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 404Error: description: Not found headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string example: cc0fe5bf-0522-4cd4-8d08-417cf8f81841 406Error: description: Not Acceptable headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string example: 7507f324-b4e6-43f4-8497-153930017bd9 415Error: description: Unsupported Media Type headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string example: 7507f324-b4e6-43f4-8497-153930017bd9 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait schema: type: integer x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. schema: type: string example: 1452697e-68ff-499e-a1f2-980da8e2cea1 500Error: description: Internal Server Error headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' securitySchemes: BearerAuth: description: >- Authorization scheme used to authenticate & authorize access to a protected resource on a web server. It is used in conjunction with the OAuth 2.0 protocol for securing API endpoints. type: http scheme: bearer TPPOAuth2Security: description: >- TPP client credential authorisation flow with the ASPSP. Token URL to be used by TPP to obtain a token. Check the well-known configuration endpoint, the 'token_endpoint' property. type: oauth2 flows: clientCredentials: tokenUrl: /obie/open-banking/v1.1/oauth2/token scopes: accounts: Ability to read Accounts information PSUOAuth2Security: 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. Authorization URL to be used by TPP to redirect the PSU in order to start consent authorization journey. Check the well-known configuration endpoint, the 'authorization_endpoint' property. Token URL to be used by TPP to obtain a token. Check the well-known configuration endpoint, the 'token_endpoint' property. type: oauth2 flows: authorizationCode: authorizationUrl: /obie/open-banking/v1.1/oauth2/authorize tokenUrl: /obie/open-banking/v1.1/oauth2/token scopes: accounts: Ability to read Accounts information schemas: 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 example: WQEF7_6iy3HEWspIs8CDOw ActiveOrHistoricCurrencyCode_0: description: >- Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account. type: string pattern: ^[A-Z]{3,3}$ example: x5555 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}$ example: USD 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 example: 17 Dean's Yard, Westminster, London 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 example: BeneficiaryId BookingDateTime: description: >- Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T13:22:20+00:00' BuildingNumber: description: Number that identifies the position of a building on a street. type: string minLength: 1 maxLength: 16 example: 24A CountryCode: description: Nation with its own government, occupying a particular territory. type: string pattern: ^[A-Z]{2,2}$ example: GB CountrySubDivision: description: Identifies a subdivision of a country eg, state, region, county. type: string minLength: 1 maxLength: 35 example: Salzburg CreationDateTime: description: >- Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T13:22:20+00:00' DateTime: description: >- Date and time associated with the date time type.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T13:22:20+00:00' DebtorReference: description: >- A reference value provided by the PSU to the PISP while setting up the scheduled payment. type: string minLength: 1 maxLength: 35 example: A sample referance. Description_0: description: Specifies the description of the account type. type: string minLength: 1 maxLength: 35 example: Test Description Description_1: description: Description that may be available for the statement fee. type: string minLength: 1 maxLength: 128 example: Test Description Description_2: description: Description that may be available for the statement interest. type: string minLength: 1 maxLength: 128 example: Test Description Description_3: description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: Test Description 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 example: DDid EmailAddress: description: Address for electronic mail (e-mail). type: string minLength: 1 maxLength: 256 example: '@google.com' EndDateTime: description: >- Date and time at which the statement period ends.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-03-04T13:21:59+00:00' 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-02-04T13:21:59+00:00' 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T13:21:59+00:00' Frequency_1: description: >- Individual Definitions: NotKnown - Not Known EvryDay - Every day EvryWorkgDay - Every working day IntrvlDay - An interval specified in number of calendar days (02 to 31) IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-05 to -01, 01 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: NotKnown (ScheduleCode) EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlDay:NoOfDay (ScheduleCode + NoOfDay) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: NotKnown EvryDay EvryWorkgDay IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]) IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ type: string pattern: >- ^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ example: Frequency_1 FullLegalName: description: Specifies a character string with a maximum length of 350 characters. type: string minLength: 1 maxLength: 350 example: PTTestB7003 ISODateTime: description: >- All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T13:21:59+00:00' 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 example: Sample Identyfication0 Identification_1: description: Unique and unambiguous identification of the servicing institution. type: string minLength: 1 maxLength: 35 example: example for Identification_1 Identification_2: description: >- Unique and unambiguous identification of a financial institution or a branch of a financial institution. type: string minLength: 1 maxLength: 35 example: Identification_2 LastPaymentDateTime: description: >- The date on which the last (most recent) payment for a Standing Order schedule was made.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T13:21:59+00:00' Links: description: Links relevant to the payload type: object properties: Self: description: A link to the same resource used for the current request. type: string format: uri First: type: string format: uri Prev: type: string format: uri Next: type: string format: uri Last: type: string format: uri required: - Self 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 example: '40010000010901' MaturityDate: description: >- Maturity date of the account.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T13:21:59+00:00' Meta: title: MetaData description: Meta Data relevant to the payload type: object properties: TotalPages: type: integer FirstAvailableDateTime: $ref: '#/components/schemas/ISODateTime' LastAvailableDateTime: $ref: '#/components/schemas/ISODateTime' 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. Note, the account name is not the product name or the nickname of the account. type: string minLength: 1 maxLength: 350 example: ABC Name_1: description: >- Name by which an agent is known and which is usually used to identify that agent. type: string minLength: 1 maxLength: 140 example: ABC Name_2: description: Name of Service User. type: string minLength: 1 maxLength: 70 example: ABC Name_3: description: >- Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 350 example: ABC Name_4: description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: ABC 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T13:21:59+00:00' 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 example: CAB ALL CARE NumberOfPayments: description: >- Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. type: string minLength: 1 maxLength: 35 example: '10' 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 example: 1 Number_1: description: >- fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: integer example: 10 OBAccount6: description: >- Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched: * Data.Currency * Data.AccountType * Data.AccountSubType For all other accounts, the fields must be populated by the ASPSP. type: object required: - AccountId properties: AccountId: $ref: '#/components/schemas/AccountId' Status: $ref: '#/components/schemas/OBAccountStatus1Code' StatusUpdateDateTime: $ref: '#/components/schemas/StatusUpdateDateTime' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_0' AccountType: $ref: '#/components/schemas/OBExternalAccountType1Code' AccountSubType: $ref: '#/components/schemas/OBExternalAccountSubType1Code' Description: $ref: '#/components/schemas/Description_0' Nickname: $ref: '#/components/schemas/Nickname' OpeningDate: $ref: '#/components/schemas/OpeningDate' MaturityDate: $ref: '#/components/schemas/MaturityDate' SwitchStatus: $ref: '#/components/schemas/OBExternalSwitchStatusCode' Account: type: array items: description: Provides the details to identify an account. type: object required: - SchemeName - Identification properties: SchemeName: description: >- Name of the identification scheme, in a coded form as published in an external list. type: string enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Wallet example: UK.OBIE.BBAN Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Servicer: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification5_0 OBAccount6Basic: description: >- Unambiguous identification of the account to which credit and debit entries are made. type: object required: - AccountId - Currency - AccountType - AccountSubType properties: AccountId: $ref: '#/components/schemas/AccountId' Status: $ref: '#/components/schemas/OBAccountStatus1Code' StatusUpdateDateTime: $ref: '#/components/schemas/StatusUpdateDateTime' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_0' AccountType: $ref: '#/components/schemas/OBExternalAccountType1Code' AccountSubType: $ref: '#/components/schemas/OBExternalAccountSubType1Code' Description: $ref: '#/components/schemas/Description_0' Nickname: $ref: '#/components/schemas/Nickname' OpeningDate: $ref: '#/components/schemas/OpeningDate' MaturityDate: $ref: '#/components/schemas/MaturityDate' SwitchStatus: $ref: '#/components/schemas/OBExternalSwitchStatusCode' OBAccount6Detail: description: >- Unambiguous identification of the account to which credit and debit entries are made. type: object required: - AccountId - Currency - AccountType - AccountSubType - Account properties: AccountId: $ref: '#/components/schemas/AccountId' Status: $ref: '#/components/schemas/OBAccountStatus1Code' StatusUpdateDateTime: $ref: '#/components/schemas/StatusUpdateDateTime' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_0' AccountType: $ref: '#/components/schemas/OBExternalAccountType1Code' AccountSubType: $ref: '#/components/schemas/OBExternalAccountSubType1Code' Description: $ref: '#/components/schemas/Description_0' Nickname: $ref: '#/components/schemas/Nickname' OpeningDate: $ref: '#/components/schemas/OpeningDate' MaturityDate: $ref: '#/components/schemas/MaturityDate' SwitchStatus: $ref: '#/components/schemas/OBExternalSwitchStatusCode' Account: type: array items: description: Provides the details to identify an account. type: object required: - SchemeName - Identification properties: SchemeName: $ref: '#/components/schemas/OBExternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Servicer: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification5_0 OBAccountStatus1Code: description: Specifies the status of account resource in code form. type: string enum: - Deleted - Disabled - Enabled - Pending - ProForma example: Enabled OBActiveCurrencyAndAmount_SimpleType: description: >- A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. type: string pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ example: '1000' OBActiveOrHistoricCurrencyAndAmount_0: description: The amount of the most recent direct debit collection. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_1: 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. Usage: This amount has to be transported unchanged through the transaction chain. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_10: description: Transaction charges to be paid by the charge bearer. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_11: description: The amount of the last (most recent) Standing Order instruction. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_2: description: The amount of the first Standing Order type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_3: description: The amount of the next Standing Order. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_4: description: The amount of the final Standing Order type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_5: description: Amount of money associated with the statement benefit type. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_6: description: Amount of money associated with the statement fee type. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_7: description: Amount of money associated with the statement interest amount type. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_8: description: Amount of money associated with the amount type. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBActiveOrHistoricCurrencyAndAmount_9: description: Amount of money in the cash transaction entry. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBAddressTypeCode: description: Identifies the nature of the postal address. type: string enum: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement example: Business OBBCAData1: title: BCA type: object properties: ProductDetails: title: ProductDetails type: object properties: Segment: title: 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. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to BCA products, they are segmented in relation to different markets that they wish to focus on. 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. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With 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: title: FeeFreeLength description: The length/duration of the fee free period type: number format: float example: 10 FeeFreeLengthPeriod: title: FeeFreeLengthPeriod description: >- The unit of period (days, weeks, months etc.) of the promotional length type: string enum: - Day - Half Year - Month - Quarter - Week - Year example: Day Notes: title: Notes description: Optional additional notes to supplement the Core product details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 CreditInterest: title: CreditInterest description: >- Details about the interest that may be payable to the BCA account holders type: object properties: TierBandSet: title: TierBandSet description: >- The group of tiers or bands for which credit interest can be applied. type: array items: description: >- The group of tiers or bands for which credit interest can be applied. type: object properties: TierBandMethod: title: TierBandMethod description: >- The methodology of how credit interest is paid/applied. It can be:- 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest 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. 3. Whole The same interest rate is applied irrespective of the BCA balance type: string enum: - Banded - Tiered - Whole example: Whole CalculationMethod: title: CalculationMethod description: Methods of calculating interest type: string enum: - Compound - SimpleInterest example: Compound Destination: title: Destination description: >- Describes whether accrued interest is payable only to the BCA or to another bank account type: string enum: - PayAway - SelfCredit example: PayAway Notes: title: Notes description: >- Optional additional notes to supplement the Tier Band Set details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 TierBand: title: TierBand description: Tier Band Details type: array items: description: Tier Band Details type: object properties: Identification: title: Identification description: >- Unique and unambiguous identification of a Tier Band for a BCA. type: string minLength: 1 maxLength: 35 example: '40180000173916' TierValueMinimum: title: TierValueMinimum description: >- Minimum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: '100' TierValueMaximum: title: TierValueMaximum description: >- Maximum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: '1000' CalculationFrequency: title: CalculationFrequency description: >- How often is credit interest calculated for the account. type: string enum: - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly example: Monthly ApplicationFrequency: title: 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. type: string enum: - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly example: Weekly DepositInterestAppliedCoverage: title: DepositInterestAppliedCoverage description: Amount on which Interest applied. type: string enum: - Banded - Tiered - Whole example: Whole FixedVariableInterestRateType: title: FixedVariableInterestRateType description: Type of interest rate, Fixed or Variable type: string enum: - Fixed - Variable example: Variable AER: title: 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. Read 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}$ example: 1,5% BankInterestRateType: title: BankInterestRateType description: >- Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA. type: string enum: - Gross - Other example: Gross BankInterestRate: title: BankInterestRate description: Bank Interest for the BCA product type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ example: 0.25% Notes: title: Notes description: >- Optional additional notes to supplement the Tier Band details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherBankInterestType: title: OtherBankInterestType description: >- Other interest rate types which are not available in the standard code list type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Bobby Lee Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description OtherApplicationFrequency: title: OtherApplicationFrequency description: >- Other application frequencies that are not available in the standard code list type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Jerry Smith Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description OtherCalculationFrequency: title: OtherCalculationFrequency description: >- Other calculation frequency which is not available in the standard code set. type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Jerry Smith Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description required: - TierValueMinimum - ApplicationFrequency - FixedVariableInterestRateType - AER minItems: 1 required: - TierBandMethod - Destination - TierBand minItems: 1 required: - TierBandSet Overdraft: title: Overdraft description: Borrowing details type: object properties: Notes: title: Notes description: Associated Notes about the overdraft rates type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBandSet: title: OverdraftTierBandSet description: Tier band set details type: array items: description: Tier band set details type: object properties: TierBandMethod: title: TierBandMethod description: >- The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. type: string enum: - Banded - Tiered - Whole example: Banded OverdraftType: title: 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: - Committed - OnDemand example: Committed Identification: title: Identification description: >- Unique and unambiguous identification of a Tier Band for a overdraft product. type: string minLength: 1 maxLength: 35 example: idstring AuthorisedIndicator: title: AuthorisedIndicator description: >- Indicates if the Overdraft is authorised (Y) or unauthorised (N) type: boolean example: true BufferAmount: title: 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}$ example: '100' Notes: title: Notes description: >- Optional additional notes to supplement the overdraft Tier Band Set details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBand: title: OverdraftTierBand description: Provides overdraft details for a specific tier or band type: array items: description: Provides overdraft details for a specific tier or band type: object properties: Identification: title: Identification description: >- Unique and unambiguous identification of a Tier Band for a overdraft. type: string minLength: 1 maxLength: 35 TierValueMin: title: TierValueMin description: Minimum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMax: title: TierValueMax description: Maximum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ EAR: title: EAR description: >- EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft. type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ RepresentativeAPR: title: RepresentativeAPR description: >- An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account. type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ example: '0' AgreementLengthMin: title: AgreementLengthMin description: >- Specifies the minimum length of a band for a fixed overdraft agreement type: number format: float example: 2.2 AgreementLengthMax: title: AgreementLengthMax description: >- Specifies the maximum length of a band for a fixed overdraft agreement type: number format: float example: 1.1 AgreementPeriod: title: AgreementPeriod description: >- Specifies the period of a fixed length overdraft agreement type: string enum: - Day - Half Year - Month - Quarter - Week - Year example: Day OverdraftInterestChargingCoverage: title: 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: - Banded - Tiered - Whole example: Whole BankGuaranteedIndicator: title: 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: title: Notes description: >- Optional additional notes to supplement the Tier/band details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeesCharges: title: OverdraftFeesCharges description: Overdraft fees and charges type: array items: description: Overdraft fees and charges type: object properties: OverdraftFeeChargeCap: title: 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 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: title: FeeType description: Fee/charge type which is being capped type: array items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans minItems: 1 example: AnnualReview MinMaxType: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum example: Minimum FeeCapOccurrence: title: 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. type: number format: float example: 0 FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: '0' CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year example: Day Notes: title: Notes description: >- Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Jerry Smith Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: smaple desc required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: title: OverdraftFeeChargeDetail description: Details about the fees/charges type: array items: description: Details about the fees/charges type: object properties: FeeType: title: FeeType description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans NegotiableIndicator: title: NegotiableIndicator description: >- Indicates whether fee and charges are negotiable type: boolean example: true OverdraftControlIndicator: title: OverdraftControlIndicator description: >- Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. type: boolean example: true IncrementalBorrowingAmount: title: IncrementalBorrowingAmount 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}$ example: '0' FeeAmount: title: FeeAmount 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}$ example: '0' FeeRate: title: FeeRate 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}$ example: '0' FeeRateType: title: FeeRateType description: >- Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string enum: - Gross - Other example: Other ApplicationFrequency: title: ApplicationFrequency description: >- Frequency at which the overdraft charge is applied to the account type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly example: Weekly CalculationFrequency: title: CalculationFrequency description: >- How often is the overdraft fee/charge calculated for the account. type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly example: Yearly Notes: title: Notes description: >- Free text for capturing any other info related to Overdraft Fees Charge Details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeeChargeCap: title: 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 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: title: FeeType description: Fee/charge type which is being capped 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: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum example: Minimum FeeCapOccurrence: title: 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. type: number format: float example: 0.25 FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: '33.1' CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year example: Day Notes: title: Notes description: >- Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Jerry Smith Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description required: - FeeType - MinMaxType OtherFeeType: title: OtherFeeType description: >- Other Fee type which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Jerry Smith Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description OtherFeeRateType: title: OtherFeeRateType description: >- Other fee rate type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Jerry Smith Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description OtherApplicationFrequency: title: OtherApplicationFrequency description: >- Other application frequencies that are not available in the standard code list type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: OBP Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: ABC Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: Desc required: - Name - Description OtherCalculationFrequency: title: OtherCalculationFrequency description: >- Other calculation frequency which is not available in the standard code set. type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: OBP Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: ABC Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: DESC required: - Name - Description required: - FeeType - ApplicationFrequency minItems: 1 required: - OverdraftFeeChargeDetail required: - TierValueMin minItems: 1 OverdraftFeesCharges: title: OverdraftFeesCharges description: Overdraft fees and charges details type: array items: description: Overdraft fees and charges details type: object properties: OverdraftFeeChargeCap: title: 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 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: title: FeeType description: Fee/charge type which is being capped 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: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum example: Minimum FeeCapOccurrence: title: 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. type: number format: float example: 1.1 FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: '0' CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year example: Day Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: SDR Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: Desc test required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: title: OverdraftFeeChargeDetail description: Details about the fees/charges type: array items: description: Details about the fees/charges type: object properties: FeeType: title: FeeType description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans NegotiableIndicator: title: NegotiableIndicator description: >- Indicates whether fee and charges are negotiable type: boolean example: true OverdraftControlIndicator: title: OverdraftControlIndicator description: >- Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. type: boolean example: true IncrementalBorrowingAmount: title: IncrementalBorrowingAmount 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}$ example: '0' FeeAmount: title: FeeAmount 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}$ example: '0' FeeRate: title: FeeRate 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}$ example: '0' FeeRateType: title: FeeRateType description: >- Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string enum: - Gross - Other example: Gross ApplicationFrequency: title: ApplicationFrequency description: >- Frequency at which the overdraft charge is applied to the account type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly example: Yearly CalculationFrequency: title: CalculationFrequency description: >- How often is the overdraft fee/charge calculated for the account. type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly example: Daily Notes: title: Notes description: >- Free text for capturing any other info related to Overdraft Fees Charge Details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeeChargeCap: title: 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 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: title: FeeType description: Fee/charge type which is being capped 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: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum example: Minimum FeeCapOccurrence: title: 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. type: number format: float example: 1.1 FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: '0' CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year example: Quarter Notes: title: Notes description: >- Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Bobby Lee Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description required: - FeeType - MinMaxType OtherFeeType: title: OtherFeeType description: >- Other Fee type which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Jerry Smith Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description OtherFeeRateType: title: OtherFeeRateType description: >- Other fee rate type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Jerry Smith Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description OtherApplicationFrequency: title: OtherApplicationFrequency description: >- Other application frequencies that are not available in the standard code list type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Jerry Smith Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description OtherCalculationFrequency: title: OtherCalculationFrequency description: >- Other calculation frequency which is not available in the standard code set. type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Bobby Lee Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: dsec. required: - Name - Description required: - FeeType - ApplicationFrequency minItems: 1 required: - OverdraftFeeChargeDetail required: - TierBandMethod - OverdraftTierBand minItems: 1 required: - OverdraftTierBandSet OtherFeesCharges: title: OtherFeesCharges description: >- Contains details of fees and charges which are not associated with either Overdraft or features/benefits type: array items: description: >- Contains details of fees and charges which are not associated with either Overdraft or features/benefits type: object properties: TariffType: title: TariffType description: TariffType which defines the fee and charges. type: string enum: - Electronic - Mixed - Other TariffName: title: TariffName description: Name of the tariff type: string minLength: 1 maxLength: 350 OtherTariffType: title: OtherTariffType description: Other tariff type which is not in the standard list. type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XXX Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Bobby Lee Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description FeeChargeDetail: title: FeeChargeDetail description: Other fees/charges details type: array items: description: Other fees/charges details type: object properties: FeeCategory: title: FeeCategory description: >- Categorisation of fees and charges into standard categories. type: string enum: - Other - Servicing FeeType: title: FeeType description: Fee/Charge Type type: string enum: - Other - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCAccountFeeQuarterly - ServiceCFixedTariff - ServiceCBusiDepAccBreakage - ServiceCMinimumMonthlyFee - ServiceCOther NegotiableIndicator: title: NegotiableIndicator description: >- Fee/charge which is usually negotiable rather than a fixed amount type: boolean example: true FeeAmount: title: FeeAmount 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}$ example: '0' FeeRate: title: FeeRate 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}$ example: '0' FeeRateType: title: FeeRateType description: >- Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) type: string enum: - Gross - Other example: Gross ApplicationFrequency: title: ApplicationFrequency description: How frequently the fee/charge is applied to the account type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly example: PerTransactionPercentage CalculationFrequency: title: CalculationFrequency description: How frequently the fee/charge is calculated type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly example: PerHour Notes: title: Notes description: >- Optional additional notes to supplement the fee/charge details. type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 FeeChargeCap: title: FeeChargeCap description: >- Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: array items: description: >- Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped 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: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum example: Minimum FeeCapOccurrence: title: FeeCapOccurrence description: >- fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float example: 0 FeeCapAmount: title: FeeCapAmount 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}$ example: '0' CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year example: Day Notes: title: Notes description: >- Free text for adding extra details for fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Bobby Lee Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description required: - FeeType - MinMaxType OtherFeeCategoryType: title: OtherFeeCategoryType type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Bobby Lee Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc required: - Name - Description OtherFeeType: title: OtherFeeType description: >- Other Fee/charge type which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC FeeCategory: title: FeeCategory description: >- Categorisation of fees and charges into standard categories. type: string enum: - Other - Servicing example: Other Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Bobby Lee Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - FeeCategory - Name - Description OtherFeeRateType: title: OtherFeeRateType description: >- Other fee rate type which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Bobby Lee Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc required: - Name - Description OtherApplicationFrequency: title: OtherApplicationFrequency description: >- Other application frequencies not covered in the standard code list type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Bobby Lee Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description OtherCalculationFrequency: title: OtherCalculationFrequency description: >- Other calculation frequency which is not available in standard code set. type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Jim Morrison Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description FeeApplicableRange: title: FeeApplicableRange description: >- Range or amounts or rates for which the fee/charge applies type: object properties: MinimumAmount: title: 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}$ example: '10' MaximumAmount: title: 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}$ example: '100' MinimumRate: title: 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}$ example: '0' MaximumRate: title: 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}$ example: '1' required: - FeeCategory - FeeType - ApplicationFrequency minItems: 1 FeeChargeCap: title: FeeChargeCap description: >- Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: array items: description: >- Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped 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: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum example: Minimum FeeCapOccurrence: title: FeeCapOccurrence description: >- fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float example: 3.41234 FeeCapAmount: title: FeeCapAmount 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}$ example: test value CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year example: Day Notes: title: Notes description: Free text for adding extra details for fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: ABC Name: title: Name description: Aaron Lomas type: string minLength: 1 maxLength: 70 example: John Pame Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: sample description required: - Name - Description required: - FeeType - MinMaxType required: - FeeChargeDetail OBBalanceType1Code: description: Balance type, in a coded form. type: string enum: - ClosingAvailable - ClosingBooked - Expected - ForwardAvailable - InterimAvailable - InterimBooked - OpeningAvailable - OpeningBooked - PreviouslyClosedBooked OBBankTransactionCodeStructure1: description: >- Set of elements used to fully identify the type of underlying transaction resulting in an entry. type: object required: - Code - SubCode properties: Code: description: Specifies the family within a domain. type: string SubCode: description: Specifies the sub-product family within a specific family. type: string OBBeneficiary5: description: TO DO type: object properties: AccountId: $ref: '#/components/schemas/AccountId' BeneficiaryId: $ref: '#/components/schemas/BeneficiaryId' BeneficiaryType: $ref: '#/components/schemas/OBBeneficiaryType1Code' Reference: $ref: '#/components/schemas/Reference' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' CreditorAgent: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification6_0 CreditorAccount: $ref: '#/components/schemas/OBCashAccount5_0' OBBeneficiary5Basic: type: object properties: AccountId: $ref: '#/components/schemas/AccountId' BeneficiaryId: $ref: '#/components/schemas/BeneficiaryId' BeneficiaryType: $ref: '#/components/schemas/OBBeneficiaryType1Code' Reference: $ref: '#/components/schemas/Reference' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' OBBeneficiary5Detail: type: object properties: AccountId: $ref: '#/components/schemas/AccountId' BeneficiaryId: $ref: '#/components/schemas/BeneficiaryId' BeneficiaryType: $ref: '#/components/schemas/OBBeneficiaryType1Code' Reference: $ref: '#/components/schemas/Reference' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' CreditorAgent: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification6_0 CreditorAccount: $ref: '#/components/schemas/OBCashAccount5_0' required: - CreditorAccount OBBranchAndFinancialInstitutionIdentification5_0: 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. type: object required: - SchemeName - Identification properties: SchemeName: $ref: >- #/components/schemas/OBExternalFinancialInstitutionIdentification4Code Identification: $ref: '#/components/schemas/Identification_1' OBBranchAndFinancialInstitutionIdentification5_1: 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. This is the servicer of the beneficiary account. type: object required: - SchemeName - Identification properties: SchemeName: $ref: >- #/components/schemas/OBExternalFinancialInstitutionIdentification4Code Identification: $ref: '#/components/schemas/Identification_1' OBBranchAndFinancialInstitutionIdentification6_0: 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. This is the servicer of the beneficiary account. type: object properties: SchemeName: $ref: >- #/components/schemas/OBExternalFinancialInstitutionIdentification4Code Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name_1' PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' OBBranchAndFinancialInstitutionIdentification6_1: description: Financial institution servicing an account for the creditor. type: object properties: SchemeName: $ref: >- #/components/schemas/OBExternalFinancialInstitutionIdentification4Code Identification: $ref: '#/components/schemas/Identification_2' Name: $ref: '#/components/schemas/Name_1' PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' OBBranchAndFinancialInstitutionIdentification6_2: description: Financial institution servicing an account for the debtor. type: object properties: SchemeName: $ref: >- #/components/schemas/OBExternalFinancialInstitutionIdentification4Code Identification: $ref: '#/components/schemas/Identification_2' Name: $ref: '#/components/schemas/Name_1' PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' OBCashAccount5_0: description: Provides the details to identify the beneficiary account. type: object required: - SchemeName - Identification properties: SchemeName: description: >- Name of the identification scheme, in a coded form as published in an external list. type: string enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber - UK.OBIE.Wallet example: UK.OBIE.BBAN Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' OBCashAccount5_1: description: Provides the details to identify the beneficiary account. type: object required: - SchemeName - Identification properties: SchemeName: $ref: '#/components/schemas/OBExternalAccountIdentification4Code' Identification: description: Beneficiary account identification. type: string minLength: 1 maxLength: 256 Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' OBCashAccount6_0: description: >- Unambiguous identification of the account of the creditor, in the case of a debit transaction. type: object properties: SchemeName: description: >- Name of the identification scheme, in a coded form as published in an external list. type: string enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber - UK.OBIE.Wallet example: UK.OBIE.BBAN Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' OBCashAccount6_1: description: >- Unambiguous identification of the account of the debtor, in the case of a crebit transaction. type: object properties: SchemeName: description: >- Name of the identification scheme, in a coded form as published in an external list. type: string enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber - UK.OBIE.Wallet example: UK.OBIE.BBAN Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' OBCreditDebitCode_0: description: |- Indicates whether the amount is a credit or a debit. Usage: A zero amount is considered to be a credit amount. type: string enum: - Credit - Debit example: Credit OBCreditDebitCode_1: description: Indicates whether the transaction is a credit or a debit entry. type: string enum: - Credit - Debit example: Debit OBCreditDebitCode_2: description: |- Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. type: string enum: - Credit - Debit example: Credit OBCurrencyExchange5: description: Set of elements used to provide details on the currency exchange. type: object required: - SourceCurrency - ExchangeRate properties: SourceCurrency: description: >- Currency from which an amount is to be converted in a currency conversion. type: string pattern: ^[A-Z]{3,3}$ example: EUR TargetCurrency: description: >- Currency into which an amount is to be converted in a currency conversion. type: string pattern: ^[A-Z]{3,3}$ example: USD 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}$ example: USD 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. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency). type: number example: 1 ContractIdentification: description: >- Unique identification to unambiguously identify the foreign exchange contract. type: string minLength: 1 maxLength: 35 example: '7774890001212' 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time InstructedAmount: 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. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' OBEntryStatus1Code: description: Status of a transaction entry on the books of the account servicer. type: string enum: - Booked - Pending - Rejected example: Booked OBTransactionMutability1Code: description: Specifies the Mutability of the Transaction record. type: string enum: - Mutable - Immutable example: Mutable OBError1: type: object properties: ErrorCode: description: Low level textual error code, e.g., UK.OBIE.Field.Missing type: string 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' OBIE doesn't standardise this field type: string minLength: 1 maxLength: 500 example: This action is not allowed on the account type in the request 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 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 example: ABC Id: description: >- A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. type: string minLength: 1 maxLength: 40 example: 1ec1bb5f-0dbd-46b9-a9eb-fa49a4e38315 Message: description: >- Brief Error message, e.g., 'There is something wrong with the request parameters provided' type: string minLength: 1 maxLength: 500 example: test error message Errors: items: $ref: '#/components/schemas/OBError1' type: array minItems: 1 required: - Code - Message - Errors OBExternalAccountIdentification4Code: description: >- Name of the identification scheme, in a coded form as published in an external list. type: string enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber example: UK.OBIE.BBAN OBExternalAccountRole1Code: description: A party’s role with respect to the related account. type: string 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 example: UK.OBIE.Administrator OBExternalAccountSubType1Code: description: Specifies the sub type of account (product family group). type: string enum: - ChargeCard - CreditCard - CurrentAccount - EMoney - Loan - Mortgage - PrePaidCard - Savings example: ChargeCard OBExternalAccountType1Code: description: Specifies the type of account (personal or business). type: string enum: - Business - Personal example: Personal OBExternalDirectDebitStatus1Code: description: Specifies the status of the direct debit in code form. type: string enum: - Active - Inactive example: Active OBExternalFinancialInstitutionIdentification4Code: description: >- Name of the identification scheme, in a coded form as published in an external list. type: string example: UK.OBIE.BICFI enum: - UK.OBIE.BICFI OBExternalSwitchStatusCode: description: Specifies the switch status for the account, in a coded form. type: string example: UK.CASS.NotSwitched enum: - UK.CASS.NotSwitched - UK.CASS.SwitchCompleted OBExternalLegalStructureType1Code: description: Legal standing of the party. type: string example: UK.OBIE.CI 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 example: Joint enum: - Delegate - Joint - Sole OBExternalScheduleType1Code: description: Specifies the scheduled payment date type requested type: string example: Arrival enum: - Arrival - Execution OBExternalStandingOrderStatus1Code: description: Specifies the status of the standing order in code form. type: string example: Active enum: - Active - Inactive OBExternalStatementAmountType1Code: description: Amount type, in a coded form. type: string example: UK.OBIE.ArrearsClosingBalance 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 example: UK.OBIE.Insurance enum: - UK.OBIE.Cashback - UK.OBIE.Insurance - UK.OBIE.TravelDiscount - UK.OBIE.TravelInsurance OBExternalStatementDateTimeType1Code: description: Date time type, in a coded form. type: string example: UK.OBIE.LastPayment 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 example: UK.OBIE.Weekly 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 example: UK.OBIE.AER enum: - UK.OBIE.AER - UK.OBIE.EAR OBExternalStatementFeeType1Code: description: Fee type, in a coded form. type: string example: UK.OBIE.Gambling 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 example: UK.OBIE.HalfYearly 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 example: UK.OBIE.Net 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 example: UK.OBIE.Cash enum: - UK.OBIE.BalanceTransfer - UK.OBIE.Cash - UK.OBIE.EstimatedNext - UK.OBIE.Purchase - UK.OBIE.Total OBExternalStatementRateType1Code: description: Statement rate type, in a coded form. type: string example: UK.OBIE.AnnualCash enum: - UK.OBIE.AnnualBalanceTransfer - UK.OBIE.AnnualBalanceTransferAfterPromo - UK.OBIE.AnnualBalanceTransferPromo - UK.OBIE.AnnualCash - UK.OBIE.AnnualPurchase - UK.OBIE.AnnualPurchaseAfterPromo - UK.OBIE.AnnualPurchasePromo - UK.OBIE.MonthlyBalanceTransfer - UK.OBIE.MonthlyCash - UK.OBIE.MonthlyPurchase OBExternalStatementType1Code: description: Statement type, in a coded form. type: string example: Interim enum: - AccountClosure - AccountOpening - Annual - Interim - RegularPeriodic OBExternalStatementValueType1Code: description: Statement value type, in a coded form. type: string example: UK.OBIE.Debits 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: description: Details of the merchant involved in the transaction. type: object properties: MerchantName: description: Name by which the merchant is known. type: string minLength: 1 maxLength: 350 example: TDG00231 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 example: '18245' OBPCAData1: title: PCA type: object properties: ProductDetails: title: ProductDetails type: object properties: Segment: title: 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. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to PCA products, they are segmented in relation to different markets that they wish to focus on. 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. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With 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: title: 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}$ example: '99' Notes: title: Notes description: Optional additional notes to supplement the Core product details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 CreditInterest: title: CreditInterest description: >- Details about the interest that may be payable to the PCA account holders type: object properties: TierBandSet: title: TierBandSet description: >- The group of tiers or bands for which credit interest can be applied. type: array items: description: >- The group of tiers or bands for which credit interest can be applied. type: object properties: TierBandMethod: title: TierBandMethod description: >- The methodology of how credit interest is charged. It can be:- 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest 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. 3. Whole The same interest rate is applied irrespective of the PCA balance type: string example: Tiered enum: - Tiered - Whole CalculationMethod: title: CalculationMethod description: Methods of calculating interest type: string example: Compound enum: - Compound - SimpleInterest Destination: title: Destination description: >- Describes whether accrued interest is payable only to the PCA or to another bank account type: string example: PayAway enum: - PayAway - SelfCredit Notes: title: Notes description: >- Optional additional notes to supplement the Tier Band Set details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 TierBand: title: TierBand description: Tier Band Details type: array items: description: Tier Band Details type: object properties: Identification: title: Identification description: >- Unique and unambiguous identification of a Tier Band for a PCA. type: string minLength: 1 maxLength: 35 TierValueMinimum: title: TierValueMinimum description: >- Minimum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: 21,000 TierValueMaximum: title: TierValueMaximum description: >- Maximum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: 100,000.00 CalculationFrequency: title: CalculationFrequency description: >- How often is credit interest calculated for the account. type: string example: HalfYearly enum: - PerAcademicTerm - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly ApplicationFrequency: title: 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. type: string example: Daily enum: - PerAcademicTerm - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly DepositInterestAppliedCoverage: title: DepositInterestAppliedCoverage description: Amount on which Interest applied. type: string example: Tiered enum: - Tiered - Whole FixedVariableInterestRateType: title: FixedVariableInterestRateType description: Type of interest rate, Fixed or Variable type: string example: Variable enum: - Fixed - Variable AER: title: 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. Read 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: title: BankInterestRateType description: >- Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA. type: string example: Gross enum: - LinkedBaseRate - Gross - Net - Other BankInterestRate: title: BankInterestRate description: Bank Interest for the PCA product type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ example: test value Notes: title: Notes description: >- Optional additional notes to supplement the Tier Band details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherBankInterestType: title: OtherBankInterestType description: >- Other interest rate types which are not available in the standard code list type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Code Name Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test value required: - Name - Description OtherApplicationFrequency: title: OtherApplicationFrequency description: >- Other application frequencies that are not available in the standard code list type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: CodeName Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: description required: - Name - Description OtherCalculationFrequency: title: OtherCalculationFrequency description: >- Other calculation frequency which is not available in the standard code set. type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: CodeName Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: code description required: - Name - Description required: - TierValueMinimum - ApplicationFrequency - FixedVariableInterestRateType - AER minItems: 1 required: - TierBandMethod - TierBand minItems: 1 required: - TierBandSet Overdraft: title: Overdraft description: Details about Overdraft rates, fees & charges type: object properties: Notes: title: Notes description: Associated Notes about the overdraft rates type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBandSet: title: OverdraftTierBandSet description: Tier band set details type: array items: description: Tier band set details type: object properties: TierBandMethod: title: TierBandMethod description: >- The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. type: string example: Wholee enum: - Tiered - Whole - Banded OverdraftType: title: 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 example: Other enum: - Committed - OnDemand - Other Identification: title: Identification description: >- Unique and unambiguous identification of a Tier Band for a overdraft product. type: string minLength: 1 maxLength: 35 example: '4005208277148' AuthorisedIndicator: title: AuthorisedIndicator description: >- Indicates if the Overdraft is authorised (Y) or unauthorised (N) type: boolean example: true BufferAmount: title: 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}$ example: 10,000.00 USD Notes: title: Notes description: >- Optional additional notes to supplement the overdraft Tier Band Set details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBand: title: OverdraftTierBand description: Provides overdraft details for a specific tier or band type: array items: description: Provides overdraft details for a specific tier or band type: object properties: Identification: title: Identification description: >- Unique and unambiguous identification of a Tier Band for a overdraft. type: string minLength: 1 maxLength: 35 example: '32209458637' TierValueMin: title: TierValueMin description: Minimum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: 5,000.00 TierValueMax: title: TierValueMax description: Maximum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: 100,000.00 OverdraftInterestChargingCoverage: title: OverdraftInterestChargingCoverage description: Interest charged on whole amount or tiered/banded type: string example: Tiered enum: - Tiered - Whole BankGuaranteedIndicator: title: BankGuaranteedIndicator description: >- Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically type: boolean example: true EAR: title: EAR description: >- EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft. type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ example: '0.1' RepresentativeAPR: title: RepresentativeAPR description: >- An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account. type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ example: '0.11' Notes: title: Notes description: >- Optional additional notes to supplement the Tier/band details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeesCharges: title: OverdraftFeesCharges description: Overdraft fees and charges type: array items: description: Overdraft fees and charges type: object properties: OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: >- Details about any caps (maximum charges) that apply to a particular fee/charge type: array items: description: >- Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped 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: title: OverdraftControlIndicator description: >- Specifies for the overdraft control feature/benefit type: boolean example: true MinMaxType: title: MinMaxType description: >- Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string example: Minimum enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: >- fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float example: 20 FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: 5,000.00 CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: >- Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Sample Name Ltd. Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: desc. required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: title: OverdraftFeeChargeDetail description: Details about the fees/charges type: array items: description: Details about the fees/charges type: object properties: FeeType: title: FeeType description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans OverdraftControlIndicator: title: OverdraftControlIndicator description: >- Specifies for the overdraft control feature/benefit type: boolean example: true IncrementalBorrowingAmount: title: IncrementalBorrowingAmount 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}$ example: '100.00' FeeAmount: title: FeeAmount 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}$ example: 5,000.00 FeeRate: title: FeeRate 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}$ example: '0.11' FeeRateType: title: FeeRateType description: >- Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string example: Gross enum: - LinkedBaseRate - Gross - Net - Other ApplicationFrequency: title: ApplicationFrequency description: >- Frequency at which the overdraft charge is applied to the account type: string example: AccountOpening enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: title: CalculationFrequency description: >- How often is the overdraft fee/charge calculated for the account. type: string example: Daily enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: title: Notes description: >- Free text for capturing any other info related to Overdraft Fees Charge Details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other Fee type which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Big Named Company Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test description for Company required: - Name - Description OtherFeeRateType: title: OtherFeeRateType description: >- Other fee rate type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Specific Name LTD. Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: description... required: - Name - Description OtherApplicationFrequency: title: OtherApplicationFrequency description: >- Other application frequencies that are not available in the standard code list type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Long Name Holding Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: description... required: - Name - Description OtherCalculationFrequency: title: OtherCalculationFrequency description: >- Other calculation frequency which is not available in the standard code set. type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Long Name Comp. Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: descrition... required: - Name - Description OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: >- Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped 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: title: OverdraftControlIndicator description: >- Specifies for the overdraft control feature/benefit type: boolean example: true MinMaxType: title: MinMaxType description: >- Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string example: Minimum enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: >- fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float example: 0.99 FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: '10' CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string example: Day enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: >- Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Very Long Red Company Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: description... required: - Name - Description required: - FeeType - MinMaxType required: - FeeType - ApplicationFrequency minItems: 1 required: - OverdraftFeeChargeDetail required: - TierValueMin minItems: 1 OverdraftFeesCharges: title: OverdraftFeesCharges description: Overdraft fees and charges details type: array items: description: Overdraft fees and charges details type: object properties: OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: >- Details about any caps (maximum charges) that apply to a particular fee/charge type: array items: description: >- Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped 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: title: OverdraftControlIndicator description: >- Specifies for the overdraft control feature/benefit type: boolean example: true MinMaxType: title: MinMaxType description: >- Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string example: test value enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: >- fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float example: 0.99 FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: test value CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string example: Day enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: test value Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: test value Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test value required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: title: OverdraftFeeChargeDetail description: Details about the fees/charges type: array items: description: Details about the fees/charges type: object properties: FeeType: title: FeeType description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans OverdraftControlIndicator: title: OverdraftControlIndicator description: >- Specifies for the overdraft control feature/benefit type: boolean example: true IncrementalBorrowingAmount: title: IncrementalBorrowingAmount 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}$ example: '0' FeeAmount: title: FeeAmount 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}$ example: 1,000.00 FeeRate: title: FeeRate 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}$ example: '0.01' FeeRateType: title: FeeRateType description: >- Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string example: Net enum: - LinkedBaseRate - Gross - Net - Other ApplicationFrequency: title: ApplicationFrequency description: >- Frequency at which the overdraft charge is applied to the account type: string example: Daily enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: title: CalculationFrequency description: >- How often is the overdraft fee/charge calculated for the account. type: string example: Daily enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: title: Notes description: >- Free text for capturing any other info related to Overdraft Fees Charge Details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other Fee type which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: test value Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: test value Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test value required: - Name - Description OtherFeeRateType: title: OtherFeeRateType description: >- Other fee rate type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: State Street Corp. Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: descrition test required: - Name - Description OtherApplicationFrequency: title: OtherApplicationFrequency description: >- Other application frequencies that are not available in the standard code list type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Green Company Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: green description required: - Name - Description OtherCalculationFrequency: title: OtherCalculationFrequency description: >- Other calculation frequency which is not available in the standard code set. type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: Test Named Copany Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: description here required: - Name - Description OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: >- Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped 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: title: OverdraftControlIndicator description: >- Specifies for the overdraft control feature/benefit type: boolean example: true MinMaxType: title: MinMaxType description: >- Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string example: Minimum enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: >- fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float example: 0.99 FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: '100.00' CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string example: Year enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: XYZ Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: test name Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test description required: - Name - Description required: - FeeType - MinMaxType required: - FeeType - ApplicationFrequency minItems: 1 required: - OverdraftFeeChargeDetail required: - TierBandMethod - OverdraftTierBand minItems: 1 required: - OverdraftTierBandSet OtherFeesCharges: title: OtherFeesCharges description: >- Contains details of fees and charges which are not associated with either borrowing or features/benefits type: object properties: FeeChargeDetail: title: FeeChargeDetail description: Other fees/charges details type: array items: description: Other fees/charges details type: object properties: FeeCategory: title: FeeCategory description: >- Categorisation of fees and charges into standard categories. type: string example: test value enum: - Other - Servicing FeeType: title: FeeType description: Fee/Charge Type type: string example: Other enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other FeeAmount: title: FeeAmount 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}$ example: '100.00' FeeRate: title: FeeRate 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}$ example: '0.1' FeeRateType: title: FeeRateType description: >- Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) type: string example: Other enum: - LinkedBaseRate - Gross - Net - Other ApplicationFrequency: title: ApplicationFrequency description: How frequently the fee/charge is applied to the account type: string example: Daily enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: title: CalculationFrequency description: How frequently the fee/charge is calculated type: string example: Weekly enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: title: Notes description: >- Optional additional notes to supplement the fee/charge details. type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeCategoryType: title: OtherFeeCategoryType type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: test code Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: test name Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test value required: - Name - Description OtherFeeType: title: OtherFeeType description: >- Other Fee/charge type which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: test code FeeCategory: title: FeeCategory description: >- Categorisation of fees and charges into standard categories. type: string example: Other enum: - Other - Servicing Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: test name Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test description required: - FeeCategory - Name - Description OtherFeeRateType: title: OtherFeeRateType description: >- Other fee rate type which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: test code Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: test name Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test description required: - Name - Description OtherApplicationFrequency: title: OtherApplicationFrequency description: >- Other application frequencies not covered in the standard code list type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: test code Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: test name Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test description required: - Name - Description OtherCalculationFrequency: title: OtherCalculationFrequency description: >- Other calculation frequency which is not available in standard code set. type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: test code Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: test name Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test description required: - Name - Description FeeChargeCap: title: FeeChargeCap description: >- Details about any caps (maximum charges) that apply to a particular fee/charge type: array items: description: >- Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array items: description: Fee/charge type which is being capped type: string example: Other enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other minItems: 1 MinMaxType: title: MinMaxType description: >- Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string example: Minimum enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: >- fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float example: null FeeCapAmount: title: FeeCapAmount 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}$ example: '0.34' CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string example: AcademicTerm enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: >- Free text for adding extra details for fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: test code Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: test Named Comapny Description: title: Description description: >- Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test Description required: - Name - Description required: - FeeType - MinMaxType FeeApplicableRange: title: FeeApplicableRange description: Range or amounts or rates for which the fee/charge applies type: object properties: MinimumAmount: title: 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}$ example: '1200.00' MaximumAmount: title: 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}$ example: 100,000.00 MinimumRate: title: 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}$ example: '0.01' MaximumRate: title: 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}$ example: '4.5' required: - FeeCategory - FeeType - ApplicationFrequency minItems: 1 FeeChargeCap: title: FeeChargeCap description: >- Details about any caps (maximum charges) that apply to a particular fee/charge type: array items: description: >- Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array items: description: Fee/charge type which is being capped type: string enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other minItems: 1 MinMaxType: title: MinMaxType description: >- Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string example: Minimum enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: >- fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float example: 0.12 FeeCapAmount: title: FeeCapAmount 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}$ CappingPeriod: title: CappingPeriod description: >- Period e.g. day, week, month etc. for which the fee/charge is capped type: string example: Day enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Free text for adding extra details for fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: >- Other fee type code which is not available in the standard code set type: array items: description: >- Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: >- The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 example: test value Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 example: test value Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 example: test value required: - Name - Description required: - FeeType - MinMaxType required: - FeeChargeDetail OBParty2: type: object required: - PartyId properties: PartyId: $ref: '#/components/schemas/PartyId' PartyNumber: $ref: '#/components/schemas/PartyNumber' PartyType: $ref: '#/components/schemas/OBExternalPartyType1Code' Name: $ref: '#/components/schemas/Name_3' FullLegalName: $ref: '#/components/schemas/FullLegalName' LegalStructure: $ref: '#/components/schemas/OBExternalLegalStructureType1Code' BeneficialOwnership: type: boolean AccountRole: $ref: '#/components/schemas/OBExternalAccountRole1Code' EmailAddress: $ref: '#/components/schemas/EmailAddress' Phone: $ref: '#/components/schemas/PhoneNumber_0' Mobile: $ref: '#/components/schemas/PhoneNumber_1' Relationships: $ref: '#/components/schemas/OBPartyRelationships1' Address: type: array items: description: Postal address of a party. type: object required: - Country properties: AddressType: $ref: '#/components/schemas/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: '#/components/schemas/StreetName' BuildingNumber: $ref: '#/components/schemas/BuildingNumber' PostCode: $ref: '#/components/schemas/PostCode' TownName: $ref: '#/components/schemas/TownName' CountrySubDivision: $ref: '#/components/schemas/CountrySubDivision' Country: $ref: '#/components/schemas/CountryCode' OBPartyRelationships1: description: The Party's relationships with other resources. type: object properties: Account: description: Relationship to the Account resource. type: object required: - Related - Id 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: description: >- Information that locates and identifies a specific address, as defined by postal services. type: object properties: AddressType: $ref: '#/components/schemas/OBAddressTypeCode' Department: description: Identification of a division of a large organisation or building. type: string minLength: 1 maxLength: 70 example: test value SubDepartment: description: >- Identification of a sub-division of a large organisation or building. type: string minLength: 1 maxLength: 70 StreetName: $ref: '#/components/schemas/StreetName' BuildingNumber: $ref: '#/components/schemas/BuildingNumber' PostCode: $ref: '#/components/schemas/PostCode' TownName: $ref: '#/components/schemas/TownName' CountrySubDivision: description: Identifies a subdivision of a country such as state, region, county. type: string minLength: 1 maxLength: 35 example: test value Country: description: Nation with its own government. type: string pattern: ^[A-Z]{2,2}$ example: test value 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 example: 12 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 example: 12 OBReadAccount6: type: object required: - Data properties: Data: type: object properties: Account: type: array items: $ref: '#/components/schemas/OBAccount6' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadBalance1: type: object required: - Data properties: Data: type: object required: - Balance properties: Balance: type: array items: description: Set of elements used to define the balance details. type: object required: - AccountId - CreditDebitIndicator - Type - DateTime - Amount properties: AccountId: $ref: '#/components/schemas/AccountId' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_2' Type: $ref: '#/components/schemas/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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: test value Amount: description: Amount of money of the cash balance. type: object required: - Amount - Currency properties: Amount: $ref: >- #/components/schemas/OBActiveCurrencyAndAmount_SimpleType Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' CreditLine: type: array items: description: >- Set of elements used to provide details on the credit line. type: object required: - Included properties: Included: description: >- Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account. type: boolean example: true Type: description: Limit type, in a coded form. type: string example: Credit enum: - Available - Credit - Emergency - Pre-Agreed - Temporary Amount: description: Amount of money of the credit line. type: object required: - Amount - Currency properties: Amount: $ref: >- #/components/schemas/OBActiveCurrencyAndAmount_SimpleType Currency: $ref: >- #/components/schemas/ActiveOrHistoricCurrencyCode_1 minItems: 1 Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadBeneficiary5: type: object required: - Data properties: Data: type: object properties: Beneficiary: type: array items: $ref: '#/components/schemas/OBBeneficiary5' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/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 - ReadDirectDebits - ReadPAN - ReadScheduledPaymentsBasic - ReadScheduledPaymentsDetail - ReadStandingOrdersBasic - ReadStandingOrdersDetail - ReadTransactionsBasic - ReadTransactionsCredits - ReadTransactionsDebits - ReadTransactionsDetail - ReadBeneficiariesBasic - ReadBeneficiariesDetail - ReadProducts - ReadParty minItems: 1 ExpirationDateTime: description: >- Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2022-11-15 09:14:41' TransactionFromDateTime: description: >- Specified start date and time for the transaction query period. If 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: '2022-11-15 09:14:45' example: test value TransactionToDateTime: description: >- Specified end date and time for the transaction query period. If 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2022-11-15 09:14:49' Risk: $ref: '#/components/schemas/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 example: 699588e-b5c9-48d5-b0fc-00d52b229f7d CreationDateTime: $ref: '#/components/schemas/CreationDateTime' Status: description: Specifies the status of consent resource in code form. type: string example: Authorised enum: - Authorised - AwaitingAuthorisation - Rejected - Revoked StatusUpdateDateTime: $ref: '#/components/schemas/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 - ReadDirectDebits - ReadPAN - ReadScheduledPaymentsBasic - ReadScheduledPaymentsDetail - ReadStandingOrdersBasic - ReadStandingOrdersDetail - ReadTransactionsBasic - ReadTransactionsCredits - ReadTransactionsDebits - ReadTransactionsDetail - ReadBeneficiariesBasic - ReadBeneficiariesDetail - ReadProducts - ReadParty minItems: 1 ExpirationDateTime: description: >- Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2022-11-15 09:14:45' TransactionFromDateTime: description: >- Specified start date and time for the transaction query period. If 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2022-11-15 09:14:45' TransactionToDateTime: description: >- Specified end date and time for the transaction query period. If 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2022-11-15 09:14:45' Risk: $ref: '#/components/schemas/OBRisk2' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadDataStatement2: type: object properties: Statement: type: array items: $ref: '#/components/schemas/OBStatement2' OBReadDataTransaction6: type: object properties: Transaction: type: array items: $ref: '#/components/schemas/OBTransaction6' OBReadDirectDebit2: type: object required: - Data properties: Data: type: object properties: DirectDebit: type: array items: description: Account to or from which a cash entry is made. type: object required: - AccountId - MandateIdentification - Name properties: AccountId: $ref: '#/components/schemas/AccountId' DirectDebitId: $ref: '#/components/schemas/DirectDebitId' MandateIdentification: $ref: '#/components/schemas/MandateIdentification' DirectDebitStatusCode: $ref: '#/components/schemas/OBExternalDirectDebitStatus1Code' Name: $ref: '#/components/schemas/Name_2' PreviousPaymentDateTime: $ref: '#/components/schemas/PreviousPaymentDateTime' Frequency: description: >- Regularity with which direct debit instructions are to be created and processed. type: string enum: - UK.OBIE.Annual - UK.OBIE.Daily - UK.OBIE.Fortnightly - UK.OBIE.HalfYearly - UK.OBIE.Monthly - UK.OBIE.NotKnown - UK.OBIE.Quarterly - UK.OBIE.Weekly PreviousPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_0' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadOffer1: type: object required: - Data properties: Data: type: object properties: Offer: type: array items: type: object required: - AccountId properties: AccountId: $ref: '#/components/schemas/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 example: LmMGx7nPxh9xkS0KT-OQ7w OfferType: description: Offer type, in a coded form. type: string example: BalanceTransfer enum: - BalanceTransfer - LimitIncrease - MoneyTransfer - Other - PromotionalRate Description: description: Further details of the offer. type: string minLength: 1 maxLength: 500 example: test description StartDateTime: description: >- Date and time at which the offer starts.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2022-11-15T03:45:02+00:00' EndDateTime: description: >- Date and time at which the offer ends.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2022-11-15T03:45:02+00:00' Rate: description: Rate associated with the offer type. type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ example: test rate Value: description: Value associated with the offer type. type: integer example: null Term: description: Further details of the term of the offer. type: string minLength: 1 maxLength: 500 example: more details URL: description: >- URL (Uniform Resource Locator) where documentation on the offer can be found type: string minLength: 1 maxLength: 256 Amount: description: Amount of money associated with the offer type. type: object required: - Amount - Currency properties: Amount: $ref: >- #/components/schemas/OBActiveCurrencyAndAmount_SimpleType Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' Fee: description: Fee associated with the offer type. type: object required: - Amount - Currency properties: Amount: $ref: >- #/components/schemas/OBActiveCurrencyAndAmount_SimpleType Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadParty2: type: object required: - Data properties: Data: type: object properties: Party: $ref: '#/components/schemas/OBParty2' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadParty3: type: object required: - Data properties: Data: type: object properties: Party: type: array items: $ref: '#/components/schemas/OBParty2' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadProduct2: description: >- Product details of Other Product which is not avaiable in the standard list type: object required: - Data properties: Data: description: Aligning with the read write specs structure. type: object properties: Product: type: array items: description: Product details associated with the Account type: object 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 example: CurrentAccount 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 example: test ID AccountId: $ref: '#/components/schemas/AccountId' SecondaryProductId: description: >- Any secondary Identification which supports Product Identifier to uniquely identify the current account banking products. type: string minLength: 1 maxLength: 70 example: secondary Product value ProductType: description: >- Product type : Personal Current Account, Business Current Account type: string example: CommercialCreditCard enum: - BusinessCurrentAccount - CommercialCreditCard - Other - PersonalCurrentAccount - SMELoan MarketingStateId: description: >- Unique and unambiguous identification of a Product Marketing State. type: string minLength: 1 maxLength: 35 example: 5d6b9480-44d5-4c72-8dc5-3ae24f510b7d OtherProductType: description: Other product type details associated with the account. type: object required: - Name - Description properties: Name: description: Long name associated with the product type: string minLength: 1 maxLength: 350 example: test name 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. Read 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: '#/components/schemas/OB_OtherCodeType1_0' CreditInterest: description: >- Details about the interest that may be payable to the Account holders type: object required: - TierBandSet properties: TierBandSet: type: array items: description: >- The group of tiers or bands for which credit interest can be applied. type: object required: - TierBandMethod - Destination - TierBand properties: TierBandMethod: description: >- The methodology of how credit interest is paid/applied. It can be:- 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest 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. 3. Whole The same interest rate is applied irrespective of the product holder's account balance type: string example: INBA enum: - INBA - INTI - INWH CalculationMethod: $ref: >- #/components/schemas/OB_InterestCalculationMethod1Code Destination: description: >- Describes whether accrued interest is payable only to the BCA or to another bank account type: string example: INOT 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: '#/components/schemas/OB_OtherCodeType1_0' OtherDestination: $ref: '#/components/schemas/OB_OtherCodeType1_0' TierBand: type: array items: description: Tier Band Details type: object 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 example: test value TierValueMinimum: description: >- Minimum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: test value TierValueMaximum: description: >- Maximum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: test value CalculationFrequency: description: >- How often is credit interest calculated for the account. type: string example: test value 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 example: FQAT enum: - FQAT - FQDY - FQHY - FQMY - FQOT - FQQY - FQSD - FQWY - FQYY DepositInterestAppliedCoverage: description: Amount on which Interest applied. type: string example: INBA enum: - INBA - INTI - INWH FixedVariableInterestRateType: $ref: >- #/components/schemas/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. Read 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}$ example: test value 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 example: INBB 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}$ example: test value Notes: type: array items: description: >- Optional additional notes to supplement the Tier Band details type: string minLength: 1 maxLength: 2000 OtherBankInterestType: description: >- Other interest rate types which are not available in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_1' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_2' minItems: 1 minItems: 1 Overdraft: description: Borrowing details type: object required: - OverdraftTierBandSet properties: Notes: type: array items: description: Associated Notes about the overdraft rates type: string minLength: 1 maxLength: 2000 OverdraftTierBandSet: type: array items: description: Tier band set details type: object required: - TierBandMethod - OverdraftTierBand properties: TierBandMethod: description: >- The methodology of how overdraft is charged. It can be: 'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). 'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation 'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. type: string example: INBA 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 example: OVCO enum: - OVCO - OVOD - OVOT Identification: description: >- Unique and unambiguous identification of a Tier Band for a overdraft product. type: string minLength: 1 maxLength: 35 example: test id AuthorisedIndicator: description: >- Indicates if the Overdraft is authorised (Y) or unauthorised (N) type: boolean example: true 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}$ example: test value 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: description: >- Provides overdraft details for a specific tier or band type: object required: - TierValueMin properties: Identification: description: >- Unique and unambiguous identification of a Tier Band for a overdraft. type: string minLength: 1 maxLength: 35 example: test value TierValueMin: description: Minimum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: test value TierValueMax: description: Maximum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: test value EAR: description: >- EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft. type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ example: test value AgreementLengthMin: description: >- Specifies the minimum length of a band for a fixed overdraft agreement type: integer example: null AgreementLengthMax: description: >- Specifies the maximum length of a band for a fixed overdraft agreement type: integer example: null AgreementPeriod: description: >- Specifies the period of a fixed length overdraft agreement type: string example: test value 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 example: test value 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: description: Overdraft fees and charges type: object required: - OverdraftFeeChargeDetail properties: OverdraftFeeChargeCap: type: array 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 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: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: >- Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: description: >- Other fee type code which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OverdraftFeeChargeDetail: type: array items: description: Details about the fees/charges type: object required: - FeeType - ApplicationFrequency properties: FeeType: $ref: >- #/components/schemas/OB_OverdraftFeeType1Code NegotiableIndicator: description: >- Indicates whether fee and charges are negotiable type: boolean example: true OverdraftControlIndicator: description: >- Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. type: boolean example: true IncrementalBorrowingAmount: $ref: '#/components/schemas/OB_Amount1_1' FeeAmount: $ref: '#/components/schemas/OB_Amount1_2' FeeRate: $ref: '#/components/schemas/OB_Rate1_0' FeeRateType: $ref: >- #/components/schemas/OB_InterestRateType1Code_0 ApplicationFrequency: $ref: >- #/components/schemas/OB_FeeFrequency1Code_0 CalculationFrequency: $ref: >- #/components/schemas/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: 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 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: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: >- Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: description: >- Other fee type code which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherFeeType: $ref: '#/components/schemas/OB_OtherCodeType1_3' OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_4' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_1' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_2' minItems: 1 minItems: 1 OverdraftFeesCharges: type: array items: description: Overdraft fees and charges details type: object required: - OverdraftFeeChargeDetail properties: OverdraftFeeChargeCap: type: array 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 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: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: >- Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: description: >- Other fee type code which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OverdraftFeeChargeDetail: type: array items: description: Details about the fees/charges type: object required: - FeeType - ApplicationFrequency properties: FeeType: $ref: >- #/components/schemas/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: '#/components/schemas/OB_Amount1_1' FeeAmount: $ref: '#/components/schemas/OB_Amount1_2' FeeRate: $ref: '#/components/schemas/OB_Rate1_0' FeeRateType: $ref: >- #/components/schemas/OB_InterestRateType1Code_0 ApplicationFrequency: $ref: >- #/components/schemas/OB_FeeFrequency1Code_0 CalculationFrequency: $ref: >- #/components/schemas/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: 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 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: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: >- Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: description: >- Other fee type code which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherFeeType: $ref: '#/components/schemas/OB_OtherCodeType1_3' OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_4' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_1' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_2' minItems: 1 minItems: 1 LoanInterest: description: >- Details about the interest that may be payable to the SME Loan holders type: object required: - LoanInterestTierBandSet properties: Notes: type: array items: description: >- Optional additional notes to supplement the LoanInterest type: string minLength: 1 maxLength: 2000 LoanInterestTierBandSet: type: array items: description: >- The group of tiers or bands for which debit interest can be applied. type: object required: - TierBandMethod - CalculationMethod - LoanInterestTierBand properties: TierBandMethod: description: >- The methodology of how credit interest is charged. It can be:- 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest 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. 3. Whole The same interest rate is applied irrespective of the SME Loan balance type: string example: INBA enum: - INBA - INTI - INWH Identification: description: >- Loan interest tierbandset identification. Used by loan providers for internal use purpose. type: string minLength: 1 maxLength: 35 example: '949388009' CalculationMethod: $ref: >- #/components/schemas/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: '#/components/schemas/OB_OtherCodeType1_0' LoanInterestTierBand: type: array items: description: Tier Band Details type: object 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 example: '923912485238' TierValueMinimum: description: >- Minimum loan value for which the loan interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: '10000' TierValueMaximum: description: >- Maximum loan value for which the loan interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ example: null TierValueMinTerm: description: >- Minimum loan term for which the loan interest tier applies. type: integer example: null MinTermPeriod: description: >- The unit of period (days, weeks, months etc.) of the Minimum Term type: string example: PACT enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER TierValueMaxTerm: description: >- Maximum loan term for which the loan interest tier applies. type: integer example: 64 MaxTermPeriod: description: >- The unit of period (days, weeks, months etc.) of the Maximum Term type: string example: PACT enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER FixedVariableInterestRateType: $ref: >- #/components/schemas/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. For 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}$ example: example AER 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 example: INOT 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}$ example: '1' Notes: type: array items: description: >- Optional additional notes to supplement the Tier Band details type: string minLength: 1 maxLength: 2000 OtherLoanProviderInterestRateType: description: >- Other loan interest rate types which are not available in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' LoanInterestFeesCharges: type: array items: description: >- Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits type: object required: - LoanInterestFeeChargeDetail properties: LoanInterestFeeChargeDetail: type: array items: description: Other fees/charges details type: object required: - FeeType - ApplicationFrequency - CalculationFrequency properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: description: >- Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: $ref: '#/components/schemas/OB_Amount1_3' FeeRate: $ref: '#/components/schemas/OB_Rate1_1' FeeRateType: $ref: >- #/components/schemas/OB_InterestRateType1Code_1 ApplicationFrequency: $ref: >- #/components/schemas/OB_FeeFrequency1Code_2 CalculationFrequency: $ref: >- #/components/schemas/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: >- #/components/schemas/OB_OtherFeeChargeDetailType OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_5' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_6' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_7' minItems: 1 LoanInterestFeeChargeCap: type: array items: description: >- Details about any caps (minimum/maximum charges) that apply to a particular fee/charge type: object 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: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: >- #/components/schemas/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: description: >- Other fee type code which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' minItems: 1 LoanInterestFeesCharges: type: array items: description: >- Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits type: object required: - LoanInterestFeeChargeDetail properties: LoanInterestFeeChargeDetail: type: array items: description: Other fees/charges details type: object required: - FeeType - ApplicationFrequency - CalculationFrequency properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: description: >- Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: $ref: '#/components/schemas/OB_Amount1_3' FeeRate: $ref: '#/components/schemas/OB_Rate1_1' FeeRateType: $ref: >- #/components/schemas/OB_InterestRateType1Code_1 ApplicationFrequency: $ref: >- #/components/schemas/OB_FeeFrequency1Code_2 CalculationFrequency: $ref: >- #/components/schemas/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: >- #/components/schemas/OB_OtherFeeChargeDetailType OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_5' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_6' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_7' minItems: 1 LoanInterestFeeChargeCap: type: array items: description: >- Details about any caps (minimum/maximum charges) that apply to a particular fee/charge type: object 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: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: >- #/components/schemas/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: description: >- Other fee type code which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' minItems: 1 Repayment: description: Repayment details of the Loan product type: object properties: RepaymentType: description: Repayment type type: string example: USBA enum: - USBA - USBU - USCI - USCS - USER - USFA - USFB - USFI - USIO - USOT - USPF - USRW - USSL RepaymentFrequency: description: Repayment frequency type: string example: SMDA 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 example: RABD 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: description: >- Other repayment type which is not in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherRepaymentFrequency: description: >- Other repayment frequency which is not in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherAmountType: description: >- Other amount type which is not in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' RepaymentFeeCharges: description: >- Applicable fee/charges for repayment such as prepayment, full early repayment or non repayment. type: object required: - RepaymentFeeChargeDetail properties: RepaymentFeeChargeDetail: type: array items: description: >- Details about specific fees/charges that are applied for repayment type: object required: - FeeType - ApplicationFrequency - CalculationFrequency properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: description: >- Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: $ref: '#/components/schemas/OB_Amount1_3' FeeRate: $ref: '#/components/schemas/OB_Rate1_1' FeeRateType: $ref: >- #/components/schemas/OB_InterestRateType1Code_1 ApplicationFrequency: $ref: >- #/components/schemas/OB_FeeFrequency1Code_2 CalculationFrequency: $ref: >- #/components/schemas/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: >- #/components/schemas/OB_OtherFeeChargeDetailType OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_8' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_6' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_7' minItems: 1 RepaymentFeeChargeCap: type: array items: description: >- RepaymentFeeChargeCap sets daily, weekly, monthly, yearly limits on the fees that are charged type: object 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: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: '#/components/schemas/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: description: >- Other fee type code which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' RepaymentHoliday: type: array items: description: Details of capital repayment holiday if any type: object 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 example: PACT 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: description: >- Contains details of fees and charges which are not associated with either Overdraft or features/benefits type: object 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: description: >- Other tariff type which is not in the standard list. type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' FeeChargeDetail: type: array items: description: Other fees/charges details type: object required: - FeeCategory - FeeType - ApplicationFrequency properties: FeeCategory: $ref: '#/components/schemas/OB_FeeCategory1Code' FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: description: >- Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: $ref: '#/components/schemas/OB_Amount1_3' FeeRate: $ref: '#/components/schemas/OB_Rate1_1' FeeRateType: $ref: >- #/components/schemas/OB_InterestRateType1Code_1 ApplicationFrequency: $ref: >- #/components/schemas/OB_FeeFrequency1Code_2 CalculationFrequency: $ref: >- #/components/schemas/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: description: >- Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: object 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: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: '#/components/schemas/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: description: >- Other fee type code which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherFeeCategoryType: $ref: '#/components/schemas/OB_OtherCodeType1_0' OtherFeeType: $ref: >- #/components/schemas/OB_OtherFeeChargeDetailType OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_8' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_6' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_7' FeeApplicableRange: description: >- Range or amounts or rates for which the fee/charge applies type: object 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}$ example: '10' 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}$ example: '100' 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}$ example: '0' 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}$ example: '5' minItems: 1 FeeChargeCap: type: array items: description: >- Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: object 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: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: '#/components/schemas/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: description: >- Other fee type code which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' BCA: $ref: '#/components/schemas/OBBCAData1' PCA: $ref: '#/components/schemas/OBPCAData1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadScheduledPayment3: type: object required: - Data properties: Data: type: object properties: ScheduledPayment: type: array items: $ref: '#/components/schemas/OBScheduledPayment3' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadStandingOrder6: type: object required: - Data properties: Data: type: object properties: StandingOrder: type: array items: $ref: '#/components/schemas/OBStandingOrder6' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadStatement2: type: object required: - Data properties: Data: $ref: '#/components/schemas/OBReadDataStatement2' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBReadTransaction6: type: object required: - Data properties: Data: $ref: '#/components/schemas/OBReadDataTransaction6' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/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: {} OBScheduledPayment3: type: object required: - AccountId - ScheduledPaymentDateTime - ScheduledType - InstructedAmount properties: AccountId: $ref: '#/components/schemas/AccountId' ScheduledPaymentId: $ref: '#/components/schemas/ScheduledPaymentId' ScheduledPaymentDateTime: $ref: '#/components/schemas/ScheduledPaymentDateTime' ScheduledType: $ref: '#/components/schemas/OBExternalScheduleType1Code' Reference: $ref: '#/components/schemas/Reference' DebtorReference: $ref: '#/components/schemas/DebtorReference' InstructedAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_1' CreditorAgent: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification5_1 CreditorAccount: $ref: '#/components/schemas/OBCashAccount5_1' OBScheduledPayment3Basic: type: object required: - AccountId - ScheduledPaymentDateTime - ScheduledType - InstructedAmount properties: AccountId: $ref: '#/components/schemas/AccountId' ScheduledPaymentId: $ref: '#/components/schemas/ScheduledPaymentId' ScheduledPaymentDateTime: $ref: '#/components/schemas/ScheduledPaymentDateTime' ScheduledType: $ref: '#/components/schemas/OBExternalScheduleType1Code' Reference: $ref: '#/components/schemas/Reference' DebtorReference: $ref: '#/components/schemas/DebtorReference' InstructedAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_1' OBScheduledPayment3Detail: type: object required: - AccountId - ScheduledPaymentDateTime - ScheduledType - InstructedAmount - CreditorAccount properties: AccountId: $ref: '#/components/schemas/AccountId' ScheduledPaymentId: $ref: '#/components/schemas/ScheduledPaymentId' ScheduledPaymentDateTime: $ref: '#/components/schemas/ScheduledPaymentDateTime' ScheduledType: $ref: '#/components/schemas/OBExternalScheduleType1Code' Reference: $ref: '#/components/schemas/Reference' DebtorReference: $ref: '#/components/schemas/DebtorReference' InstructedAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_1' CreditorAgent: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification5_1 CreditorAccount: $ref: '#/components/schemas/OBCashAccount5_1' OBStandingOrder6: type: object required: - AccountId - Frequency properties: AccountId: $ref: '#/components/schemas/AccountId' StandingOrderId: $ref: '#/components/schemas/StandingOrderId' Frequency: $ref: '#/components/schemas/Frequency_1' Reference: $ref: '#/components/schemas/Reference' FirstPaymentDateTime: $ref: '#/components/schemas/FirstPaymentDateTime' NextPaymentDateTime: $ref: '#/components/schemas/NextPaymentDateTime' LastPaymentDateTime: $ref: '#/components/schemas/LastPaymentDateTime' FinalPaymentDateTime: $ref: '#/components/schemas/FinalPaymentDateTime' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' StandingOrderStatusCode: $ref: '#/components/schemas/OBExternalStandingOrderStatus1Code' FirstPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_2' NextPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_3' LastPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_11' FinalPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_4' CreditorAgent: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification5_1 CreditorAccount: $ref: '#/components/schemas/OBCashAccount5_1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' OBStandingOrder6Basic: type: object required: - AccountId - Frequency properties: AccountId: $ref: '#/components/schemas/AccountId' StandingOrderId: $ref: '#/components/schemas/StandingOrderId' Frequency: $ref: '#/components/schemas/Frequency_1' Reference: $ref: '#/components/schemas/Reference' FirstPaymentDateTime: $ref: '#/components/schemas/FirstPaymentDateTime' NextPaymentDateTime: $ref: '#/components/schemas/NextPaymentDateTime' LastPaymentDateTime: $ref: '#/components/schemas/LastPaymentDateTime' FinalPaymentDateTime: $ref: '#/components/schemas/FinalPaymentDateTime' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' StandingOrderStatusCode: $ref: '#/components/schemas/OBExternalStandingOrderStatus1Code' FirstPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_2' NextPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_3' LastPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_11' FinalPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_4' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' OBStandingOrder6Detail: type: object required: - AccountId - Frequency - CreditorAccount properties: AccountId: $ref: '#/components/schemas/AccountId' StandingOrderId: $ref: '#/components/schemas/StandingOrderId' Frequency: $ref: '#/components/schemas/Frequency_1' Reference: $ref: '#/components/schemas/Reference' FirstPaymentDateTime: $ref: '#/components/schemas/FirstPaymentDateTime' NextPaymentDateTime: $ref: '#/components/schemas/NextPaymentDateTime' LastPaymentDateTime: $ref: '#/components/schemas/LastPaymentDateTime' FinalPaymentDateTime: $ref: '#/components/schemas/FinalPaymentDateTime' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' StandingOrderStatusCode: $ref: '#/components/schemas/OBExternalStandingOrderStatus1Code' FirstPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_2' NextPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_3' LastPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_11' FinalPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_4' CreditorAgent: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification5_1 CreditorAccount: $ref: '#/components/schemas/OBCashAccount5_1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' OBStatement2: description: Provides further details on a statement resource. type: object required: - AccountId - Type - StartDateTime - EndDateTime - CreationDateTime properties: AccountId: $ref: '#/components/schemas/AccountId' StatementId: $ref: '#/components/schemas/StatementId' StatementReference: $ref: '#/components/schemas/StatementReference' Type: $ref: '#/components/schemas/OBExternalStatementType1Code' StartDateTime: $ref: '#/components/schemas/StartDateTime' EndDateTime: $ref: '#/components/schemas/EndDateTime' CreationDateTime: $ref: '#/components/schemas/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: description: >- Set of elements used to provide details of a benefit or reward amount for the statement resource. type: object required: - Type - Amount properties: Type: $ref: '#/components/schemas/OBExternalStatementBenefitType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_5' StatementFee: type: array items: description: >- Set of elements used to provide details of a fee for the statement resource. type: object required: - CreditDebitIndicator - Type - Amount properties: Description: $ref: '#/components/schemas/Description_1' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBExternalStatementFeeType1Code' Rate: $ref: '#/components/schemas/OBRate1_0' RateType: $ref: '#/components/schemas/OBExternalStatementFeeRateType1Code' Frequency: $ref: '#/components/schemas/OBExternalStatementFeeFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_6' StatementInterest: type: array items: description: >- Set of elements used to provide details of a generic interest amount related to the statement resource. type: object required: - CreditDebitIndicator - Type - Amount properties: Description: $ref: '#/components/schemas/Description_2' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBExternalStatementInterestType1Code' Rate: $ref: '#/components/schemas/OBRate1_1' RateType: $ref: '#/components/schemas/OBExternalStatementInterestRateType1Code' Frequency: $ref: '#/components/schemas/OBExternalStatementInterestFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_7' StatementAmount: type: array items: description: >- Set of elements used to provide details of a generic amount for the statement resource. type: object required: - CreditDebitIndicator - Type - Amount properties: CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBExternalStatementAmountType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_8' StatementDateTime: type: array items: description: >- Set of elements used to provide details of a generic date time for the statement resource. type: object required: - DateTime - Type properties: DateTime: $ref: '#/components/schemas/DateTime' Type: $ref: '#/components/schemas/OBExternalStatementDateTimeType1Code' StatementRate: type: array items: description: >- Set of elements used to provide details of a generic rate related to the statement resource. type: object required: - Rate - Type properties: Rate: $ref: '#/components/schemas/Rate' Type: $ref: '#/components/schemas/OBExternalStatementRateType1Code' StatementValue: type: array items: description: >- Set of elements used to provide details of a generic number value related to the statement resource. type: object required: - Value - Type properties: Value: $ref: '#/components/schemas/Value' Type: $ref: '#/components/schemas/OBExternalStatementValueType1Code' OBStatement2Basic: description: Provides further details on a statement resource. type: object required: - AccountId - Type - StartDateTime - EndDateTime - CreationDateTime properties: AccountId: $ref: '#/components/schemas/AccountId' StatementId: $ref: '#/components/schemas/StatementId' StatementReference: $ref: '#/components/schemas/StatementReference' Type: $ref: '#/components/schemas/OBExternalStatementType1Code' StartDateTime: $ref: '#/components/schemas/StartDateTime' EndDateTime: $ref: '#/components/schemas/EndDateTime' CreationDateTime: $ref: '#/components/schemas/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: description: >- Set of elements used to provide details of a benefit or reward amount for the statement resource. type: object required: - Type - Amount properties: Type: $ref: '#/components/schemas/OBExternalStatementBenefitType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_5' StatementFee: type: array items: description: >- Set of elements used to provide details of a fee for the statement resource. type: object required: - CreditDebitIndicator - Type - Amount properties: Description: $ref: '#/components/schemas/Description_1' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBExternalStatementFeeType1Code' Rate: $ref: '#/components/schemas/OBRate1_0' RateType: $ref: '#/components/schemas/OBExternalStatementFeeRateType1Code' Frequency: $ref: '#/components/schemas/OBExternalStatementFeeFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_6' StatementInterest: type: array items: description: >- Set of elements used to provide details of a generic interest amount related to the statement resource. type: object required: - CreditDebitIndicator - Type - Amount properties: Description: $ref: '#/components/schemas/Description_2' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBExternalStatementInterestType1Code' Rate: $ref: '#/components/schemas/OBRate1_1' RateType: $ref: '#/components/schemas/OBExternalStatementInterestRateType1Code' Frequency: $ref: '#/components/schemas/OBExternalStatementInterestFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_7' StatementDateTime: type: array items: description: >- Set of elements used to provide details of a generic date time for the statement resource. type: object required: - DateTime - Type properties: DateTime: $ref: '#/components/schemas/DateTime' Type: $ref: '#/components/schemas/OBExternalStatementDateTimeType1Code' StatementRate: type: array items: description: >- Set of elements used to provide details of a generic rate related to the statement resource. type: object required: - Rate - Type properties: Rate: $ref: '#/components/schemas/Rate' Type: $ref: '#/components/schemas/OBExternalStatementRateType1Code' StatementValue: type: array items: description: >- Set of elements used to provide details of a generic number value related to the statement resource. type: object required: - Value - Type properties: Value: $ref: '#/components/schemas/Value' Type: $ref: '#/components/schemas/OBExternalStatementValueType1Code' OBStatement2Detail: description: Provides further details on a statement resource. type: object required: - AccountId - Type - StartDateTime - EndDateTime - CreationDateTime properties: AccountId: $ref: '#/components/schemas/AccountId' StatementId: $ref: '#/components/schemas/StatementId' StatementReference: $ref: '#/components/schemas/StatementReference' Type: $ref: '#/components/schemas/OBExternalStatementType1Code' StartDateTime: $ref: '#/components/schemas/StartDateTime' EndDateTime: $ref: '#/components/schemas/EndDateTime' CreationDateTime: $ref: '#/components/schemas/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: description: >- Set of elements used to provide details of a benefit or reward amount for the statement resource. type: object required: - Type - Amount properties: Type: $ref: '#/components/schemas/OBExternalStatementBenefitType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_5' StatementFee: type: array items: description: >- Set of elements used to provide details of a fee for the statement resource. type: object required: - CreditDebitIndicator - Type - Amount properties: Description: $ref: '#/components/schemas/Description_1' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBExternalStatementFeeType1Code' Rate: $ref: '#/components/schemas/OBRate1_0' RateType: $ref: '#/components/schemas/OBExternalStatementFeeRateType1Code' Frequency: $ref: '#/components/schemas/OBExternalStatementFeeFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_6' StatementInterest: type: array items: description: >- Set of elements used to provide details of a generic interest amount related to the statement resource. type: object required: - CreditDebitIndicator - Type - Amount properties: Description: $ref: '#/components/schemas/Description_2' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBExternalStatementInterestType1Code' Rate: $ref: '#/components/schemas/OBRate1_1' RateType: $ref: '#/components/schemas/OBExternalStatementInterestRateType1Code' Frequency: $ref: '#/components/schemas/OBExternalStatementInterestFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_7' StatementAmount: type: array items: description: >- Set of elements used to provide details of a generic amount for the statement resource. type: object required: - CreditDebitIndicator - Type - Amount properties: CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBExternalStatementAmountType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_8' StatementDateTime: type: array items: description: >- Set of elements used to provide details of a generic date time for the statement resource. type: object required: - DateTime - Type properties: DateTime: $ref: '#/components/schemas/DateTime' Type: $ref: '#/components/schemas/OBExternalStatementDateTimeType1Code' StatementRate: type: array items: description: >- Set of elements used to provide details of a generic rate related to the statement resource. type: object required: - Rate - Type properties: Rate: $ref: '#/components/schemas/Rate' Type: $ref: '#/components/schemas/OBExternalStatementRateType1Code' StatementValue: type: array items: description: >- Set of elements used to provide details of a generic number value related to the statement resource. type: object required: - Value - Type properties: Value: $ref: '#/components/schemas/Value' Type: $ref: '#/components/schemas/OBExternalStatementValueType1Code' OBSupplementaryData1: description: >- Additional information that can not be captured in the structured fields and/or any other specific block. type: object properties: {} additionalProperties: true OBTransaction6: description: Provides further details on an entry in the report. type: object required: - AccountId - CreditDebitIndicator - Status - BookingDateTime - Amount properties: AccountId: $ref: '#/components/schemas/AccountId' TransactionId: $ref: '#/components/schemas/TransactionId' TransactionReference: $ref: '#/components/schemas/TransactionReference' StatementReference: type: array items: $ref: '#/components/schemas/StatementReference' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_1' Status: $ref: '#/components/schemas/OBEntryStatus1Code' TransactionMutability: $ref: '#/components/schemas/OBTransactionMutability1Code' BookingDateTime: $ref: '#/components/schemas/BookingDateTime' ValueDateTime: $ref: '#/components/schemas/ValueDateTime' TransactionInformation: $ref: '#/components/schemas/TransactionInformation' AddressLine: $ref: '#/components/schemas/AddressLine' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_9' ChargeAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_10' CurrencyExchange: $ref: '#/components/schemas/OBCurrencyExchange5' BankTransactionCode: $ref: '#/components/schemas/OBBankTransactionCodeStructure1' ProprietaryBankTransactionCode: $ref: '#/components/schemas/ProprietaryBankTransactionCodeStructure1' Balance: $ref: '#/components/schemas/OBTransactionCashBalance' MerchantDetails: $ref: '#/components/schemas/OBMerchantDetails1' CreditorAgent: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification6_1 CreditorAccount: $ref: '#/components/schemas/OBCashAccount6_0' DebtorAgent: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification6_2 DebtorAccount: $ref: '#/components/schemas/OBCashAccount6_1' CardInstrument: $ref: '#/components/schemas/OBTransactionCardInstrument1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' OBTransaction6Basic: description: Provides further details on an entry in the report. type: object required: - AccountId - CreditDebitIndicator - Status - BookingDateTime - Amount properties: AccountId: $ref: '#/components/schemas/AccountId' TransactionId: $ref: '#/components/schemas/TransactionId' TransactionReference: $ref: '#/components/schemas/TransactionReference' StatementReference: type: array items: $ref: '#/components/schemas/StatementReference' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_1' Status: $ref: '#/components/schemas/OBEntryStatus1Code' TransactionMutability: $ref: '#/components/schemas/OBTransactionMutability1Code' BookingDateTime: $ref: '#/components/schemas/BookingDateTime' ValueDateTime: $ref: '#/components/schemas/ValueDateTime' AddressLine: $ref: '#/components/schemas/AddressLine' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_9' ChargeAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_10' CurrencyExchange: $ref: '#/components/schemas/OBCurrencyExchange5' BankTransactionCode: $ref: '#/components/schemas/OBBankTransactionCodeStructure1' ProprietaryBankTransactionCode: $ref: '#/components/schemas/ProprietaryBankTransactionCodeStructure1' CardInstrument: $ref: '#/components/schemas/OBTransactionCardInstrument1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' OBTransaction6Detail: description: Provides further details on an entry in the report. type: object required: - AccountId - CreditDebitIndicator - Status - BookingDateTime - Amount properties: AccountId: $ref: '#/components/schemas/AccountId' TransactionId: $ref: '#/components/schemas/TransactionId' TransactionReference: $ref: '#/components/schemas/TransactionReference' StatementReference: type: array items: $ref: '#/components/schemas/StatementReference' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_1' Status: $ref: '#/components/schemas/OBEntryStatus1Code' TransactionMutability: $ref: '#/components/schemas/OBTransactionMutability1Code' BookingDateTime: $ref: '#/components/schemas/BookingDateTime' ValueDateTime: $ref: '#/components/schemas/ValueDateTime' TransactionInformation: $ref: '#/components/schemas/TransactionInformation' AddressLine: $ref: '#/components/schemas/AddressLine' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_9' ChargeAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_10' CurrencyExchange: $ref: '#/components/schemas/OBCurrencyExchange5' BankTransactionCode: $ref: '#/components/schemas/OBBankTransactionCodeStructure1' ProprietaryBankTransactionCode: $ref: '#/components/schemas/ProprietaryBankTransactionCodeStructure1' Balance: $ref: '#/components/schemas/OBTransactionCashBalance' MerchantDetails: $ref: '#/components/schemas/OBMerchantDetails1' CreditorAgent: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification6_1 CreditorAccount: $ref: '#/components/schemas/OBCashAccount6_0' DebtorAgent: $ref: >- #/components/schemas/OBBranchAndFinancialInstitutionIdentification6_2 DebtorAccount: $ref: '#/components/schemas/OBCashAccount6_1' CardInstrument: $ref: '#/components/schemas/OBTransactionCardInstrument1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' OBTransactionCardInstrument1: description: Set of elements to describe the card instrument used in the transaction. type: object required: - CardSchemeName 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: 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. type: object required: - CreditDebitIndicator - Type - Amount properties: CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_2' Type: $ref: '#/components/schemas/OBBalanceType1Code' Amount: description: >- Amount of money of the cash balance after a transaction entry is applied to the account.. type: object required: - Amount - Currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/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}$ example: '10' 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}$ example: '10' 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}$ example: '10' 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}$ example: '10' 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}$ example: '10' OB_CodeMnemonic: description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\\w{0,4}$ example: '10' OB_FeeCategory1Code: description: Categorisation of fees and charges into standard categories. type: string example: FCSV enum: - FCOT - FCRE - FCSV OB_FeeFrequency1Code_0: description: Frequency at which the overdraft charge is applied to the account type: string example: FEAC 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 example: FEAC 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 example: FEAC 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 example: FEAC 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 example: FEAC 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 example: FEPF enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX OB_InterestCalculationMethod1Code: description: Methods of calculating interest type: string example: ITCO enum: - ITCO - ITOT - ITSI OB_InterestFixedVariableType1Code: description: Type of interest rate, Fixed or Variable type: string example: INFI 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 example: INBB 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 example: INOT enum: - INBB - INFR - INGR - INLR - INNE - INOT OB_MinMaxType1Code: description: Min Max type type: string example: FMMX enum: - FMMN - FMMX OB_OtherCodeType1_0: type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OtherCodeType1_1: description: >- Other application frequencies that are not available in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OtherCodeType1_2: description: >- Other calculation frequency which is not available in the standard code set. type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OtherCodeType1_3: description: Other Fee type which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OtherCodeType1_4: description: Other fee rate type code which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OtherCodeType1_5: description: Other fee rate type which is not in the standard rate type list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OtherCodeType1_6: description: Other application frequencies not covered in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OtherCodeType1_7: description: Other calculation frequency which is not available in standard code set. type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OtherCodeType1_8: description: Other fee rate type which is not available in the standard code set type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OtherFeeChargeDetailType: description: Other Fee/charge type which is not available in the standard code set type: object required: - FeeCategory - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' FeeCategory: $ref: '#/components/schemas/OB_FeeCategory1Code' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OverdraftFeeType1Code: description: Overdraft fee type type: string example: FTUT 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 example: PYER 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}$ example: '0' 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}$ example: '0' OpeningDate: description: >- Date on which the account and related basic services are effectively operational for the account owner.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T00:00:00+00:00' 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 example: PPA PartyNumber: description: Number assigned by an agent to identify its customer. type: string minLength: 1 maxLength: 35 example: example PartyNumber 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} example: 9999 88 54 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} example: 9999 88 54 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 example: 80-034 PreviousPaymentDateTime: description: >- Date of most recent direct debit collection.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T00:00:00+00:00' ProprietaryBankTransactionCodeStructure1: description: Set of elements to fully identify a proprietary bank transaction code. type: object required: - Code properties: Code: description: >- Proprietary bank transaction code to identify the underlying transaction. type: string minLength: 1 maxLength: 35 example: SGDI Issuer: description: >- Identification of the issuer of the proprietary bank transaction code. type: string minLength: 1 maxLength: 35 example: NBP Rate: description: Rate associated with the statement rate type. type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ example: '0' Reference: description: >- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: 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. If 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 example: example Reference OBBeneficiaryType1Code: description: Specifies the Beneficiary Type. type: string example: Trusted enum: - Trusted - Ordinary 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T00:00:00+00:00' 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 example: ScheduledPaymentId SecondaryIdentification: description: >- This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). type: string minLength: 1 maxLength: 34 example: '4941202460847847' 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 example: StandingOrderId StartDateTime: description: >- Date and time at which the statement period starts.All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T00:00:00+00:00' 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 example: example StatementId StatementReference: description: >- Unique reference for the statement. This reference may be optionally populated if available. type: string minLength: 1 maxLength: 35 example: example StatementReference 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time example: '2023-01-04T00:00:00+00:00' StreetName: description: Name of a street or thoroughfare. type: string minLength: 1 maxLength: 70 example: example StreetName TownName: description: >- Name of a built-up area, with defined boundaries, and a local government. type: string minLength: 1 maxLength: 35 example: London TransactionId: description: >- Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable. type: string minLength: 1 maxLength: 210 example: >- 0432023004141005879040000-0326P10000000000000010000000000000010000000000OBP TransactionInformation: description: |- Further details of the transaction. This is the transaction narrative, which is unstructured text. type: string minLength: 1 maxLength: 500 example: example TransactionInformation TransactionReference: description: >- Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context. type: string minLength: 1 maxLength: 210 example: example TransactionReference Value: description: Value associated with the statement value type. type: string minLength: 1 maxLength: 40 example: '10' 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. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For 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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time Model: type: object properties: id: type: integer format: int64