openapi: 3.1.0 info: title: Account and Transactions description: To retrieve account information for Barclays customers termsOfService: https://www.openbanking.org.uk/terms contact: name: Service Desk url: https://www.openbanking.org.uk email: ServiceDesk@openbanking.org.uk license: name: open-licence url: https://www.openbanking.org.uk/open-licence version: v4.0 x-method: searched x-source: https://developer.barclays.com/api/apis/versions/e6101c4d-5a76-4ac6-9659-1de2db4267a5.bdn/design?specification=oas31 x-harvested: '2026-09-04' x-harvested-note: Verbatim OpenAPI 3.1 design export from the Barclays API Exchange registry (developer.barclays.com), fetched anonymously. The untouched export is in openapi/_original/barclays-account-and-transactions-openapi.json. The UK Open Banking documents carry OBIE (openbanking.org.uk) in info.contact/termsOfService because they are the OBIE standard contract as Barclays implements and publishes it — the API, the registry record and the host are Barclays'. tags: - name: Account Access Consents description: Create Account Access Consents - name: Accounts description: Get Accounts - name: Balances description: Get Balances - name: Beneficiaries description: Get Beneficiaries - name: Direct Debits description: Get Direct Debits - name: Offers description: Get Offers - name: Parties description: Get Parties - name: Products description: Get Products - name: Scheduled Payments description: Get Scheduled Payments - name: Standing Orders description: Get Standing Orders - name: Statements description: Get Statements - name: Transactions description: Get Transactions paths: /accounts/{accountId}/statements: summary: Get Statements description: Get Statements get: tags: - Statements summary: Get Statements for an AccountId description: Enables an AISP to retrieve statement information for a specific PSU account. operationId: GetAccountsAccountIdStatements 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/FromStatementDateTimeParam' - $ref: '#/components/parameters/ToStatementDateTimeParam' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStatementsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /transactions: summary: Get Transactions description: Get Transactions get: tags: - Transactions summary: Get Transactions description: Enables an AISP to retrieve transaction information for account(s) that the PSU has consented to. operationId: GetTransactions 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/FromBookingDateTimeParam' - $ref: '#/components/parameters/ToBookingDateTimeParam' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /accounts/{accountId}/transactions: summary: Get Transactions description: Get Transactions get: tags: - Transactions summary: Get Transactions for an AccountId description: Enables an AISP to retrieve transaction information for a specific PSU account. operationId: GetAccountsAccountIdTransactions 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/Authorization' - $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' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' deprecated: false /accounts/{accountId}/product: summary: Get Products description: Get Products get: tags: - Products summary: Get Product for an AccountId description: Enables an AISP to retrieve the account product information for a specific PSU account. operationId: GetAccountsAccountIdProduct 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdProductRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /accounts/{accountId}/scheduled-payments: summary: Get Scheduled Payments description: Get Scheduled Payments get: tags: - Scheduled Payments summary: Get Scheduled Payments for an AccountId description: Enables an AISP to retrieve Scheduled Payment information for a specific PSU account. operationId: GetAccountsAccountIdScheduledPayments 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdScheduledPaymentsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /accounts/{accountId}/offers: summary: Get Offers description: Get Offers get: tags: - Offers summary: Get Offers for an AccountId description: Enables an AISP to retrieve any offer information for a specific PSU account. operationId: GetAccountsAccountIdOffers 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdOffersRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /accounts/{accountId}: summary: Get Accounts description: Get Accounts get: tags: - Accounts summary: Get an Account by AccountId description: Enables an AISP to retrieve information about a specific PSU account. operationId: GetAccountsAccountId 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' deprecated: false /balances: summary: Get Balances description: Get Balances get: tags: - Balances summary: Get Balances description: Enables an AISP to retrieve balance information for account(s) that the PSU has consented to. operationId: GetBalances 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /account-access-consents/{consentId}: summary: Get Account Access Consents description: Get Account Access Consents get: tags: - Account Access Consents summary: Get an Account Access Consent description: Enables an AISP to retrieve the status of an AIS consent. operationId: GetAccountAccessConsentsConsentId 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountAccessConsentsConsentIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' deprecated: false delete: tags: - Account Access Consents summary: Delete an Account Access Consent description: Enables an AISP to inform the ASPSP that the PSU has revoked their consent. operationId: DeleteAccountAccessConsentsConsentId 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '204': $ref: '#/components/responses/204AccountAccessConsentsConsentIdDeleted' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' deprecated: false /standing-orders: summary: Get Standing Orders description: Get Standing Orders get: tags: - Standing Orders summary: Get Standing Orders description: Enables an AISP to retrieve Standing Order information for account(s) that the PSU has consented to. operationId: GetStandingOrders 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /accounts/{accountId}/beneficiaries: summary: Get Beneficiaries description: Get Beneficiaries get: tags: - Beneficiaries summary: Get Beneficiaries for an AccountId description: Enables an AISP to retrieve Beneficiary information for a specific PSU account. operationId: GetAccountsAccountIdBeneficiaries 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdBeneficiariesRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /accounts/{accountId}/direct-debits: summary: Get Direct Debits description: Get Direct Debits get: tags: - Direct Debits summary: Get Direct Debits for an AccountId description: Enables an AISP to retrieve Direct Debit information for a specific PSU account. operationId: GetAccountsAccountIdDirectDebits 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdDirectDebitsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /scheduled-payments: summary: Get Scheduled Payments description: Get Scheduled Payments get: tags: - Scheduled Payments summary: Get Scheduled Payments description: Enables an AISP to retrieve Scheduled Payment information for account(s) that the PSU has consented to. operationId: GetScheduledPayments 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /party: summary: Get Parties description: Get Parties get: tags: - Parties summary: Get Party description: Retrieve details about the party that gave permission to the AISP to view an account(s). operationId: GetParty 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /accounts/{accountId}/statements/{statementId}/transactions: summary: Get Transactions description: Get Transactions get: tags: - Statements summary: Get Statement Transactions for an AccountId description: Enables an AISP to retrieve transactions that appear on a selected statement for a specific PSU account. operationId: GetAccountsAccountIdStatementsStatementIdTransactions parameters: - $ref: '#/components/parameters/StatementId' - $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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdTransactionsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /accounts/{accountId}/balances: summary: Get Balances description: Get Balances get: tags: - Balances summary: Get Balances for an AccountId description: Enables an AISP to retrieve account balance information for a specific PSU account. operationId: GetAccountsAccountIdBalances 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdBalancesRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' deprecated: false /beneficiaries: summary: Get Beneficiaries description: Get Beneficiaries get: tags: - Beneficiaries summary: Get Beneficiaries description: Enables an AISP to retrieve Beneficiary information for account(s) that the PSU has consented to. operationId: GetBeneficiaries 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /accounts/{accountId}/parties: summary: Get Parties description: Get Parties get: tags: - Parties summary: Get Parties for an AccountId description: Enables an AISP to retrieve details about the PSU account-holder(s)/operator(s). operationId: GetAccountsAccountIdParties 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdPartiesRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /account-access-consents: summary: Create Account Access Consents description: Create Account Access Consents post: tags: - Account Access Consents summary: Create an Account Access Consent description: Enables an AISP to ask an ASPSP to create a new account-access-consent resource, by sending a copy of the consent to the ASPSP. operationId: CreateAccountAccessConsents 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: description: Default content: application/json: schema: $ref: '#/components/schemas/OBReadConsent1' examples: create-account-access-consents: value: Data: Permissions: - ReadAccountsDetail - ReadBalances - ReadBeneficiariesDetail - ReadDirectDebits - ReadProducts - ReadStandingOrdersDetail - ReadTransactionsCredits - ReadTransactionsDebits - ReadTransactionsDetail - ReadOffers - ReadPAN - ReadParty - ReadPartyPSU - ReadScheduledPaymentsDetail - ReadStatementsDetail ExpirationDateTime: '2017-05-02T00:00:00+00:00' TransactionFromDateTime: '2017-05-03T00:00:00+00:00' TransactionToDateTime: '2017-12-03T00:00:00+00:00' Risk: {} required: true responses: '201': $ref: '#/components/responses/201AccountAccessConsentsCreated' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '415': $ref: '#/components/responses/415Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' deprecated: false /accounts/{accountId}/statements/{statementId}/file: summary: Get Statements description: Get Statements get: tags: - Statements summary: Get Statement file by StatementId for an AccountId description: Enables an AISP to retrieve a non-json representation of a specific statement. operationId: GetAccountsAccountIdStatementsStatementIdFile parameters: - $ref: '#/components/parameters/StatementId' - $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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /accounts/{accountId}/standing-orders: summary: Get Standing Orders description: Get Standing Orders get: tags: - Standing Orders summary: Get Standing Orders for an AccountId description: Enables an AISP to retrieve Standing Order information for a specific PSU account. operationId: GetAccountsAccountIdStandingOrders 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStandingOrdersRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /accounts/{accountId}/party: summary: Get Parties description: Get Parties get: tags: - Parties summary: Get Party for an AccountId description: Enables an AISP to retrieve details about the party that gave permission to the AISP to view a specific PSU account. operationId: GetAccountsAccountIdParty 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /products: summary: Get Products description: Get Products get: tags: - Products summary: Get Products description: Enables an AISP to retrieve the account product information for account(s) that the PSU has consented to. operationId: GetProducts 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /direct-debits: summary: Get Direct Debits description: Get Direct Debits get: tags: - Direct Debits summary: Get Direct Debits description: Enables an AISP to retrieve Direct Debit information for account(s) that the PSU has consented to. operationId: GetDirectDebits 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /statements: summary: Get Statements description: Get Statements get: tags: - Statements summary: Get Statements description: Enables an AISP to retrieve statement information for account(s) that the PSU has consented to. operationId: GetStatements 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/Authorization' - $ref: '#/components/parameters/FromStatementDateTimeParam' - $ref: '#/components/parameters/ToStatementDateTimeParam' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /offers: summary: Get Offers description: Get Offers get: tags: - Offers summary: Get Offers description: Enables an AISP to retrieve any offer information for account(s) that the PSU has consented to. operationId: GetOffers 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /accounts: summary: Get Accounts description: Get Accounts get: tags: - Accounts summary: Get Accounts description: Enables an AISP to retrieve a list of a PSU's accounts and information about those account(s) that the PSU has consented to. operationId: GetAccounts 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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' deprecated: false /accounts/{accountId}/statements/{statementId}: summary: Get Statements description: Get Statements get: tags: - Statements summary: Get Statement by StatementId for an AccountId description: Enables an AISP to retrieve the statement information resource for a specific statement. operationId: GetAccountsAccountIdStatementsStatementId parameters: - $ref: '#/components/parameters/StatementId' - $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/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdStatementsStatementIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false components: schemas: Meta: type: object additionalProperties: false description: Meta Data relevant to the payload properties: TotalPages: type: integer format: int32 example: 42 maximum: 999999 minimum: 0 FirstAvailableDateTime: $ref: '#/components/schemas/ISODateTime' LastAvailableDateTime: $ref: '#/components/schemas/ISODateTime' title: MetaData OBScheduledPayment3: type: object additionalProperties: false deprecated: false properties: AccountId: $ref: '#/components/schemas/AccountId' ScheduledPaymentId: $ref: '#/components/schemas/ScheduledPaymentId' ScheduledPaymentDateTime: $ref: '#/components/schemas/ScheduledPaymentDateTime' ScheduledType: $ref: '#/components/schemas/OBInternalScheduleType1Code' 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' required: - AccountId - InstructedAmount - ScheduledPaymentDateTime - ScheduledType nullable: false ActiveOrHistoricCurrencyCode_1: type: string 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". example: GBP pattern: ^[A-Z]{3,3}$ ActiveOrHistoricCurrencyCode_0: type: string description: "Identification of the currency in which the account is held. \nUsage: Currency should only be used in\ \ case one and the same account number covers several currencies\nand the initiating party needs to identify which\ \ currency needs to be used for settlement on the account." pattern: ^[A-Z]{3,3}$ OBExtendedProprietaryBankTransactionCode: type: object description: Additional proprietary bank transaction codes used by the ASPSP for the underlying transaction properties: Code: type: string description: Proprietary bank transaction code to identify the underlying transaction. maxLength: 35 minLength: 1 Issuer: type: string description: Identification of the issuer of the proprietary bank transaction code. maxLength: 35 minLength: 1 Description: type: string description: Description of the code and its usage on the ASPSP channel maxLength: 500 minLength: 1 required: - Code OBStatement2: type: object additionalProperties: false deprecated: false description: Provides further details on a statement resource. properties: AccountId: $ref: '#/components/schemas/AccountId' StatementId: $ref: '#/components/schemas/StatementId' StatementReference: $ref: '#/components/schemas/StatementReference' Type: $ref: '#/components/schemas/OBInternalStatementType1Code' StartDateTime: $ref: '#/components/schemas/StartDateTime' EndDateTime: $ref: '#/components/schemas/EndDateTime' CreationDateTime: $ref: '#/components/schemas/CreationDateTime' StatementDescription: type: array items: type: string description: Other descriptions that may be available for the statement resource. example: August 2017 Statement maxLength: 500 minLength: 1 maxItems: 99999 minItems: 0 StatementBenefit: type: array items: type: object description: Set of elements used to provide details of a benefit or reward amount for the statement resource. properties: Type: $ref: '#/components/schemas/OBInternalStatementBenefitType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_5' required: - Amount - Type maxItems: 99999 minItems: 0 StatementFee: type: array items: type: object description: Set of elements used to provide details of a fee for the statement resource. properties: Description: $ref: '#/components/schemas/Description_1' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementFeeType1Code' Rate: $ref: '#/components/schemas/OBRate1_0' RateType: $ref: '#/components/schemas/OBInternalStatementFeeRateType1Code' Frequency: $ref: '#/components/schemas/OBInternalStatementFeeFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_6' required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementInterest: type: array items: type: object description: Set of elements used to provide details of a generic interest amount related to the statement resource. properties: Description: $ref: '#/components/schemas/Description_2' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementInterestType1Code' Rate: $ref: '#/components/schemas/OBRate1_1' RateType: $ref: '#/components/schemas/OBInternalStatementInterestRateType1Code' Frequency: $ref: '#/components/schemas/OBInternalStatementInterestFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_7' required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementAmount: type: array items: type: object description: Set of elements used to provide details of a generic amount for the statement resource. properties: CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementAmountType1Code' Amount: type: object description: Amount of money of the cash balance. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' SubType: type: string default: BCUR description: The amount in the domestic or base accounting currency. Default is Base Currency (BCUR) if not specified enum: - BCUR - LCUR required: - Amount - Currency LocalAmount: type: object description: Optional component providing the equivalent of Amount in local currency. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' SubType: type: string default: LCUR description: The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified enum: - BCUR - LCUR required: - Amount - Currency required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementDateTime: type: array items: type: object description: Set of elements used to provide details of a generic date time for the statement resource. properties: DateTime: $ref: '#/components/schemas/DateTime' Type: $ref: '#/components/schemas/OBInternalStatementDateTimeType1Code' required: - DateTime - Type maxItems: 99999 minItems: 0 StatementRate: type: array items: type: object description: Set of elements used to provide details of a generic rate related to the statement resource. properties: Rate: $ref: '#/components/schemas/Rate' Type: $ref: '#/components/schemas/OBInternalStatementRateType1Code' required: - Rate - Type maxItems: 99999 minItems: 0 StatementValue: type: array items: type: object description: Set of elements used to provide details of a generic number value related to the statement resource. properties: Value: $ref: '#/components/schemas/Value' Type: $ref: '#/components/schemas/OBInternalStatementValueType1Code' required: - Type - Value maxItems: 99999 minItems: 0 TotalValue: type: object description: Combined sum of all Amounts in the accounts base currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency required: - AccountId - CreationDateTime - EndDateTime - StartDateTime - Type nullable: false PhoneNumber_0: type: string description: Collection of information that identifies a phone number, as defined by telecom services. example: +44-2079460000 pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} PhoneNumber_1: type: string description: Collection of information that identifies a mobile phone number, as defined by telecom services. example: +44-7700900000 pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} ValueDateTime: type: string format: date-time description: "Date and time at which assets become available to the account owner in case of a credit entry, or cease\ \ to be available to the account owner in case of a debit transaction entry.\nUsage: If transaction entry status is\ \ pending and value date is present, then the value date refers to an expected/requested value date.\nFor transaction\ \ entries subject to availability/float and for which availability information is provided, the value date must not\ \ be used. In this case the availability component identifies the number of availability days. All dates in the JSON\ \ payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" OBReadDataStatement2: type: object additionalProperties: false deprecated: false properties: Statement: type: array items: $ref: '#/components/schemas/OBStatement2' maxItems: 99999 minItems: 0 nullable: false NumberOfPayments: type: string description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. maxLength: 35 minLength: 1 OBStandingOrder6: type: object additionalProperties: false deprecated: false properties: AccountId: $ref: '#/components/schemas/AccountId' StandingOrderId: $ref: '#/components/schemas/StandingOrderId' NextPaymentDateTime: $ref: '#/components/schemas/NextPaymentDateTime' LastPaymentDateTime: $ref: '#/components/schemas/LastPaymentDateTime' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' StandingOrderStatusCode: $ref: '#/components/schemas/ExternalMandateStatus1Code' 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' MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' required: - AccountId nullable: false PointInTime: type: string description: 'Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside `CountPerPeriod`.' example: '00' maxLength: 2 OBReadConsentResponse1: type: object additionalProperties: false deprecated: false properties: Data: type: object properties: ConsentId: type: string description: Unique identification as assigned to identify the account access consent resource. maxLength: 128 minLength: 1 CreationDateTime: $ref: '#/components/schemas/CreationDateTime' Status: $ref: '#/components/schemas/OBInternalConsentStatus1Code' StatusReason: type: array description: Specifies the status reason. items: $ref: '#/components/schemas/OBStatusReason' maxItems: 99999 minItems: 0 StatusUpdateDateTime: $ref: '#/components/schemas/StatusUpdateDateTime' Permissions: type: array items: type: string 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.
For a full list of enumeration values refer to `OBInternalPermissions1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) enum: - ReadAccountsBasic - ReadAccountsDetail - ReadBalances - ReadBeneficiariesBasic - ReadBeneficiariesDetail - ReadDirectDebits - ReadOffers - ReadPAN - ReadParty - ReadPartyPSU - ReadProducts - ReadScheduledPaymentsBasic - ReadScheduledPaymentsDetail - ReadStandingOrdersBasic - ReadStandingOrdersDetail - ReadStatementsBasic - ReadStatementsDetail - ReadTransactionsBasic - ReadTransactionsCredits - ReadTransactionsDebits - ReadTransactionsDetail maxItems: 99999 minItems: 1 ExpirationDateTime: type: string format: date-time description: "Specified date and time the permissions will expire.\nIf this is not populated, the permissions\ \ will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time\ \ fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" TransactionFromDateTime: type: string format: date-time description: "Specified start date and time for the transaction query period.\nIf this is not populated, the\ \ start date will be open ended, and data will be returned from the earliest available transaction. All dates\ \ in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must\ \ include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" TransactionToDateTime: type: string format: date-time description: "Specified end date and time for the transaction query period.\nIf this is not populated, the end\ \ date will be open ended, and data will be returned to the latest available transaction. All dates in the\ \ JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include\ \ the timezone. An example is below:\n2017-04-05T10:43:07+00:00" required: - ConsentId - CreationDateTime - Permissions - Status - StatusUpdateDateTime Risk: $ref: '#/components/schemas/OBRisk2' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data - Risk nullable: false OB_MinMaxType1Code: type: string description: Min Max type enum: - FMMN - FMMX TransactionId: type: string description: Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable. maxLength: 210 minLength: 1 OBBranchAndFinancialInstitutionIdentification6_0: type: object description: 'Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.' properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name_1' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' LEI: $ref: '#/components/schemas/LEI' OBBranchAndFinancialInstitutionIdentification6_1: type: object description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_2' Name: $ref: '#/components/schemas/Name_1' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' OBBranchAndFinancialInstitutionIdentification6_2: type: object description: Financial institution servicing an account for the debtor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_2' Name: $ref: '#/components/schemas/Name_1' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' OBFrequencyPeriodType: type: string description: "Individual Definitions:\n ADHO - Adhoc \n YEAR - Annual\nDAIL - Daily\nINDA - Intra Day\nMNTH - Monthly\n\ QURT - Quarterly\nWEEK - Weekly " enum: - ADHO - YEAR - DAIL - INDA - MNTH - QURT - MIAN - WEEK OBMerchantDetails1: type: object description: Details of the merchant involved in the transaction. properties: MerchantName: type: string description: Name by which the merchant is known. maxLength: 350 minLength: 1 MerchantCategoryCode: type: string description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. maxLength: 4 minLength: 3 OBMandateRelatedInformation1: type: object description: Provides further details of the mandate signed between the creditor and the debtor. properties: MandateIdentification: type: string description: Unique identification, as assigned by the creditor, to unambiguously identify the mandate. example: Golfers maxLength: 35 minLength: 1 Classification: $ref: '#/components/schemas/OBExternalMandateClassification1Code' CategoryPurposeCode: $ref: '#/components/schemas/ExternalCategoryPurpose1Code' FirstPaymentDateTime: type: string format: date-time description: The date on which the first payment for a recurrent credit transfer will be made. example: '2024-04-25T12:46:49.425Z' RecurringPaymentDateTime: type: string format: date-time description: "The date on which the first recurring payment for a Standing Order schedule will be made. \nUsage:\ \ This must be populated only if the first recurring date is different to the first payment date. All dates in\ \ the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include\ \ the timezone. An example is below:\n2017-04-05T10:43:07+00:00" example: '2024-04-25T12:46:49.425Z' FinalPaymentDateTime: type: string format: date-time description: The date on which the final payment for a recurrent credit transfer will be made. example: '2024-04-25T12:46:49.425Z' Frequency: $ref: '#/components/schemas/OBFrequency6' Reason: type: string description: Reason for the setup of the credit transfer mandate. example: To pay monthly membership maxLength: 256 minLength: 1 required: - Frequency PostCode: type: string description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. example: EC2N 4AG maxLength: 16 minLength: 1 OBFileFormat: type: string description: For a full list of enumeration values refer to `ExternalDocumentFormat1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) enum: - DPDF - DXML - SDSH - WORD - XSLT - DCSV BuildingName: type: string description: Name of a referenced building. maxLength: 140 minLength: 1 OBCashAccount5_1: type: object description: Provides the details to identify the beneficiary account. properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: type: string description: Beneficiary account identification. maxLength: 256 minLength: 1 Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' required: - Identification - SchemeName OBInternalStatementFeeType1Code: type: string description: Fee type, in a coded form. For a full list of values see `OBInternalStatementFeeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.Annual x-namespaced-enum: - UK.OBIE.Annual - UK.OBIE.BalanceTransfer - UK.OBIE.CashAdvance - UK.OBIE.CashTransaction - UK.OBIE.ForeignCashTransaction - UK.OBIE.ForeignTransaction - UK.OBIE.Gambling - UK.OBIE.LatePayment - UK.OBIE.MoneyTransfer - UK.OBIE.Monthly - UK.OBIE.Overlimit - UK.OBIE.PostalOrder - UK.OBIE.PrizeEntry - UK.OBIE.StatementCopy - UK.OBIE.Total - UK.OBIE.InstalmentPlan - UK.OBIE.ReturnedPayment OBStatement2Detail: type: object additionalProperties: false description: Provides further details on a statement resource. properties: AccountId: $ref: '#/components/schemas/AccountId' StatementId: $ref: '#/components/schemas/StatementId' StatementReference: $ref: '#/components/schemas/StatementReference' Type: $ref: '#/components/schemas/OBInternalStatementType1Code' StartDateTime: $ref: '#/components/schemas/StartDateTime' EndDateTime: $ref: '#/components/schemas/EndDateTime' CreationDateTime: $ref: '#/components/schemas/CreationDateTime' StatementDescription: type: array items: type: string description: Other descriptions that may be available for the statement resource. maxLength: 500 minLength: 1 maxItems: 99999 minItems: 0 StatementBenefit: type: array items: type: object description: Set of elements used to provide details of a benefit or reward amount for the statement resource. properties: Type: $ref: '#/components/schemas/OBInternalStatementBenefitType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_5' required: - Amount - Type maxItems: 99999 minItems: 0 StatementFee: type: array items: type: object description: Set of elements used to provide details of a fee for the statement resource. properties: Description: $ref: '#/components/schemas/Description_1' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementFeeType1Code' Rate: $ref: '#/components/schemas/OBRate1_0' RateType: $ref: '#/components/schemas/OBInternalStatementFeeRateType1Code' Frequency: $ref: '#/components/schemas/OBInternalStatementFeeFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_6' required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementInterest: type: array items: type: object description: Set of elements used to provide details of a generic interest amount related to the statement resource. properties: Description: $ref: '#/components/schemas/Description_2' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementInterestType1Code' Rate: $ref: '#/components/schemas/OBRate1_1' RateType: $ref: '#/components/schemas/OBInternalStatementInterestRateType1Code' Frequency: $ref: '#/components/schemas/OBInternalStatementInterestFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_7' required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementAmount: type: array items: type: object description: Set of elements used to provide details of a generic amount for the statement resource. properties: CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementAmountType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_8' LocalAmount: type: object description: Optional component providing the equivalent of Amount in local currency. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' SubType: type: string default: LCUR description: The amount in the local market currency for which the asset is held. Default is Local Currency (LCUR) if not specified enum: - BCUR - LCUR required: - Amount - Currency required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementDateTime: type: array items: type: object description: Set of elements used to provide details of a generic date time for the statement resource. properties: DateTime: $ref: '#/components/schemas/DateTime' Type: $ref: '#/components/schemas/OBInternalStatementDateTimeType1Code' required: - DateTime - Type maxItems: 99999 minItems: 0 StatementRate: type: array items: type: object description: Set of elements used to provide details of a generic rate related to the statement resource. properties: Rate: $ref: '#/components/schemas/Rate' Type: $ref: '#/components/schemas/OBInternalStatementRateType1Code' required: - Rate - Type maxItems: 99999 minItems: 0 StatementValue: type: array items: type: object description: Set of elements used to provide details of a generic number value related to the statement resource. properties: Value: $ref: '#/components/schemas/Value' Type: $ref: '#/components/schemas/OBInternalStatementValueType1Code' required: - Type - Value maxItems: 99999 minItems: 0 TotalValue: type: object description: Combined sum of all Amounts in the accounts base currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency required: - AccountId - CreationDateTime - EndDateTime - StartDateTime - Type PreviousPaymentDateTime: type: string format: date-time description: "Date of most recent direct debit collection. All dates in the JSON payloads are represented in ISO 8601\ \ date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" OBInternalAccountRole1Code: type: string description: A party’s role with respect to the related account. For a full list refer to `OBInternalAccountRole1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) x-namespaced-enum: - UK.OBIE.Administrator - UK.OBIE.Beneficiary - UK.OBIE.CustodianForMinor - UK.OBIE.Granter - UK.OBIE.LegalGuardian - UK.OBIE.OtherParty - UK.OBIE.PowerOfAttorney - UK.OBIE.Principal - UK.OBIE.Protector - UK.OBIE.RegisteredShareholderName - UK.OBIE.SecondaryOwner - UK.OBIE.SeniorManagingOfficial - UK.OBIE.Settlor - UK.OBIE.SuccessorOnDeath OBBankTransactionCodeStructure1: type: object description: Set of elements used to fully identify the type of underlying transaction resulting in an entry. properties: Code: type: string description: Specifies the family within a domain. SubCode: type: string description: Specifies the sub-product family within a specific family. required: - Code - SubCode OBParty2: type: object additionalProperties: false properties: PartyId: $ref: '#/components/schemas/PartyId' PartyNumber: $ref: '#/components/schemas/PartyNumber' PartyType: $ref: '#/components/schemas/OBInternalPartyType1Code' Name: $ref: '#/components/schemas/Name_3' FullLegalName: $ref: '#/components/schemas/FullLegalName' LegalStructure: $ref: '#/components/schemas/OBInternalLegalStructureType1Code' LEI: $ref: '#/components/schemas/LEI' BeneficialOwnership: type: boolean description: A flag to indicate a party's beneficial ownership of the related account AccountRole: $ref: '#/components/schemas/OBInternalAccountRole1Code' 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: $ref: '#/components/schemas/OBPostalAddress7' maxItems: 99999 minItems: 0 required: - PartyId OBReadTransaction6: type: object additionalProperties: false deprecated: false properties: Data: $ref: '#/components/schemas/OBReadDataTransaction6' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBStandingOrder6Detail: type: object additionalProperties: false deprecated: false properties: AccountId: $ref: '#/components/schemas/AccountId' StandingOrderId: $ref: '#/components/schemas/StandingOrderId' NextPaymentDateTime: $ref: '#/components/schemas/NextPaymentDateTime' LastPaymentDateTime: $ref: '#/components/schemas/LastPaymentDateTime' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' StandingOrderStatusCode: $ref: '#/components/schemas/ExternalMandateStatus1Code' 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' MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' required: - AccountId - CreditorAccount nullable: false OBAccount6: type: object additionalProperties: false 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:\n\n * Data.Currency \n * Data.AccountCategory \n * Data.AccountTypeCode\n\ \nFor all other accounts, the fields must be populated by the ASPSP." properties: AccountId: $ref: '#/components/schemas/AccountId' Status: $ref: '#/components/schemas/OBInternalAccountStatus1Code' StatusUpdateDateTime: $ref: '#/components/schemas/StatusUpdateDateTime' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_0' AccountCategory: $ref: '#/components/schemas/OBInternalAccountType1Code' AccountTypeCode: $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/OBInternalSwitchStatusCode' Account: type: array items: type: object description: Provides the details to identify an account. properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' LEI: $ref: '#/components/schemas/LEI' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' required: - Identification - SchemeName maxItems: 99999 minItems: 0 StatementFrequencyAndFormat: $ref: '#/components/schemas/StatementFrequencyAndFormat' Servicer: $ref: '#/components/schemas/OBBranchAndFinancialInstitutionIdentification5_0' required: - AccountId OBRemittanceInformation2: type: object description: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system properties: Structured: type: array items: $ref: '#/components/schemas/OBRemittanceInformationStructured' maxItems: 99999 minItems: 0 Unstructured: type: array description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. items: type: string maxLength: 140 minLength: 1 maxItems: 99999 minItems: 0 OB_OtherCodeType1_0: type: object additionalProperties: false deprecated: false properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name nullable: false OBReadConsent1: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: Permissions: type: array items: type: string 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.
For a full list of enumeration values refer to `OBInternalPermissions1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) enum: - ReadAccountsBasic - ReadAccountsDetail - ReadBalances - ReadBeneficiariesBasic - ReadBeneficiariesDetail - ReadDirectDebits - ReadOffers - ReadPAN - ReadParty - ReadPartyPSU - ReadProducts - ReadScheduledPaymentsBasic - ReadScheduledPaymentsDetail - ReadStandingOrdersBasic - ReadStandingOrdersDetail - ReadStatementsBasic - ReadStatementsDetail - ReadTransactionsBasic - ReadTransactionsCredits - ReadTransactionsDebits - ReadTransactionsDetail maxItems: 99999 minItems: 1 ExpirationDateTime: type: string format: date-time description: "Specified date and time the permissions will expire.\nIf this is not populated, the permissions\ \ will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time\ \ fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" TransactionFromDateTime: type: string format: date-time description: "Specified start date and time for the transaction query period.\nIf this is not populated, the\ \ start date will be open ended, and data will be returned from the earliest available transaction. All dates\ \ in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must\ \ include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" TransactionToDateTime: type: string format: date-time description: "Specified end date and time for the transaction query period.\nIf this is not populated, the end\ \ date will be open ended, and data will be returned to the latest available transaction. All dates in the\ \ JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include\ \ the timezone. An example is below:\n2017-04-05T10:43:07+00:00" required: - Permissions Risk: $ref: '#/components/schemas/OBRisk2' required: - Data - Risk nullable: false OBInternalStatementType1Code: type: string description: Statement type, in a coded form. For a full list of values see `OBInternalStatementType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - AccountClosure - AccountOpening - Annual - Interim - RegularPeriodic example: RegularPeriodic OB_OtherCodeType1_5: type: object additionalProperties: false deprecated: false description: Other fee rate type which is not in the standard rate type list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name nullable: false OB_OtherCodeType1_6: type: object additionalProperties: false deprecated: false description: Other application frequencies not covered in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name nullable: false OB_OtherCodeType1_7: type: object additionalProperties: false deprecated: false description: Other calculation frequency which is not available in standard code set. properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name nullable: false OBPostalAddress7: type: object description: Information that locates and identifies a specific address, as defined by postal services. properties: AddressType: $ref: '#/components/schemas/OBAddressType2Code' Department: type: string description: Identification of a division of a large organisation or building. example: Finance maxLength: 70 minLength: 1 SubDepartment: type: string description: Identification of a sub-division of a large organisation or building. example: Payroll maxLength: 70 minLength: 1 StreetName: $ref: '#/components/schemas/StreetName' BuildingNumber: $ref: '#/components/schemas/BuildingNumber' BuildingName: $ref: '#/components/schemas/BuildingName' Floor: $ref: '#/components/schemas/Floor' UnitNumber: $ref: '#/components/schemas/UnitNumber' Room: $ref: '#/components/schemas/Room' PostBox: $ref: '#/components/schemas/PostBox' TownLocationName: $ref: '#/components/schemas/TownName' DistrictName: $ref: '#/components/schemas/DistrictName' CareOf: $ref: '#/components/schemas/CareOf' PostCode: $ref: '#/components/schemas/PostCode' TownName: $ref: '#/components/schemas/TownName' CountrySubDivision: type: string description: Identifies a subdivision of a country such as state, region, county. maxLength: 35 minLength: 1 Country: type: string description: Nation with its own government. pattern: ^[A-Z]{2,2}$ AddressLine: type: array items: type: string description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text. maxLength: 70 minLength: 1 maxItems: 7 minItems: 0 OBReadBeneficiary5: type: object deprecated: false properties: Data: type: object properties: Beneficiary: type: array items: $ref: '#/components/schemas/OBBeneficiary5' maxItems: 99999 minItems: 0 Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OB_OtherCodeType1_8: type: object additionalProperties: false deprecated: false description: Other fee rate type which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name nullable: false OB_OtherCodeType1_1: type: object additionalProperties: false deprecated: false description: Other application frequencies that are not available in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name nullable: false OBRate1_0: type: number description: Rate charged for Statement Fee (where it is charged in terms of a rate rather than an amount) example: 0.05 OB_OtherCodeType1_2: type: object additionalProperties: false deprecated: false description: Other calculation frequency which is not available in the standard code set. properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name nullable: false OB_OtherCodeType1_3: type: object additionalProperties: false deprecated: false description: Other Fee type which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name nullable: false OB_OtherCodeType1_4: type: object additionalProperties: false deprecated: false description: Other fee rate type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name nullable: false OBCommunicationMethod: type: string description: 'For a full list of enumeration values see `OBExternalCommunicationMethod2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) ' enum: - EMAL - FAXI - FILE - ONLI - POST DistrictName: type: string description: Number that of the regional area, known as a district, which forms part of an address example: Greater London maxLength: 140 minLength: 1 OBRate1_1: type: number description: Rate for Statement Interest (where it is applicable in terms of a rate rather than an amount) example: 0.05 OBCashAccount5_0: type: object description: Provides the details to identify the beneficiary account. properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' required: - Identification - SchemeName OBBalanceType1Code: type: string description: Balance type, in a coded form.
For a full list of enumeration values refer to `ExternalBalanceType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). enum: - CLAV - CLBD - FWAV - INFO - ITAV - ITBD - OPAV - OPBD - PRCD - XPCD example: CLAV BuildingNumber: type: string description: Number that identifies the position of a building on a street. example: '11' maxLength: 16 minLength: 1 OBUltimateDebtor1: type: object description: Ultimate party that owes an amount of money to the (ultimate) creditor. properties: Name: type: string description: Name by which a party is known and which is usually used to identify that party. maxLength: 140 minLength: 1 Identification: type: string description: Identification assigned by an institution. maxLength: 256 minLength: 1 LEI: $ref: '#/components/schemas/LEI' SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' OB_Rate1_0: type: string description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ AccountId: type: string description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. example: '22289' maxLength: 40 minLength: 1 OB_Rate1_1: type: string description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ OBInternalAccountIdentification4Code: type: string description: Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) x-namespaced-enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber - UK.OBIE.Wallet OBReadDirectDebit2: type: object additionalProperties: false deprecated: false properties: Data: type: object properties: DirectDebit: type: array items: type: object description: Account to or from which a cash entry is made. properties: AccountId: $ref: '#/components/schemas/AccountId' DirectDebitId: $ref: '#/components/schemas/DirectDebitId' DirectDebitStatusCode: $ref: '#/components/schemas/ExternalMandateStatus1Code' MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' Name: $ref: '#/components/schemas/Name_2' PreviousPaymentDateTime: $ref: '#/components/schemas/PreviousPaymentDateTime' PreviousPaymentAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_0' required: - AccountId - Name maxItems: 99999 minItems: 0 Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBCashAccount6_1: type: object description: Unambiguous identification of the account of the debtor, in the case of a credit transaction. properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' OBCashAccount6_0: type: object description: Unambiguous identification of the account of the creditor, in the case of a debit transaction. properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' OBInternalAccountType1Code: type: string description: Specifies the type of account (personal or business).
For a full list of enumeration values refer to 'OBInternalAccountType1Code' in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - Business - Personal OBAddressType2Code: type: string description: Identifies the nature of the postal address.
For a full set of codes see `OBAddressType2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). enum: - BIZZ - DLVY - MLTO - PBOX - ADDR - HOME - CORR - STAT example: BIZZ OBReadOffer1: type: object additionalProperties: false deprecated: false properties: Data: type: object properties: Offer: type: array items: type: object properties: AccountId: $ref: '#/components/schemas/AccountId' OfferId: type: string description: A unique and immutable identifier used to identify the offer resource. This identifier has no meaning to the account owner. example: Offer1 maxLength: 40 minLength: 1 OfferType: type: string description: Offer type, in a coded form. For a full list of values refer to `OBExternalOfferType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - BalanceTransfer - LimitIncrease - MoneyTransfer - Other - PromotionalRate example: LimitIncrease Description: type: string description: Further details of the offer. example: Credit limit increase for the account up to £10000.00 maxLength: 500 minLength: 1 StartDateTime: type: string format: date-time description: "Date and time at which the offer starts. All dates in the JSON payloads are represented\ \ in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example\ \ is below:\n2017-04-05T10:43:07+00:00" example: '2024-05-29T00:00:00Z' EndDateTime: type: string format: date-time description: "Date and time at which the offer ends. All dates in the JSON payloads are represented in\ \ ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example\ \ is below:\n2017-04-05T10:43:07+00:00" example: '2024-06-29T00:00:00Z' Rate: type: string description: Rate associated with the offer type. example: '100.00' pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Value: type: integer description: Value associated with the offer type. example: 10 maximum: 9999999 minimum: 0 Term: type: string description: Further details of the term of the offer. example: Starting first of the month and ending at the end of year maxLength: 500 minLength: 1 URL: type: string description: URL (Uniform Resource Locator) where documentation on the offer can be found example: http://modelbank.com/offer/offer1 maxLength: 256 minLength: 1 Amount: type: object description: Amount of money associated with the offer type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency Fee: type: object description: Fee associated with the offer type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency required: - AccountId maxItems: 99999 minItems: 0 Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OB_InterestFixedVariableType1Code: type: string description: Type of interest rate, Fixed or Variable enum: - INFI - INVA Nickname: type: string description: The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account. maxLength: 70 minLength: 1 OB_OverdraftFeeType1Code: type: string description: Overdraft fee type enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT CountrySubDivision: type: string description: Identifies a subdivision of a country eg, state, region, county. maxLength: 35 minLength: 1 OBReadStandingOrder6: type: object additionalProperties: false deprecated: false properties: Data: type: object properties: StandingOrder: type: array items: $ref: '#/components/schemas/OBStandingOrder6' maxItems: 99999 minItems: 0 Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBReadProduct2: type: object additionalProperties: false deprecated: false description: Product details of Other Product which is not available in the standard list properties: Data: type: object description: Aligning with the read write specs structure. properties: Product: type: array items: type: object description: Product details associated with the Account properties: ProductName: type: string description: The name of the Product used for marketing purposes from a customer perspective. I.e. what the customer would recognise. example: 321 Product maxLength: 350 minLength: 1 ProductId: type: string description: Identifier within the parent organisation for the product. Must be unique in the organisation example: 51B maxLength: 40 minLength: 1 AccountId: $ref: '#/components/schemas/AccountId' SecondaryProductId: type: string description: Any secondary Identification which supports Product Identifier to uniquely identify the current account banking products. example: CA78 maxLength: 70 minLength: 1 ProductType: type: string description: Descriptive code for the product category. For a full list refer to `OBInternalProductType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)

If ProductType - "Other" is chosen, the object OtherProductType must be populated with name, and description. enum: - BusinessCurrentAccount - CommercialCreditCard - Other - PersonalCurrentAccount - SMELoan example: PersonalCurrentAccount MarketingStateId: type: string description: Unique and unambiguous identification of a Product Marketing State. example: '22878123' maxLength: 35 minLength: 1 OtherProductType: type: object description: This field provides extension to the ProductType enumeration. If ProductType - "Other" is chosen, this field must be populated with name, and description for ASPSP specific product type. properties: Name: type: string description: Name of "Other" product type. example: e-Wallet maxLength: 350 minLength: 1 Description: type: string description: Description of "Other" product type example: Virtual wallet maxLength: 350 minLength: 1 ProductDetails: type: object properties: Segment: type: array items: type: string 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 ' 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 maxItems: 99999 minItems: 0 FeeFreeLength: type: integer description: The length/duration of the fee free period example: 12 maximum: 9999999 minimum: 0 FeeFreeLengthPeriod: type: string description: The unit of period (days, weeks, months etc.) of the promotional length enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER MonthlyMaximumCharge: type: string description: The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: type: string description: Optional additional notes to supplement the Core product details maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherSegment: $ref: '#/components/schemas/OB_OtherCodeType1_0' CreditInterest: type: object description: Details about the interest that may be payable to the Account holders properties: TierBandSet: type: array items: type: object description: The group of tiers or bands for which credit interest can be applied. properties: TierBandMethod: type: string 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' enum: - INBA - INTI - INWH CalculationMethod: $ref: '#/components/schemas/OB_InterestCalculationMethod1Code' Destination: type: string description: Describes whether accrued interest is payable only to the BCA or to another bank account enum: - INOT - INPA - INSC Notes: type: array items: type: string description: Optional additional notes to supplement the Tier Band Set details maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherCalculationMethod: $ref: '#/components/schemas/OB_OtherCodeType1_0' OtherDestination: $ref: '#/components/schemas/OB_OtherCodeType1_0' TierBand: type: array items: type: object description: Tier Band Details properties: Identification: type: string description: Unique and unambiguous identification of a Tier Band for the Product. maxLength: 35 minLength: 1 TierValueMinimum: type: string description: Minimum deposit value for which the credit interest tier applies. pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMaximum: type: string description: Maximum deposit value for which the credit interest tier applies. pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CalculationFrequency: type: string description: How often is credit interest calculated for the account. enum: - FQAT - FQDY - FQHY - FQMY - FQOT - FQQY - FQSD - FQWY - FQYY ApplicationFrequency: type: string 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. enum: - FQAT - FQDY - FQHY - FQMY - FQOT - FQQY - FQSD - FQWY - FQYY DepositInterestAppliedCoverage: type: string description: Amount on which Interest applied. enum: - INBA - INTI - INWH FixedVariableInterestRateType: $ref: '#/components/schemas/OB_InterestFixedVariableType1Code' AER: type: string description: "The annual equivalent rate (AER) is interest that is calculated under\ \ the assumption that any interest paid is combined with the original balance and\ \ the next interest payment will be based on the slightly higher account balance.\ \ Overall, this means that interest can be compounded several times in a year depending\ \ on the number of times that interest payments are made. \nRead more: Annual Equivalent\ \ Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A" pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ BankInterestRateType: type: string 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. enum: - INBB - INFR - INGR - INLR - INNE - INOT BankInterestRate: type: string description: Bank Interest for the product pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: type: string description: Optional additional notes to supplement the Tier Band details maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherBankInterestType: type: object description: Other interest rate types which are not available in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_1' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_2' required: - AER - ApplicationFrequency - FixedVariableInterestRateType - TierValueMinimum maxItems: 99999 minItems: 1 required: - Destination - TierBand - TierBandMethod maxItems: 99999 minItems: 1 required: - TierBandSet Overdraft: type: object description: Borrowing details properties: Notes: type: array items: type: string description: Associated Notes about the overdraft rates maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OverdraftTierBandSet: type: array items: type: object description: Tier band set details properties: TierBandMethod: type: string description: "The methodology of how overdraft is charged. It can be:\n'Whole' Where the\ \ same charge/rate is applied to the entirety of the overdraft balance (where charges\ \ are applicable). \n'Tiered' Where different charges/rates are applied dependent on overdraft\ \ maximum and minimum balance amount tiers defined by the lending financial organisation\n\ 'Banded' Where different charges/rates are applied dependent on overdraft maximum and\ \ minimum balance amount bands defined by a government organisation." enum: - INBA - INTI - INWH OverdraftType: type: string 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. enum: - OVCO - OVOD - OVOT Identification: type: string description: Unique and unambiguous identification of a Tier Band for a overdraft product. maxLength: 35 minLength: 1 AuthorisedIndicator: type: boolean description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) BufferAmount: type: string 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.' pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: type: string description: Optional additional notes to supplement the overdraft Tier Band Set details maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OverdraftTierBand: type: array items: type: object description: Provides overdraft details for a specific tier or band properties: Identification: type: string description: Unique and unambiguous identification of a Tier Band for a overdraft. maxLength: 35 minLength: 1 TierValueMin: type: string description: Minimum value of Overdraft Tier/Band pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMax: type: string description: Maximum value of Overdraft Tier/Band pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ EAR: type: string description: 'EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.' pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ AgreementLengthMin: type: integer description: Specifies the minimum length of a band for a fixed overdraft agreement example: 1 maximum: 9999999 minimum: 0 AgreementLengthMax: type: integer description: Specifies the maximum length of a band for a fixed overdraft agreement example: 1 maximum: 9999999 minimum: 0 AgreementPeriod: type: string description: Specifies the period of a fixed length overdraft agreement enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER OverdraftInterestChargingCoverage: type: string 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 . enum: - INBA - INTI - INWH BankGuaranteedIndicator: type: boolean 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. Notes: type: array items: type: string description: Optional additional notes to supplement the Tier/band details maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OverdraftFeesCharges: type: array items: type: object description: Overdraft fees and charges properties: OverdraftFeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. properties: FeeType: type: array items: type: string description: Fee/charge type which is being capped enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT maxItems: 99999 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: type: string description: Notes related to Overdraft fee charge cap maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name maxItems: 99999 minItems: 0 required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 OverdraftFeeChargeDetail: type: array items: type: object description: Details about the fees/charges properties: FeeType: $ref: '#/components/schemas/OB_OverdraftFeeType1Code' NegotiableIndicator: type: boolean description: Indicates whether fee and charges are negotiable OverdraftControlIndicator: type: boolean description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. 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: type: string description: Free text for capturing any other info related to Overdraft Fees Charge Details maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OverdraftFeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. properties: FeeType: type: array items: type: string description: Fee/charge type which is being capped enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT maxItems: 99999 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: type: string description: Notes related to Overdraft fee charge cap maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name maxItems: 99999 minItems: 0 required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 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' required: - ApplicationFrequency - FeeType maxItems: 99999 minItems: 1 required: - OverdraftFeeChargeDetail maxItems: 99999 minItems: 0 required: - TierValueMin maxItems: 99999 minItems: 1 OverdraftFeesCharges: type: array items: type: object description: Overdraft fees and charges details properties: OverdraftFeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. properties: FeeType: type: array items: type: string description: Fee/charge type which is being capped enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT maxItems: 99999 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: type: string description: Notes related to Overdraft fee charge cap maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name maxItems: 99999 minItems: 0 required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 OverdraftFeeChargeDetail: type: array items: type: object description: Details about the fees/charges properties: FeeType: $ref: '#/components/schemas/OB_OverdraftFeeType1Code' NegotiableIndicator: type: boolean description: Indicates whether fee and charges are negotiable OverdraftControlIndicator: type: boolean description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. 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: type: string description: Free text for capturing any other info related to Overdraft Fees Charge Details maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OverdraftFeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. properties: FeeType: type: array items: type: string description: Fee/charge type which is being capped enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT maxItems: 99999 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: type: string description: Notes related to Overdraft fee charge cap maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name maxItems: 99999 minItems: 0 required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 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' required: - ApplicationFrequency - FeeType maxItems: 99999 minItems: 1 required: - OverdraftFeeChargeDetail maxItems: 99999 minItems: 0 required: - OverdraftTierBand - TierBandMethod maxItems: 99999 minItems: 1 required: - OverdraftTierBandSet LoanInterest: type: object description: Details about the interest that may be payable to the SME Loan holders properties: Notes: type: array items: type: string description: Optional additional notes to supplement the LoanInterest maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 LoanInterestTierBandSet: type: array items: type: object description: The group of tiers or bands for which debit interest can be applied. properties: TierBandMethod: type: string 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' enum: - INBA - INTI - INWH Identification: type: string description: Loan interest tierbandset identification. Used by loan providers for internal use purpose. maxLength: 35 minLength: 1 CalculationMethod: $ref: '#/components/schemas/OB_InterestCalculationMethod1Code' Notes: type: array items: type: string description: Optional additional notes to supplement the Tier Band Set details maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherCalculationMethod: $ref: '#/components/schemas/OB_OtherCodeType1_0' LoanInterestTierBand: type: array items: type: object description: Tier Band Details properties: Identification: type: string description: Unique and unambiguous identification of a Tier Band for a SME Loan. maxLength: 35 minLength: 1 TierValueMinimum: type: string description: Minimum loan value for which the loan interest tier applies. pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMaximum: type: string description: Maximum loan value for which the loan interest tier applies. pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMinTerm: type: integer description: Minimum loan term for which the loan interest tier applies. example: 1 maximum: 9999999 minimum: 0 MinTermPeriod: type: string description: The unit of period (days, weeks, months etc.) of the Minimum Term enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER TierValueMaxTerm: type: integer description: Maximum loan term for which the loan interest tier applies. example: 1 maximum: 9999999 minimum: 0 MaxTermPeriod: type: string description: The unit of period (days, weeks, months etc.) of the Maximum Term enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER FixedVariableInterestRateType: $ref: '#/components/schemas/OB_InterestFixedVariableType1Code' RepAPR: type: string description: "The annual equivalent rate (AER) is interest that is calculated under\ \ the assumption that any interest paid is combined with the original balance and\ \ the next interest payment will be based on the slightly higher account balance.\ \ Overall, this means that interest can be compounded several times in a year depending\ \ on the number of times that interest payments are made. \nFor SME Loan, this APR\ \ is the representative APR which includes any account fees." pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ LoanProviderInterestRateType: type: string description: Interest rate types, other than APR, which financial institutions may use to describe the annual interest rate payable for the SME Loan. enum: - INBB - INFR - INGR - INLR - INNE - INOT LoanProviderInterestRate: type: string description: Loan provider Interest for the SME Loan product pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: type: string description: Optional additional notes to supplement the Tier Band details maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherLoanProviderInterestRateType: type: object description: Other loan interest rate types which are not available in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name LoanInterestFeesCharges: type: array items: type: object description: Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits properties: LoanInterestFeeChargeDetail: type: array items: type: object description: Other fees/charges details properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: type: boolean description: Fee/charge which is usually negotiable rather than a fixed amount 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: type: string description: Optional additional notes to supplement the fee/charge details. maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 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' required: - ApplicationFrequency - CalculationFrequency - FeeType maxItems: 99999 minItems: 1 LoanInterestFeeChargeCap: type: array items: type: object description: Details about any caps (minimum/maximum charges) that apply to a particular fee/charge properties: FeeType: type: array items: type: string description: Fee/charge type which is being capped enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX maxItems: 99999 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: type: string description: Free text for adding extra details for fee charge cap maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name maxItems: 99999 minItems: 0 required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 required: - LoanInterestFeeChargeDetail maxItems: 99999 minItems: 0 required: - FixedVariableInterestRateType - MinTermPeriod - RepAPR - TierValueMinTerm - TierValueMinimum maxItems: 99999 minItems: 1 LoanInterestFeesCharges: type: array items: type: object description: Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits properties: LoanInterestFeeChargeDetail: type: array items: type: object description: Other fees/charges details properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: type: boolean description: Fee/charge which is usually negotiable rather than a fixed amount 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: type: string description: Optional additional notes to supplement the fee/charge details. maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 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' required: - ApplicationFrequency - CalculationFrequency - FeeType maxItems: 99999 minItems: 1 LoanInterestFeeChargeCap: type: array items: type: object description: Details about any caps (minimum/maximum charges) that apply to a particular fee/charge properties: FeeType: type: array items: type: string description: Fee/charge type which is being capped enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX maxItems: 99999 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: type: string description: Free text for adding extra details for fee charge cap maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name maxItems: 99999 minItems: 0 required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 required: - LoanInterestFeeChargeDetail maxItems: 99999 minItems: 0 required: - CalculationMethod - LoanInterestTierBand - TierBandMethod maxItems: 99999 minItems: 1 required: - LoanInterestTierBandSet Repayment: type: object description: Repayment details of the Loan product properties: RepaymentType: type: string description: Repayment type enum: - USBA - USBU - USCI - USCS - USER - USFA - USFB - USFI - USIO - USOT - USPF - USRW - USSL RepaymentFrequency: type: string description: Repayment frequency enum: - SMDA - SMFL - SMFO - SMHY - SMMO - SMOT - SMQU - SMWE - SMYE AmountType: type: string description: The repayment is for paying just the interest only or both interest and capital or bullet amount or balance to date etc enum: - RABD - RABL - RACI - RAFC - RAIO - RALT - USOT Notes: type: array items: type: string description: Optional additional notes to supplement the Repayment maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherRepaymentType: type: object description: Other repayment type which is not in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name OtherRepaymentFrequency: type: object description: Other repayment frequency which is not in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name OtherAmountType: type: object description: Other amount type which is not in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name RepaymentFeeCharges: type: object description: Applicable fee/charges for repayment such as prepayment, full early repayment or non repayment. properties: RepaymentFeeChargeDetail: type: array items: type: object description: Details about specific fees/charges that are applied for repayment properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: type: boolean description: Fee/charge which is usually negotiable rather than a fixed amount 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: type: string description: Optional additional notes to supplement the fee/charge details. maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 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' required: - ApplicationFrequency - CalculationFrequency - FeeType maxItems: 99999 minItems: 1 RepaymentFeeChargeCap: type: array items: type: object description: RepaymentFeeChargeCap sets daily, weekly, monthly, yearly limits on the fees that are charged properties: FeeType: type: array items: type: string description: Fee/charge type which is being capped enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX maxItems: 99999 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: type: string description: Free text for adding extra details for fee charge cap maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name maxItems: 99999 minItems: 0 required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 required: - RepaymentFeeChargeDetail RepaymentHoliday: type: array items: type: object description: Details of capital repayment holiday if any properties: MaxHolidayLength: type: integer description: The maximum length/duration of a Repayment Holiday example: 1 maximum: 9999999 minimum: 0 MaxHolidayPeriod: type: string description: The unit of period (days, weeks, months etc.) of the repayment holiday enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER Notes: type: array items: type: string description: Free text for adding details for repayment holiday maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 maxItems: 99999 minItems: 0 OtherFeesCharges: type: array items: type: object description: Contains details of fees and charges which are not associated with either Overdraft or features/benefits properties: TariffType: type: string description: TariffType which defines the fee and charges. enum: - TTEL - TTMX - TTOT TariffName: type: string description: Name of the tariff maxLength: 350 minLength: 1 OtherTariffType: type: object description: Other tariff type which is not in the standard list. properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name FeeChargeDetail: type: array items: type: object description: Other fees/charges details properties: FeeCategory: $ref: '#/components/schemas/OB_FeeCategory1Code' FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: type: boolean description: Fee/charge which is usually negotiable rather than a fixed amount 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: type: string description: Optional additional notes to supplement the fee/charge details. maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 FeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge properties: FeeType: type: array items: type: string description: Fee/charge type which is being capped enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX maxItems: 99999 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: type: string description: Free text for adding extra details for fee charge cap maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name maxItems: 99999 minItems: 0 required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 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: type: object description: Range or amounts or rates for which the fee/charge applies properties: MinimumAmount: type: string description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MaximumAmount: type: string description: Maximum Amount on which fee is applicable (where it is expressed as an amount) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MinimumRate: type: string description: Minimum rate on which fee/charge is applicable(where it is expressed as a rate) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ MaximumRate: type: string description: Maximum rate on which fee/charge is applicable(where it is expressed as a rate) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ required: - ApplicationFrequency - FeeCategory - FeeType maxItems: 99999 minItems: 1 FeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge properties: FeeType: type: array items: type: string description: Fee/charge type which is being capped enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX maxItems: 99999 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: type: string description: Free text for adding extra details for fee charge cap maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' required: - Description - Name maxItems: 99999 minItems: 0 required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 required: - FeeChargeDetail maxItems: 99999 minItems: 0 SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - Description - Name BCA: $ref: '#/components/schemas/OBBCAData1' PCA: $ref: '#/components/schemas/OBPCAData1' required: - AccountId - ProductType maxItems: 99999 minItems: 0 Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false StandingOrderId: type: string description: A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner. example: Ben5 maxLength: 40 minLength: 1 AddressLine: type: string description: Information that locates and identifies a specific address for a transaction entry, that is presented in free format text. maxLength: 70 minLength: 1 OBInternalStatementFeeRateType1Code: type: string description: This code indicates the specific type of fee rate (e.g., AER, EAR). For a full list of values see `OBInternalStatementFeeRateType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.AER x-namespaced-enum: - UK.OBIE.AER - UK.OBIE.EAR OBSupplementaryData1: type: object additionalProperties: true deprecated: false description: Additional information that can not be captured in the structured fields and/or any other specific block. nullable: false TownName: type: string description: Name of a built-up area, with defined boundaries, and a local government. example: London maxLength: 140 minLength: 1 OBIntermediaryAgent: type: object description: The intermediary agent associated with this transaction. properties: Name: type: string description: Name by which an agent is known and which is usually used to identify that agent. example: name maxLength: 140 minLength: 1 SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: type: string description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. example: id maxLength: 35 minLength: 1 LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' ProcessingStatus: type: string description: Status of the payment at the Intermediary Agent. For a full list of enumeration values refer to `OBIntermediaryAgentStatus1Code` in `OB_Internal_CodeSet` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - PDNG - RCVD - ACSP - ACSC - RJCT - UNKN - CANC example: ACSP OBInternalStatementValueType1Code: type: string description: Statement value type, in a coded form. For a full list of values see `OBInternalStatementValueType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.Credit x-namespaced-enum: - UK.OBIE.AirMilesPoints - UK.OBIE.AirMilesPointsBalance - UK.OBIE.Credits - UK.OBIE.Debits - UK.OBIE.HotelPoints - UK.OBIE.HotelPointsBalance - UK.OBIE.RetailShoppingPoints - UK.OBIE.RetailShoppingPointsBalance OBBeneficiary5Basic: type: object additionalProperties: false properties: AccountId: $ref: '#/components/schemas/AccountId' BeneficiaryId: $ref: '#/components/schemas/BeneficiaryId' BeneficiaryType: $ref: '#/components/schemas/OBInternalBeneficiaryType1Code' Reference: $ref: '#/components/schemas/Reference' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' OBExternalBalanceSubType1Code: type: string description: Amount sub type, in a coded form. Default if not specified is BCUR of the account. enum: - BCUR - LCUR OBInternalStatementInterestFrequency1Code: type: string description: Specifies the statement fee type requested. For a full list of values see `OBInternalStatementInterestFrequency1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.Monthly x-namespaced-enum: - UK.OBIE.Daily - UK.OBIE.HalfYearly - UK.OBIE.Monthly - UK.OBIE.PerStatementDate - UK.OBIE.Quarterly - UK.OBIE.Weekly - UK.OBIE.Yearly OBInternalStatementDateTimeType1Code: type: string description: Date time type, in a coded form. For a full list of values see `OBInternalStatementDateTimeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.NextStatement x-namespaced-enum: - UK.OBIE.BalanceTransferPromoEnd - UK.OBIE.DirectDebitDue - UK.OBIE.LastPayment - UK.OBIE.LastStatement - UK.OBIE.NextStatement - UK.OBIE.PaymentDue - UK.OBIE.PurchasePromoEnd - UK.OBIE.StatementAvailable OB_Amount1_1: type: string description: Every additional tranche of an overdraft balance to which an overdraft fee is applied pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ ExternalDocumentType1Code: type: string description: Specifies the document type as published in an external document type code list. For more information see `ExternalDocumentType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - AROI - BOLD - CINV - CMCN - CNFA - CREN - DEBN - DISP - DNFA - HIRI - MSIN - PUOR - SBIN - SOAC - TSUT - VCHR maxLength: 4 minLength: 1 OB_Amount1_0: type: string description: Cap amount charged for a fee/charge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ OBFrequency6: type: object description: Regularity with which credit transfer instructions are to be created and processed properties: Type: $ref: '#/components/schemas/Frequency_1' CountPerPeriod: type: integer format: int32 description: 'Number of instructions to be created and processed during the specified period. Specifies a frequency in terms of a count per period within a specified frequency type. Note: should not be used alongside `PointInTime`' example: 1 maximum: 9999999 minimum: 0 PointInTime: $ref: '#/components/schemas/PointInTime' required: - Type BeneficiaryId: type: string description: A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner. example: Ben1 maxLength: 40 minLength: 1 OBFrequency2: type: string description: For a full list of enumeration values refer to `OBFrequency2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) enum: - YEAR - DAIL - INDA - MNTH - QURT - MIAN - TEND - MOVE - WEEK - NONE - SLCT OBInternalStatementAmountType1Code: type: string description: Amount type, in a coded form. example: UK.OBIE.CreditLimit x-namespaced-enum: - UK.OBIE.ArrearsClosingBalance - UK.OBIE.AvailableBalance - UK.OBIE.AverageBalanceWhenInCredit - UK.OBIE.AverageBalanceWhenInDebit - UK.OBIE.AverageDailyBalance - UK.OBIE.BalanceTransferClosingBalance - UK.OBIE.CashClosingBalance - UK.OBIE.ClosingBalance - UK.OBIE.CreditLimit - UK.OBIE.CurrentPayment - UK.OBIE.DirectDebitPaymentDue - UK.OBIE.FSCSInsurance - UK.OBIE.MinimumPaymentDue - UK.OBIE.PendingTransactionsBalance - UK.OBIE.PreviousClosingBalance - UK.OBIE.PreviousPayment - UK.OBIE.PurchaseClosingBalance - UK.OBIE.StartingBalance - UK.OBIE.TotalAdjustments - UK.OBIE.TotalCashAdvances - UK.OBIE.TotalCharges - UK.OBIE.TotalCredits - UK.OBIE.TotalDebits - UK.OBIE.TotalPurchases OBStandingOrder6Basic: type: object additionalProperties: false deprecated: false properties: AccountId: $ref: '#/components/schemas/AccountId' StandingOrderId: $ref: '#/components/schemas/StandingOrderId' NextPaymentDateTime: $ref: '#/components/schemas/NextPaymentDateTime' LastPaymentDateTime: $ref: '#/components/schemas/LastPaymentDateTime' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' StandingOrderStatusCode: $ref: '#/components/schemas/ExternalMandateStatus1Code' 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' MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' required: - AccountId nullable: false OBAccount6Detail: type: object additionalProperties: false description: Unambiguous identification of the account to which credit and debit entries are made. properties: AccountId: $ref: '#/components/schemas/AccountId' Status: $ref: '#/components/schemas/OBInternalAccountStatus1Code' StatusUpdateDateTime: $ref: '#/components/schemas/StatusUpdateDateTime' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_0' AccountCategory: $ref: '#/components/schemas/OBInternalAccountType1Code' AccountTypeCode: $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/OBInternalSwitchStatusCode' Account: type: array items: type: object description: Provides the details to identify an account. properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' Name: $ref: '#/components/schemas/Name_0' LEI: $ref: '#/components/schemas/LEI' SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' required: - Identification - SchemeName maxItems: 99999 minItems: 0 StatementFrequencyAndFormat: $ref: '#/components/schemas/StatementFrequencyAndFormat' Servicer: $ref: '#/components/schemas/OBBranchAndFinancialInstitutionIdentification5_0' required: - Account - AccountId TransactionReference: type: string description: Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context. maxLength: 210 minLength: 1 ExternalCreditorReferenceType1Code: type: string description: Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see `ExternalCreditorReferenceType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - DISP - FXDR - PUOR - RPIN - RADM - SCOR maxLength: 4 minLength: 1 OB_Amount1_4: type: string description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ SecondaryIdentification: type: string description: "This is secondary identification of the account, as assigned by the account servicing institution. \n\ 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)." example: '87562298675897' maxLength: 34 minLength: 1 OB_Amount1_3: type: string description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ OB_Amount1_2: type: string description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ OB_OtherFeeChargeDetailType: type: object additionalProperties: false deprecated: false description: Other Fee/charge type which is not available in the standard code set 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' required: - Description - FeeCategory - Name nullable: false OBReferredDocumentInformation: type: object properties: Code: $ref: '#/components/schemas/ExternalDocumentType1Code' Issuer: type: string description: Identification of the issuer of the reference document type. maxLength: 140 minLength: 1 Number: type: string description: Identification of the type specified for the referred document line. maxLength: 35 minLength: 1 RelatedDate: type: string format: date-time description: Date associated with the referred document line. LineDetails: type: array description: Set of elements used to provide the content of the referred document line. items: type: string maxLength: 2048 minLength: 1 maxItems: 99999 minItems: 0 Time: type: string format: time description: "Time at which assets become available to the account owner in case of a credit entry, or cease to be available\ \ to the account owner in case of a debit transaction entry.\nUsage: If transaction entry status is pending and value\ \ date is present, then the value date refers to an expected/requested value date.\nFor transaction entries subject\ \ to availability/float and for which availability information is provided, the value date must not be used. In this\ \ case the availability component identifies the number of availability days. All dates in the JSON payloads are represented\ \ in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n\ T10:43:07+00:00" OBError1: type: object additionalProperties: false minProperties: 1 properties: ErrorCode: $ref: '#/components/schemas/OBExternalStatusReason1Code' Message: type: string description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future'' OBL doesn''t standardise this field' maxLength: 500 minLength: 1 Path: type: string description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency maxLength: 500 minLength: 1 Url: type: string description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc required: - ErrorCode OBCurrencyExchange5: type: object description: Set of elements used to provide details on the currency exchange. properties: SourceCurrency: type: string description: Currency from which an amount is to be converted in a currency conversion. pattern: ^[A-Z]{3,3}$ TargetCurrency: type: string description: Currency into which an amount is to be converted in a currency conversion. pattern: ^[A-Z]{3,3}$ UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number 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).' ContractIdentification: type: string description: Unique identification to unambiguously identify the foreign exchange contract. maxLength: 35 minLength: 1 QuotationDate: type: string format: date-time description: "Date and time at which an exchange rate is quoted. All dates in the JSON payloads are represented\ \ in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n\ 2017-04-05T10:43:07+00:00" InstructedAmount: type: object description: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency required: - ExchangeRate - SourceCurrency OBErrorResponse1: type: object additionalProperties: false deprecated: false description: An array of detail error codes, and messages, and URLs to documentation to help remediation. properties: Id: type: string description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. maxLength: 40 minLength: 1 Code: type: string description: Deprecated
High level textual error code, to help categorise the errors. example: 400 BadRequest maxLength: 40 minLength: 1 Message: type: string description: Deprecated
Brief Error message example: There is something wrong with the request parameters provided maxLength: 500 minLength: 1 Errors: type: array items: $ref: '#/components/schemas/OBError1' maxItems: 99999 minItems: 1 required: - Errors nullable: false Room: type: string description: Information that locates and identifies a room to form part of an address example: Basement 03 maxLength: 70 minLength: 1 ScheduledPaymentDateTime: type: string format: date-time description: "The date on which the scheduled payment will be made. All dates in the JSON payloads are represented in\ \ ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n\ 2017-04-05T10:43:07+00:00" example: '2017-07-12T00:00:00Z' OBScheduledPayment3Basic: type: object additionalProperties: false deprecated: false properties: AccountId: $ref: '#/components/schemas/AccountId' ScheduledPaymentId: $ref: '#/components/schemas/ScheduledPaymentId' ScheduledPaymentDateTime: $ref: '#/components/schemas/ScheduledPaymentDateTime' ScheduledType: $ref: '#/components/schemas/OBInternalScheduleType1Code' Reference: $ref: '#/components/schemas/Reference' DebtorReference: $ref: '#/components/schemas/DebtorReference' InstructedAmount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_1' required: - AccountId - InstructedAmount - ScheduledPaymentDateTime - ScheduledType nullable: false OBActiveOrHistoricCurrencyAndAmount_0: type: object description: The amount of the most recent direct debit collection. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency OBActiveOrHistoricCurrencyAndAmount_1: type: object 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.' properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency OBActiveOrHistoricCurrencyAndAmount_2: type: object description: The amount of the first Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency OBActiveOrHistoricCurrencyAndAmount_3: type: object description: The amount of the next Standing Order. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency OBActiveOrHistoricCurrencyAndAmount_4: type: object description: The amount of the final Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency OBActiveOrHistoricCurrencyAndAmount_5: type: object description: Amount of money associated with the statement benefit type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency OBReadParty3: type: object additionalProperties: false deprecated: false properties: Data: type: object properties: Party: type: array items: $ref: '#/components/schemas/OBParty2' maxItems: 99999 minItems: 0 Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBActiveOrHistoricCurrencyAndAmount_6: type: object description: Amount of money associated with the statement fee type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency OBReadParty2: type: object additionalProperties: false deprecated: false properties: Data: type: object properties: Party: $ref: '#/components/schemas/OBParty2' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBActiveOrHistoricCurrencyAndAmount_7: type: object description: Amount of money associated with the statement interest amount type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency ExternalMandateStatus1Code: type: string description: Specifies the status of the standing order in code form. For a full list of enumeration values refer to 'ExternalMandateStatus1Code' in *ISO_External_Codeset* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - ACTV - CANC - EXPI - SUSP example: ACTV OBActiveOrHistoricCurrencyAndAmount_8: type: object description: Amount of money associated with the amount type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' SubType: $ref: '#/components/schemas/OBExternalBalanceSubType1Code' required: - Amount - Currency OBActiveOrHistoricCurrencyAndAmount_9: type: object description: Amount of money in the cash transaction entry. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency FinalPaymentDateTime: type: string format: date-time description: "The date on which the final payment for a Standing Order schedule will be made. All dates in the JSON\ \ payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" OBUltimateCreditor1: type: object description: Ultimate party to which an amount of money is due. properties: Name: type: string description: Name by which a party is known and which is usually used to identify that party. maxLength: 140 minLength: 1 Identification: type: string description: Identification assigned by an institution. maxLength: 256 minLength: 1 LEI: $ref: '#/components/schemas/LEI' SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' ProprietaryBankTransactionCodeStructure1: type: object additionalProperties: false description: Set of elements to fully identify a proprietary bank transaction code. properties: Code: type: string description: Proprietary bank transaction code to identify the underlying transaction. maxLength: 35 minLength: 1 Issuer: type: string description: Identification of the issuer of the proprietary bank transaction code. maxLength: 35 minLength: 1 required: - Code CreationDateTime: type: string format: date-time description: "Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO\ \ 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" example: '2024-05-29T00:00:00Z' NextPaymentDateTime: type: string format: date-time description: "The date on which the next payment for a Standing Order schedule will be made. All dates in the JSON payloads\ \ are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An\ \ example is below:\n2017-04-05T10:43:07+00:00" example: '2017-07-12T00:00:00Z' OBBranchAndFinancialInstitutionIdentification5_1: type: object description: 'Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.' properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name_1' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' LEI: $ref: '#/components/schemas/LEI' required: - Identification - SchemeName OBScheduledPayment3Detail: type: object additionalProperties: false deprecated: false properties: AccountId: $ref: '#/components/schemas/AccountId' ScheduledPaymentId: $ref: '#/components/schemas/ScheduledPaymentId' ScheduledPaymentDateTime: $ref: '#/components/schemas/ScheduledPaymentDateTime' ScheduledType: $ref: '#/components/schemas/OBInternalScheduleType1Code' 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' required: - AccountId - CreditorAccount - InstructedAmount - ScheduledPaymentDateTime - ScheduledType nullable: false OB_FeeType1Code: type: string description: Fee/Charge Type enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX OBBranchAndFinancialInstitutionIdentification5_0: type: object description: Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name_1' required: - Identification - SchemeName OBExternalPurpose1Code: type: string description: For a full list of enumeration values refer to `ExternalPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - BKDF - BKFE - BKFM - BKIP - BKPP - CBLK - CDCB - CDCD - CDCS - CDDP - CDOC - CDQC - ETUP - FCOL - MTUP - ACCT - CASH - COLL - CSDB - DEPT - INTC - INTP - LIMA - NETT - BFWD - CCIR - CCPC - CCPM - CCSM - CRDS - CRPR - CRSP - CRTL - EQPT - EQUS - EXPT - EXTD - FIXI - FWBC - FWCC - FWSB - FWSC - MARG - MBSB - MBSC - MGCC - MGSC - OCCC - OPBC - OPCC - OPSB - OPSC - OPTN - OTCD - REPO - RPBC - RPCC - RPSB - RPSC - RVPO - SBSC - SCIE - SCIR - SCRP - SHBC - SHCC - SHSL - SLEB - SLOA - SWBC - SWCC - SWPT - SWSB - SWSC - TBAS - TBBC - TBCC - TRCP - AGRT - AREN - BEXP - BOCE - COMC - CPYR - GDDS - GDSV - GSCB - LICF - MP2B - POPE - ROYA - SCVE - SERV - SUBS - SUPP - TRAD - CHAR - COMT - MP2P - ECPG - ECPR - ECPU - EPAY - CLPR - COMP - DBTC - GOVI - HLRP - HLST - INPC - INPR - INSC - INSU - INTE - LBRI - LIFI - LOAN - LOAR - PENO - PPTI - RELG - RINP - TRFD - FORW - FXNT - ADMG - ADVA - BCDM - BCFG - BLDM - BNET - CBFF - CBFR - CCRD - CDBL - CFEE - CGDD - CORT - COST - CPKC - DCRD - DSMT - DVPM - EDUC - FACT - FAND - FCPM - FEES - GIFT - GOVT - ICCP - IDCP - IHRP - INSM - IVPT - MCDM - MCFG - MSVC - NOWS - OCDM - OCFG - OFEE - OTHR - PADD - PTSP - RCKE - RCPT - REBT - REFU - RENT - REOD - RIMB - RPNT - RRBN - RRCT - RRTP - RVPM - SLPI - SPLT - STDY - TBAN - TBIL - TCSC - TELI - TMPG - TPRI - TPRP - TRNC - TRVC - WEBI - IPAY - IPCA - IPDO - IPEA - IPEC - IPEW - IPPS - IPRT - IPU2 - IPUW - ANNI - CAFI - CFDI - CMDT - DERI - DIVD - FREX - HEDG - INVS - PRME - SAVG - SECU - SEPI - TREA - UNIT - FNET - FUTR - ANTS - CVCF - DMEQ - DNTS - HLTC - HLTI - HSPC - ICRF - LTCF - MAFC - MARF - MDCS - VIEW - CDEP - SWFP - SWPP - SWRS - SWUF - ADCS - AEMP - ALLW - ALMY - BBSC - BECH - BENE - BONU - CCHD - COMM - CSLP - GFRP - GVEA - GVEB - GVEC - GVED - GWLT - HREC - PAYR - PEFC - PENS - PRCP - RHBS - SALA - SPSP - SSBE - LBIN - LCOL - LFEE - LMEQ - LMFI - LMRK - LREB - LREV - LSFL - ESTX - FWLV - GSTX - HSTX - INTX - NITX - PTXP - RDTX - TAXS - VATX - WHLD - TAXR - B112 - BR12 - TLRF - TLRR - AIRB - BUSB - FERB - RLWY - TRPT - CBTV - ELEC - ENRG - GASB - NWCH - NWCM - OTLC - PHON - UBIL - WTER - BOND - CABD - CAEQ - CBCR - DBCR - DICL - EQTS - FLCR - EFTC - EFTD - MOMA - RAPI - GAMB - LOTT - AMEX - SASW - AUCO - PCOM - PDEP - PLDS - PLRF - GAFA - GAHO - CPEN - DEPD - RETL - DEBT - CRYP maxLength: 4 minLength: 1 OBStatusReason: type: object properties: StatusReasonCode: type: string description: "Specifies the status reason in a code form. \n For a full description see `OBExternalStatusReason1Code`\ \ [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" example: U004 maxLength: 4 minLength: 1 StatusReasonDescription: type: string description: Description supporting the StatusReasonCode. example: Permissions field is missing maxLength: 500 minLength: 1 Path: type: string description: Recommended but optional reference to JSON path if relevant to the StatusReasonCode. example: Data.Permissions maxLength: 500 minLength: 1 Name_4: type: string description: Long name associated with the code maxLength: 70 minLength: 1 OBInternalLegalStructureType1Code: type: string description: Legal standing of the party. For a full list refer to `OBInternalLegalStructureType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.Individual x-namespaced-enum: - UK.OBIE.CIC - UK.OBIE.CIO - UK.OBIE.Charity - UK.OBIE.CoOp - UK.OBIE.GeneralPartnership - UK.OBIE.Individual - UK.OBIE.LimitedLiabilityPartnership - UK.OBIE.LimitedPartnership - UK.OBIE.PrivateLimitedCompany - UK.OBIE.PublicLimitedCompany - UK.OBIE.ScottishLimitedPartnership - UK.OBIE.Sole OBInternalStatementFeeFrequency1Code: type: string description: How frequently the fee is applied to the Account. For a full list of values see `OBInternalStatementFeeFrequency1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.StatementMonthly x-namespaced-enum: - UK.OBIE.ChargingPeriod - UK.OBIE.PerTransactionAmount - UK.OBIE.PerTransactionPercentage - UK.OBIE.Quarterly - UK.OBIE.StatementMonthly - UK.OBIE.Weekly CareOf: type: string description: The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual. example: Jane Smith maxLength: 140 minLength: 1 Description_2: type: string description: Description that may be available for the statement interest. example: Interest occurred over statement duration maxLength: 128 minLength: 1 OBInternalTransactionMutability1Code: type: string description: 'Specifies the Mutability of the Transaction record.
For a full list of enumeration values refer to `OBInternalTransactionMutability1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' enum: - Mutable - Immutable Description_1: type: string description: Description that may be available for the statement fee. example: International usage charge maxLength: 128 minLength: 1 PostBox: type: string description: Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for. example: PO Box 123456 maxLength: 16 minLength: 1 DateTime: type: string format: date-time description: "Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO\ \ 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" example: '2024-05-29T00:00:00Z' Description_0: type: string description: Specifies the description of the account type. maxLength: 35 minLength: 1 StatusUpdateDateTime: type: string format: date-time description: "Date and time at which the resource status was updated. All dates in the JSON payloads are represented\ \ in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n\ 2017-04-05T10:43:07+00:00" Description_3: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 FullLegalName: type: string description: The full legal name of the party. example: Jane Smith maxLength: 350 minLength: 1 OBActiveCurrencyAndAmount_SimpleType: type: string description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. example: '1209.06' pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ OBBeneficiary5Detail: type: object additionalProperties: false properties: AccountId: $ref: '#/components/schemas/AccountId' BeneficiaryId: $ref: '#/components/schemas/BeneficiaryId' BeneficiaryType: $ref: '#/components/schemas/OBInternalBeneficiaryType1Code' Reference: $ref: '#/components/schemas/Reference' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' CreditorAgent: $ref: '#/components/schemas/OBBranchAndFinancialInstitutionIdentification6_0' CreditorAccount: $ref: '#/components/schemas/OBCashAccount5_0' required: - CreditorAccount OBInternalSwitchStatusCode: type: string description: Specifies the switch status for the account, in a coded form.
For a full list of enumeration values refer to `OBInternalSwitchStatusCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) x-namespaced-enum: - UK.CASS.NotSwitched - UK.CASS.SwitchCompleted Rate: type: string description: Rate associated with the statement rate type. example: '0.224' maxLength: 40 pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ MandateIdentification: type: string 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. maxLength: 35 minLength: 1 OBInternalScheduleType1Code: type: string description: Specifies the scheduled payment date type requested. For a full list of enumeration values refer to `OBInternalScheduleType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - Arrival - Execution example: Arrival OBInternalStatementInterestRateType1Code: type: string description: This code specifies the type of interest (e.g., BOE Base Rate, Fixed Rate, Gross). example: UK.OBIE.FixedRate x-namespaced-enum: - UK.OBIE.BOEBaseRate - UK.OBIE.FixedRate - UK.OBIE.Gross - UK.OBIE.LoanProviderBaseRate - UK.OBIE.Net OBInternalStatementRateType1Code: type: string description: Statement rate type, in a coded form. For a full list of values see `OBInternalStatementRateType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.AnnualCash x-namespaced-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 EmailAddress: type: string description: Address for electronic mail (e-mail). example: d.user@semiotec.co.jp maxLength: 256 minLength: 1 OBBCAData1: type: object additionalProperties: false properties: ProductDetails: type: object additionalProperties: false properties: Segment: type: array description: "Market segmentation is a marketing term referring to the aggregating of prospective buyers into\ \ groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation\ \ enables companies to target different categories of consumers who perceive the full value of certain products\ \ and services differently from one another.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd\ \ \nWith respect to BCA products, they are segmented in relation to different markets that they wish to focus\ \ on. " items: type: string description: "Market segmentation is a marketing term referring to the aggregating of prospective buyers into\ \ groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation\ \ enables companies to target different categories of consumers who perceive the full value of certain products\ \ and services differently from one another.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd\ \ \nWith respect to BCA products, they are segmented in relation to different markets that they wish to\ \ focus on. " enum: - ClientAccount - Standard - NonCommercialChaitiesClbSoc - NonCommercialPublicAuthGovt - Religious - SectorSpecific - Startup - Switcher maxItems: 99999 minItems: 0 title: Segment FeeFreeLength: type: number format: float description: The length/duration of the fee free period title: FeeFreeLength FeeFreeLengthPeriod: type: string description: The unit of period (days, weeks, months etc.) of the promotional length enum: - Day - Half Year - Month - Quarter - Week - Year title: FeeFreeLengthPeriod Notes: type: array description: Optional additional notes to supplement the Core product details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes title: ProductDetails CreditInterest: type: object additionalProperties: false description: Details about the interest that may be payable to the BCA account holders properties: TierBandSet: type: array description: The group of tiers or bands for which credit interest can be applied. items: type: object description: The group of tiers or bands for which credit interest can be applied. properties: TierBandMethod: type: string 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' enum: - Banded - Tiered - Whole title: TierBandMethod CalculationMethod: type: string description: Methods of calculating interest enum: - Compound - SimpleInterest title: CalculationMethod Destination: type: string description: Describes whether accrued interest is payable only to the BCA or to another bank account enum: - PayAway - SelfCredit title: Destination Notes: type: array description: Optional additional notes to supplement the Tier Band Set details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes TierBand: type: array description: Tier Band Details items: type: object description: Tier Band Details properties: Identification: type: string description: Unique and unambiguous identification of a Tier Band for a BCA. maxLength: 35 minLength: 1 title: Identification TierValueMinimum: type: string description: Minimum deposit value for which the credit interest tier applies. pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: TierValueMinimum TierValueMaximum: type: string description: Maximum deposit value for which the credit interest tier applies. pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: TierValueMaximum CalculationFrequency: type: string description: How often is credit interest calculated for the account. enum: - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly title: CalculationFrequency ApplicationFrequency: type: string 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. enum: - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly title: ApplicationFrequency DepositInterestAppliedCoverage: type: string description: Amount on which Interest applied. enum: - Banded - Tiered - Whole title: DepositInterestAppliedCoverage FixedVariableInterestRateType: type: string description: Type of interest rate, Fixed or Variable enum: - Fixed - Variable title: FixedVariableInterestRateType AER: type: string description: "The annual equivalent rate (AER) is interest that is calculated under the assumption\ \ that any interest paid is combined with the original balance and the next interest payment will\ \ be based on the slightly higher account balance. Overall, this means that interest can be compounded\ \ several times in a year depending on the number of times that interest payments are made. \n\ Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A" pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: AER BankInterestRateType: type: string description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA. enum: - Gross - Other title: BankInterestRateType BankInterestRate: type: string description: Bank Interest for the BCA product pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: BankInterestRate Notes: type: array description: Optional additional notes to supplement the Tier Band details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherBankInterestType: type: object additionalProperties: false description: Other interest rate types which are not available in the standard code list properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherBankInterestType OtherApplicationFrequency: type: object additionalProperties: false description: Other application frequencies that are not available in the standard code list properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherApplicationFrequency OtherCalculationFrequency: type: object additionalProperties: false description: Other calculation frequency which is not available in the standard code set. properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherCalculationFrequency required: - AER - ApplicationFrequency - FixedVariableInterestRateType - TierValueMinimum maxItems: 99999 minItems: 1 title: TierBand required: - Destination - TierBand - TierBandMethod maxItems: 99999 minItems: 1 title: TierBandSet required: - TierBandSet title: CreditInterest Overdraft: type: object additionalProperties: false description: Borrowing details properties: Notes: type: array description: Associated Notes about the overdraft rates items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OverdraftTierBandSet: type: array description: Tier band set details items: type: object description: Tier band set details properties: TierBandMethod: type: string description: "The methodology of how overdraft is charged. It can be:\n'Whole' Where the same charge/rate\ \ is applied to the entirety of the overdraft balance (where charges are applicable). \n'Tiered' Where\ \ different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers\ \ defined by the lending financial organisation\n'Banded' Where different charges/rates are applied\ \ dependent on overdraft maximum and minimum balance amount bands defined by a government organisation." enum: - Banded - Tiered - Whole title: TierBandMethod OverdraftType: type: string 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. enum: - Committed - OnDemand title: OverdraftType Identification: type: string description: Unique and unambiguous identification of a Tier Band for a overdraft product. maxLength: 35 minLength: 1 title: Identification AuthorisedIndicator: type: boolean description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) title: AuthorisedIndicator BufferAmount: type: string 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.' pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: BufferAmount Notes: type: array description: Optional additional notes to supplement the overdraft Tier Band Set details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OverdraftTierBand: type: array description: Provides overdraft details for a specific tier or band items: type: object description: Provides overdraft details for a specific tier or band properties: Identification: type: string description: Unique and unambiguous identification of a Tier Band for a overdraft. maxLength: 35 minLength: 1 title: Identification TierValueMin: type: string description: Minimum value of Overdraft Tier/Band pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: TierValueMin TierValueMax: type: string description: Maximum value of Overdraft Tier/Band pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: TierValueMax EAR: type: string description: 'EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.' pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: EAR RepresentativeAPR: type: string 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. pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: RepresentativeAPR AgreementLengthMin: type: number format: float description: Specifies the minimum length of a band for a fixed overdraft agreement title: AgreementLengthMin AgreementLengthMax: type: number format: float description: Specifies the maximum length of a band for a fixed overdraft agreement title: AgreementLengthMax AgreementPeriod: type: string description: Specifies the period of a fixed length overdraft agreement enum: - Day - Half Year - Month - Quarter - Week - Year title: AgreementPeriod OverdraftInterestChargingCoverage: type: string 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’. enum: - Banded - Tiered - Whole title: OverdraftInterestChargingCoverage BankGuaranteedIndicator: type: boolean description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. title: BankGuaranteedIndicator Notes: type: array description: Optional additional notes to supplement the Tier/band details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OverdraftFeesCharges: type: array description: Overdraft fees and charges items: type: object description: Overdraft fees and charges properties: OverdraftFeeChargeCap: type: array 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. items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Overdraft fee type enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans maxItems: 99999 minItems: 1 title: FeeType MinMaxType: type: string description: Min Max type enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Notes related to Overdraft fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 title: OverdraftFeeChargeCap OverdraftFeeChargeDetail: type: array description: Details about the fees/charges items: type: object description: Details about the fees/charges properties: FeeType: type: string description: Overdraft fee type enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans title: FeeType NegotiableIndicator: type: boolean description: Indicates whether fee and charges are negotiable title: NegotiableIndicator OverdraftControlIndicator: type: boolean description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. title: OverdraftControlIndicator IncrementalBorrowingAmount: type: string description: Every additional tranche of an overdraft balance to which an overdraft fee is applied pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: IncrementalBorrowingAmount FeeAmount: type: string description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeAmount FeeRate: type: string description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: FeeRate FeeRateType: type: string description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) enum: - Gross - Other title: FeeRateType ApplicationFrequency: type: string description: Frequency at which the overdraft charge is applied to the account enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: ApplicationFrequency CalculationFrequency: type: string description: How often is the overdraft fee/charge calculated for the account. enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: CalculationFrequency Notes: type: array description: Free text for capturing any other info related to Overdraft Fees Charge Details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OverdraftFeeChargeCap: type: array 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. items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Overdraft fee type enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans maxItems: 99999 minItems: 1 title: FeeType MinMaxType: type: string description: Min Max type enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Notes related to Overdraft fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 title: OverdraftFeeChargeCap OtherFeeType: type: object additionalProperties: false description: Other Fee type which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeType OtherFeeRateType: type: object additionalProperties: false description: Other fee rate type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeRateType OtherApplicationFrequency: type: object additionalProperties: false description: Other application frequencies that are not available in the standard code list properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherApplicationFrequency OtherCalculationFrequency: type: object additionalProperties: false description: Other calculation frequency which is not available in the standard code set. properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherCalculationFrequency required: - ApplicationFrequency - FeeType maxItems: 99999 minItems: 1 title: OverdraftFeeChargeDetail required: - OverdraftFeeChargeDetail maxItems: 99999 minItems: 0 title: OverdraftFeesCharges required: - TierValueMin maxItems: 99999 minItems: 1 title: OverdraftTierBand OverdraftFeesCharges: type: array description: Overdraft fees and charges details items: type: object description: Overdraft fees and charges details properties: OverdraftFeeChargeCap: type: array 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. items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Overdraft fee type enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans maxItems: 99999 minItems: 1 title: FeeType MinMaxType: type: string description: Min Max type enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Notes related to Overdraft fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 title: OverdraftFeeChargeCap OverdraftFeeChargeDetail: type: array description: Details about the fees/charges items: type: object description: Details about the fees/charges properties: FeeType: type: string description: Overdraft fee type enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans title: FeeType NegotiableIndicator: type: boolean description: Indicates whether fee and charges are negotiable title: NegotiableIndicator OverdraftControlIndicator: type: boolean description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. title: OverdraftControlIndicator IncrementalBorrowingAmount: type: string description: Every additional tranche of an overdraft balance to which an overdraft fee is applied pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: IncrementalBorrowingAmount FeeAmount: type: string description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeAmount FeeRate: type: string description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: FeeRate FeeRateType: type: string description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) enum: - Gross - Other title: FeeRateType ApplicationFrequency: type: string description: Frequency at which the overdraft charge is applied to the account enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: ApplicationFrequency CalculationFrequency: type: string description: How often is the overdraft fee/charge calculated for the account. enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: CalculationFrequency Notes: type: array description: Free text for capturing any other info related to Overdraft Fees Charge Details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OverdraftFeeChargeCap: type: array 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. items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Overdraft fee type enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans maxItems: 99999 minItems: 1 title: FeeType MinMaxType: type: string description: Min Max type enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Notes related to Overdraft fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 title: OverdraftFeeChargeCap OtherFeeType: type: object additionalProperties: false description: Other Fee type which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeType OtherFeeRateType: type: object additionalProperties: false description: Other fee rate type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeRateType OtherApplicationFrequency: type: object additionalProperties: false description: Other application frequencies that are not available in the standard code list properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherApplicationFrequency OtherCalculationFrequency: type: object additionalProperties: false description: Other calculation frequency which is not available in the standard code set. properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherCalculationFrequency required: - ApplicationFrequency - FeeType maxItems: 99999 minItems: 1 title: OverdraftFeeChargeDetail required: - OverdraftFeeChargeDetail maxItems: 99999 minItems: 0 title: OverdraftFeesCharges required: - OverdraftTierBand - TierBandMethod maxItems: 99999 minItems: 1 title: OverdraftTierBandSet required: - OverdraftTierBandSet title: Overdraft OtherFeesCharges: type: array description: Contains details of fees and charges which are not associated with either Overdraft or features/benefits items: type: object description: Contains details of fees and charges which are not associated with either Overdraft or features/benefits properties: TariffType: type: string description: TariffType which defines the fee and charges. enum: - Electronic - Mixed - Other title: TariffType TariffName: type: string description: Name of the tariff maxLength: 350 minLength: 1 title: TariffName OtherTariffType: type: object additionalProperties: false description: Other tariff type which is not in the standard list. properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherTariffType FeeChargeDetail: type: array description: Other fees/charges details items: type: object description: Other fees/charges details properties: FeeCategory: type: string description: Categorisation of fees and charges into standard categories. enum: - Other - Servicing title: FeeCategory FeeType: type: string description: Fee/Charge Type enum: - Other - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCAccountFeeQuarterly - ServiceCFixedTariff - ServiceCBusiDepAccBreakage - ServiceCMinimumMonthlyFee - ServiceCOther title: FeeType NegotiableIndicator: type: boolean description: Fee/charge which is usually negotiable rather than a fixed amount title: NegotiableIndicator FeeAmount: type: string description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeAmount FeeRate: type: string description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: FeeRate FeeRateType: type: string description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) enum: - Gross - Other title: FeeRateType ApplicationFrequency: type: string description: How frequently the fee/charge is applied to the account enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: ApplicationFrequency CalculationFrequency: type: string description: How frequently the fee/charge is calculated enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: CalculationFrequency Notes: type: array description: Optional additional notes to supplement the fee/charge details. items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 title: Notes FeeChargeCap: type: array description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge items: type: object description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Fee/charge type which is being capped enum: - Other - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCAccountFeeQuarterly - ServiceCFixedTariff - ServiceCBusiDepAccBreakage - ServiceCMinimumMonthlyFee - ServiceCOther maxItems: 99999 minItems: 1 title: FeeType MinMaxType: type: string description: Min Max type enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Free text for adding extra details for fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 title: FeeChargeCap OtherFeeCategoryType: type: object additionalProperties: false properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeCategoryType OtherFeeType: type: object additionalProperties: false description: Other Fee/charge type which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code FeeCategory: type: string description: Categorisation of fees and charges into standard categories. enum: - Other - Servicing title: FeeCategory Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - FeeCategory - Name title: OtherFeeType OtherFeeRateType: type: object additionalProperties: false description: Other fee rate type which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeRateType OtherApplicationFrequency: type: object additionalProperties: false description: Other application frequencies not covered in the standard code list properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherApplicationFrequency OtherCalculationFrequency: type: object additionalProperties: false description: Other calculation frequency which is not available in standard code set. properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherCalculationFrequency FeeApplicableRange: type: object additionalProperties: false description: Range or amounts or rates for which the fee/charge applies properties: MinimumAmount: type: string description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: MinimumAmount MaximumAmount: type: string description: Maximum Amount on which fee is applicable (where it is expressed as an amount) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: MaximumAmount MinimumRate: type: string description: Minimum rate on which fee/charge is applicable(where it is expressed as a rate) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: MinimumRate MaximumRate: type: string description: Maximum rate on which fee/charge is applicable(where it is expressed as a rate) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: MaximumRate title: FeeApplicableRange required: - ApplicationFrequency - FeeCategory - FeeType maxItems: 99999 minItems: 1 title: FeeChargeDetail FeeChargeCap: type: array description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge items: type: object description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Fee/charge type which is being capped enum: - Other - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCAccountFeeQuarterly - ServiceCFixedTariff - ServiceCBusiDepAccBreakage - ServiceCMinimumMonthlyFee - ServiceCOther maxItems: 99999 minItems: 1 title: FeeType MinMaxType: type: string description: Min Max type enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Free text for adding extra details for fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 title: FeeChargeCap required: - FeeChargeDetail maxItems: 99999 minItems: 0 title: OtherFeesCharges title: BCA StatementId: type: string description: Unique identifier for the statement resource within a servicing institution. This identifier is both unique and immutable. example: 8sfhke-sifhkeuf-97813 maxLength: 40 minLength: 1 Identification_3: type: string description: Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor example: '80200112344562' maxLength: 256 minLength: 1 Identification_4: type: string description: Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor. example: '80200112344562' maxLength: 256 minLength: 1 Identification_1: type: string description: Unique and unambiguous identification of the servicing institution. example: '80200112344562' maxLength: 35 minLength: 1 Identification_2: type: string description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. maxLength: 35 minLength: 1 UnitNumber: type: string description: Number that identifies the unit of a specific address . example: A88 maxLength: 16 minLength: 1 FirstPaymentDateTime: type: string format: date-time description: "The date on which the first payment for a Standing Order schedule will be made. All dates in the JSON\ \ payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" Name_3: type: string description: Name by which a party is known and which is usually used to identify that party. example: Mx Jane Smith maxLength: 350 minLength: 1 Name_2: type: string description: Name of Service User. maxLength: 70 minLength: 1 Name_1: type: string description: Name by which an agent is known and which is usually used to identify that agent. example: Agent Name maxLength: 140 minLength: 1 Name_0: type: string description: 'The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP''s online channels. Note, the account name is not the product name or the nickname of the account.' example: Jane Smith maxLength: 350 minLength: 1 OBPartyRelationships1: type: object description: The Party's relationships with other resources. properties: Account: type: object description: Relationship to the Account resource. properties: Related: type: string format: uri description: Absolute URI to the related resource. example: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/89019 Id: type: string description: Unique identification as assigned by the ASPSP to uniquely identify the related resource. example: '89019' maxLength: 40 minLength: 1 required: - Id - Related OB_FeeFrequency1Code_1: type: string description: How often is the overdraft fee/charge calculated for the account. enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE Identification_0: type: string description: Identification assigned by an institution to identify an account. This identification is known by the account owner. example: '80200112344562' maxLength: 256 minLength: 1 OB_FeeFrequency1Code_2: type: string description: How frequently the fee/charge is applied to the account enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE OBInternalFinancialInstitutionIdentification4Code: type: string description: Name of the identification scheme, in a coded form as published in an external list.
For a full list of enumeration values refer to `OBInternalFinancialInstitutionIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.BICFI x-namespaced-enum: - UK.OBIE.BICFI OB_FeeFrequency1Code_0: type: string description: Frequency at which the overdraft charge is applied to the account enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE OBPCAData1: type: object additionalProperties: false properties: ProductDetails: type: object additionalProperties: false properties: Segment: type: array description: "Market segmentation is a marketing term referring to the aggregating of prospective buyers into\ \ groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation\ \ enables companies to target different categories of consumers who perceive the full value of certain products\ \ and services differently from one another.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd\ \ \nWith respect to PCA products, they are segmented in relation to different markets that they wish to focus\ \ on. " items: type: string description: "Market segmentation is a marketing term referring to the aggregating of prospective buyers into\ \ groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation\ \ enables companies to target different categories of consumers who perceive the full value of certain products\ \ and services differently from one another.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd\ \ \nWith respect to PCA products, they are segmented in relation to different markets that they wish to\ \ focus on. " enum: - Basic - BenefitAndReward - CreditInterest - Cashback - General - Graduate - Other - Overdraft - Packaged - Premium - Reward - Student - YoungAdult - Youth maxItems: 99999 minItems: 0 title: Segment MonthlyMaximumCharge: type: string description: The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: MonthlyMaximumCharge Notes: type: array description: Optional additional notes to supplement the Core product details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes title: ProductDetails CreditInterest: type: object additionalProperties: false description: Details about the interest that may be payable to the PCA account holders properties: TierBandSet: type: array description: The group of tiers or bands for which credit interest can be applied. items: type: object description: The group of tiers or bands for which credit interest can be applied. properties: TierBandMethod: type: string 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' enum: - Tiered - Whole title: TierBandMethod CalculationMethod: type: string description: Methods of calculating interest enum: - Compound - SimpleInterest title: CalculationMethod Destination: type: string description: Describes whether accrued interest is payable only to the PCA or to another bank account enum: - PayAway - SelfCredit title: Destination Notes: type: array description: Optional additional notes to supplement the Tier Band Set details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes TierBand: type: array description: Tier Band Details items: type: object description: Tier Band Details properties: Identification: type: string description: Unique and unambiguous identification of a Tier Band for a PCA. maxLength: 35 minLength: 1 title: Identification TierValueMinimum: type: string description: Minimum deposit value for which the credit interest tier applies. pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: TierValueMinimum TierValueMaximum: type: string description: Maximum deposit value for which the credit interest tier applies. pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: TierValueMaximum CalculationFrequency: type: string description: How often is credit interest calculated for the account. enum: - PerAcademicTerm - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly title: CalculationFrequency ApplicationFrequency: type: string 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. enum: - PerAcademicTerm - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly title: ApplicationFrequency DepositInterestAppliedCoverage: type: string description: Amount on which Interest applied. enum: - Tiered - Whole title: DepositInterestAppliedCoverage FixedVariableInterestRateType: type: string description: Type of interest rate, Fixed or Variable enum: - Fixed - Variable title: FixedVariableInterestRateType AER: type: string description: "The annual equivalent rate (AER) is interest that is calculated under the assumption\ \ that any interest paid is combined with the original balance and the next interest payment will\ \ be based on the slightly higher account balance. Overall, this means that interest can be compounded\ \ several times in a year depending on the number of times that interest payments are made. \n\ Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A" pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: AER BankInterestRateType: type: string description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA. enum: - LinkedBaseRate - Gross - Net - Other title: BankInterestRateType BankInterestRate: type: string description: Bank Interest for the PCA product pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: BankInterestRate Notes: type: array description: Optional additional notes to supplement the Tier Band details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherBankInterestType: type: object additionalProperties: false description: Other interest rate types which are not available in the standard code list properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherBankInterestType OtherApplicationFrequency: type: object additionalProperties: false description: Other application frequencies that are not available in the standard code list properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherApplicationFrequency OtherCalculationFrequency: type: object additionalProperties: false description: Other calculation frequency which is not available in the standard code set. properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherCalculationFrequency required: - AER - ApplicationFrequency - FixedVariableInterestRateType - TierValueMinimum maxItems: 99999 minItems: 1 title: TierBand required: - TierBand - TierBandMethod maxItems: 99999 minItems: 1 title: TierBandSet required: - TierBandSet title: CreditInterest Overdraft: type: object additionalProperties: false description: Details about Overdraft rates, fees & charges properties: Notes: type: array description: Associated Notes about the overdraft rates items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OverdraftTierBandSet: type: array description: Tier band set details items: type: object description: Tier band set details properties: TierBandMethod: type: string description: "The methodology of how overdraft is charged. It can be:\n'Whole' Where the same charge/rate\ \ is applied to the entirety of the overdraft balance (where charges are applicable). \n'Tiered' Where\ \ different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers\ \ defined by the lending financial organisation\n'Banded' Where different charges/rates are applied\ \ dependent on overdraft maximum and minimum balance amount bands defined by a government organisation." enum: - Tiered - Whole - Banded title: TierBandMethod OverdraftType: type: string 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. enum: - Committed - OnDemand - Other title: OverdraftType Identification: type: string description: Unique and unambiguous identification of a Tier Band for a overdraft product. maxLength: 35 minLength: 1 title: Identification AuthorisedIndicator: type: boolean description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) title: AuthorisedIndicator BufferAmount: type: string 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.' pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: BufferAmount Notes: type: array description: Optional additional notes to supplement the overdraft Tier Band Set details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OverdraftTierBand: type: array description: Provides overdraft details for a specific tier or band items: type: object description: Provides overdraft details for a specific tier or band properties: Identification: type: string description: Unique and unambiguous identification of a Tier Band for a overdraft. maxLength: 35 minLength: 1 title: Identification TierValueMin: type: string description: Minimum value of Overdraft Tier/Band pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: TierValueMin TierValueMax: type: string description: Maximum value of Overdraft Tier/Band pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: TierValueMax OverdraftInterestChargingCoverage: type: string description: Interest charged on whole amount or tiered/banded enum: - Tiered - Whole title: OverdraftInterestChargingCoverage BankGuaranteedIndicator: type: boolean description: Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically title: BankGuaranteedIndicator EAR: type: string description: 'EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.' pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: EAR RepresentativeAPR: type: string 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. pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: RepresentativeAPR Notes: type: array description: Optional additional notes to supplement the Tier/band details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OverdraftFeesCharges: type: array description: Overdraft fees and charges items: type: object description: Overdraft fees and charges properties: OverdraftFeeChargeCap: type: array description: Details about any caps (maximum charges) that apply to a particular fee/charge items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Overdraft fee type enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans maxItems: 99999 minItems: 1 title: FeeType OverdraftControlIndicator: type: boolean description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator MinMaxType: type: string description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Notes related to Overdraft fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 title: OverdraftFeeChargeCap OverdraftFeeChargeDetail: type: array description: Details about the fees/charges items: type: object description: Details about the fees/charges properties: FeeType: type: string description: Overdraft fee type enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans title: FeeType OverdraftControlIndicator: type: boolean description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator IncrementalBorrowingAmount: type: string description: Every additional tranche of an overdraft balance to which an overdraft fee is applied pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: IncrementalBorrowingAmount FeeAmount: type: string description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeAmount FeeRate: type: string description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: FeeRate FeeRateType: type: string description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) enum: - LinkedBaseRate - Gross - Net - Other title: FeeRateType ApplicationFrequency: type: string description: Frequency at which the overdraft charge is applied to the account enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: ApplicationFrequency CalculationFrequency: type: string description: How often is the overdraft fee/charge calculated for the account. enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: CalculationFrequency Notes: type: array description: Free text for capturing any other info related to Overdraft Fees Charge Details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: object additionalProperties: false description: Other Fee type which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeType OtherFeeRateType: type: object additionalProperties: false description: Other fee rate type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeRateType OtherApplicationFrequency: type: object additionalProperties: false description: Other application frequencies that are not available in the standard code list properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherApplicationFrequency OtherCalculationFrequency: type: object additionalProperties: false description: Other calculation frequency which is not available in the standard code set. properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherCalculationFrequency OverdraftFeeChargeCap: type: object additionalProperties: false description: Details about any caps (maximum charges) that apply to a particular fee/charge properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Overdraft fee type enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans maxItems: 99999 minItems: 1 title: FeeType OverdraftControlIndicator: type: boolean description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator MinMaxType: type: string description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Notes related to Overdraft fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType title: OverdraftFeeChargeCap required: - ApplicationFrequency - FeeType maxItems: 99999 minItems: 1 title: OverdraftFeeChargeDetail required: - OverdraftFeeChargeDetail maxItems: 99999 minItems: 0 title: OverdraftFeesCharges required: - TierValueMin maxItems: 99999 minItems: 1 title: OverdraftTierBand OverdraftFeesCharges: type: array description: Overdraft fees and charges details items: type: object description: Overdraft fees and charges details properties: OverdraftFeeChargeCap: type: array description: Details about any caps (maximum charges) that apply to a particular fee/charge items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Overdraft fee type enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans maxItems: 99999 minItems: 1 title: FeeType OverdraftControlIndicator: type: boolean description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator MinMaxType: type: string description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Notes related to Overdraft fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 title: OverdraftFeeChargeCap OverdraftFeeChargeDetail: type: array description: Details about the fees/charges items: type: object description: Details about the fees/charges properties: FeeType: type: string description: Overdraft fee type enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans title: FeeType OverdraftControlIndicator: type: boolean description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator IncrementalBorrowingAmount: type: string description: Every additional tranche of an overdraft balance to which an overdraft fee is applied pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: IncrementalBorrowingAmount FeeAmount: type: string description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeAmount FeeRate: type: string description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: FeeRate FeeRateType: type: string description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) enum: - LinkedBaseRate - Gross - Net - Other title: FeeRateType ApplicationFrequency: type: string description: Frequency at which the overdraft charge is applied to the account enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: ApplicationFrequency CalculationFrequency: type: string description: How often is the overdraft fee/charge calculated for the account. enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: CalculationFrequency Notes: type: array description: Free text for capturing any other info related to Overdraft Fees Charge Details items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: object additionalProperties: false description: Other Fee type which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeType OtherFeeRateType: type: object additionalProperties: false description: Other fee rate type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeRateType OtherApplicationFrequency: type: object additionalProperties: false description: Other application frequencies that are not available in the standard code list properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherApplicationFrequency OtherCalculationFrequency: type: object additionalProperties: false description: Other calculation frequency which is not available in the standard code set. properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherCalculationFrequency OverdraftFeeChargeCap: type: object additionalProperties: false description: Details about any caps (maximum charges) that apply to a particular fee/charge properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Overdraft fee type enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans maxItems: 99999 minItems: 1 title: FeeType OverdraftControlIndicator: type: boolean description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator MinMaxType: type: string description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Notes related to Overdraft fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType title: OverdraftFeeChargeCap required: - ApplicationFrequency - FeeType maxItems: 99999 minItems: 1 title: OverdraftFeeChargeDetail required: - OverdraftFeeChargeDetail maxItems: 99999 minItems: 0 title: OverdraftFeesCharges required: - OverdraftTierBand - TierBandMethod maxItems: 99999 minItems: 1 title: OverdraftTierBandSet required: - OverdraftTierBandSet title: Overdraft OtherFeesCharges: type: object additionalProperties: false description: Contains details of fees and charges which are not associated with either borrowing or features/benefits properties: FeeChargeDetail: type: array description: Other fees/charges details items: type: object description: Other fees/charges details properties: FeeCategory: type: string description: Categorisation of fees and charges into standard categories. enum: - Other - Servicing title: FeeCategory FeeType: type: string description: Fee/Charge Type enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other title: FeeType FeeAmount: type: string description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeAmount FeeRate: type: string description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: FeeRate FeeRateType: type: string description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) enum: - LinkedBaseRate - Gross - Net - Other title: FeeRateType ApplicationFrequency: type: string description: How frequently the fee/charge is applied to the account enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: ApplicationFrequency CalculationFrequency: type: string description: How frequently the fee/charge is calculated enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly title: CalculationFrequency Notes: type: array description: Optional additional notes to supplement the fee/charge details. items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeCategoryType: type: object additionalProperties: false properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeCategoryType OtherFeeType: type: object additionalProperties: false description: Other Fee/charge type which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code FeeCategory: type: string description: Categorisation of fees and charges into standard categories. enum: - Other - Servicing title: FeeCategory Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - FeeCategory - Name title: OtherFeeType OtherFeeRateType: type: object additionalProperties: false description: Other fee rate type which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherFeeRateType OtherApplicationFrequency: type: object additionalProperties: false description: Other application frequencies not covered in the standard code list properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherApplicationFrequency OtherCalculationFrequency: type: object additionalProperties: false description: Other calculation frequency which is not available in standard code set. properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name title: OtherCalculationFrequency FeeChargeCap: type: array description: Details about any caps (maximum charges) that apply to a particular fee/charge items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Fee/charge type which is being capped enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other maxItems: 99999 minItems: 1 title: FeeType MinMaxType: type: string description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Free text for adding extra details for fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 title: FeeChargeCap FeeApplicableRange: type: object additionalProperties: false description: Range or amounts or rates for which the fee/charge applies properties: MinimumAmount: type: string description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: MinimumAmount MaximumAmount: type: string description: Maximum Amount on which fee is applicable (where it is expressed as an amount) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: MaximumAmount MinimumRate: type: string description: Minimum rate on which fee/charge is applicable(where it is expressed as a rate) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: MinimumRate MaximumRate: type: string description: Maximum rate on which fee/charge is applicable(where it is expressed as a rate) pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ title: MaximumRate title: FeeApplicableRange required: - ApplicationFrequency - FeeCategory - FeeType maxItems: 99999 minItems: 1 title: FeeChargeDetail FeeChargeCap: type: array description: Details about any caps (maximum charges) that apply to a particular fee/charge items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge properties: FeeType: type: array description: Fee/charge type which is being capped items: type: string description: Fee/charge type which is being capped enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other maxItems: 99999 minItems: 1 title: FeeType MinMaxType: type: string description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution enum: - Minimum - Maximum title: MinMaxType FeeCapOccurrence: type: number format: float description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence FeeCapAmount: type: string description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ title: FeeCapAmount CappingPeriod: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year title: CappingPeriod Notes: type: array description: Free text for adding extra details for fee charge cap items: type: string description: maxLength 2000 text maxLength: 2000 minLength: 1 maxItems: 99999 minItems: 0 title: Notes OtherFeeType: type: array description: Other fee type code which is not available in the standard code set items: type: object description: Other fee type code which is not available in the standard code set properties: Code: type: string description: The four letter Mnemonic used within an XML file to identify a code maxLength: 4 minLength: 0 pattern: ^\w{0,4}$ title: Code Name: type: string description: Long name associated with the code maxLength: 70 minLength: 1 title: Name Description: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 title: Description required: - Description - Name maxItems: 99999 minItems: 0 title: OtherFeeType required: - FeeType - MinMaxType maxItems: 99999 minItems: 0 title: FeeChargeCap required: - FeeChargeDetail title: OtherFeesCharges title: PCA OBRisk2: type: object additionalProperties: false deprecated: false 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.' nullable: false OBTransactionCardInstrument1: type: object additionalProperties: false deprecated: false description: 'Set of elements to describe the card instrument used in the transaction.
For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' properties: CardSchemeName: type: string description: 'Name of the card scheme.
For a full list of enumeration values refer to `OBInternalCardSchemeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' enum: - AmericanExpress - Diners - Discover - MasterCard - VISA AuthorisationType: type: string description: 'The card authorisation type.
For a full list of enumeration values refer to `OBInternalCardAuthorisationType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' enum: - ConsumerDevice - Contactless - None - PIN Name: type: string description: Name of the cardholder using the card instrument. maxLength: 70 minLength: 1 Identification: type: string 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. maxLength: 34 minLength: 1 required: - CardSchemeName nullable: false OBCreditDebitCode_0: type: string description: 'Indicates whether the amount is a credit or a debit. For a full list of values see `OBInternalCreditDebitCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
Usage: A zero amount is considered to be a credit amount.' enum: - Credit - Debit example: Credit OB_FeeFrequency1Code_3: type: string description: How frequently the fee/charge is calculated enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE OBCreditDebitCode_1: type: string description: 'Indicates whether the transaction is a credit or a debit entry.

For a full list of enumeration values refer to `OBInternalCreditDebitCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' enum: - Credit - Debit OB_FeeFrequency1Code_4: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE OBExternalMandateClassification1Code: type: string description: Type of mandate instruction. For a full list of values see `OBExternalClassification1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - FIXE - USGB - VARI example: FIXE OpeningDate: type: string format: date-time 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. \nAll date-time fields in responses\ \ must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" OBCreditDebitCode_2: type: string description: "Indicates whether the balance is a credit or a debit balance. \nUsage: A zero balance is considered to\ \ be a credit balance.\n
\nFor a full list of enumeration values refer to `OBInternalCreditDebitCode` in *OB_Internal_CodeSet*\ \ [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" enum: - Credit - Debit example: Credit Reference: type: string 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.' example: Towbar Club maxLength: 35 minLength: 1 OBRemittanceInformationStructured: type: object properties: ReferredDocumentInformation: type: array items: $ref: '#/components/schemas/OBReferredDocumentInformation' maxItems: 99999 minItems: 0 ReferredDocumentAmount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' CreditorReferenceInformation: type: object description: Reference information provided by the creditor to allow the identification of the underlying documents. properties: Code: $ref: '#/components/schemas/ExternalCreditorReferenceType1Code' Issuer: type: string description: Entity that assigns the identification. maxLength: 35 minLength: 1 Reference: type: string description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. maxLength: 35 minLength: 1 Invoicer: $ref: '#/components/schemas/Identification_3' Invoicee: $ref: '#/components/schemas/Identification_4' TaxRemittance: type: string description: Provides remittance information about a payment made for tax-related purposes. maxLength: 140 minLength: 1 AdditionalRemittanceInformation: type: array description: Additional information, in free text form, to complement the structured remittance information. items: type: string maxLength: 140 minLength: 1 maxItems: 3 minItems: 0 PartyId: type: string description: A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner. example: PXSIF023 maxLength: 40 minLength: 1 Model: type: object properties: id: type: integer format: int64 example: 1 maximum: 9999999 minimum: 0 OBExternalStatusReason1Code: type: string description: Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: U001 maxLength: 4 minLength: 4 OBReadStatement2: type: object additionalProperties: false deprecated: false properties: Data: $ref: '#/components/schemas/OBReadDataStatement2' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBStatement2Basic: type: object additionalProperties: false deprecated: false description: Provides further details on a statement resource. properties: AccountId: $ref: '#/components/schemas/AccountId' StatementId: $ref: '#/components/schemas/StatementId' StatementReference: $ref: '#/components/schemas/StatementReference' Type: $ref: '#/components/schemas/OBInternalStatementType1Code' StartDateTime: $ref: '#/components/schemas/StartDateTime' EndDateTime: $ref: '#/components/schemas/EndDateTime' CreationDateTime: $ref: '#/components/schemas/CreationDateTime' StatementDescription: type: array items: type: string description: Other descriptions that may be available for the statement resource. maxLength: 500 minLength: 1 maxItems: 99999 minItems: 0 StatementBenefit: type: array items: type: object description: Set of elements used to provide details of a benefit or reward amount for the statement resource. properties: Type: $ref: '#/components/schemas/OBInternalStatementBenefitType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_5' required: - Amount - Type maxItems: 99999 minItems: 0 StatementFee: type: array items: type: object description: Set of elements used to provide details of a fee for the statement resource. properties: Description: $ref: '#/components/schemas/Description_1' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementFeeType1Code' Rate: $ref: '#/components/schemas/OBRate1_0' RateType: $ref: '#/components/schemas/OBInternalStatementFeeRateType1Code' Frequency: $ref: '#/components/schemas/OBInternalStatementFeeFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_6' required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementInterest: type: array items: type: object description: Set of elements used to provide details of a generic interest amount related to the statement resource. properties: Description: $ref: '#/components/schemas/Description_2' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_0' Type: $ref: '#/components/schemas/OBInternalStatementInterestType1Code' Rate: $ref: '#/components/schemas/OBRate1_1' RateType: $ref: '#/components/schemas/OBInternalStatementInterestRateType1Code' Frequency: $ref: '#/components/schemas/OBInternalStatementInterestFrequency1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount_7' required: - Amount - CreditDebitIndicator - Type maxItems: 99999 minItems: 0 StatementDateTime: type: array items: type: object description: Set of elements used to provide details of a generic date time for the statement resource. properties: DateTime: $ref: '#/components/schemas/DateTime' Type: $ref: '#/components/schemas/OBInternalStatementDateTimeType1Code' required: - DateTime - Type maxItems: 99999 minItems: 0 StatementRate: type: array items: type: object description: Set of elements used to provide details of a generic rate related to the statement resource. properties: Rate: $ref: '#/components/schemas/Rate' Type: $ref: '#/components/schemas/OBInternalStatementRateType1Code' required: - Rate - Type maxItems: 99999 minItems: 0 StatementValue: type: array items: type: object description: Set of elements used to provide details of a generic number value related to the statement resource. properties: Value: $ref: '#/components/schemas/Value' Type: $ref: '#/components/schemas/OBInternalStatementValueType1Code' required: - Type - Value maxItems: 99999 minItems: 0 TotalValue: type: object description: Combined sum of all Amounts in the accounts base currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency required: - AccountId - CreationDateTime - EndDateTime - StartDateTime - Type nullable: false StreetName: type: string description: Name of a street or thoroughfare. example: Bank Street maxLength: 140 minLength: 1 ExternalCategoryPurpose1Code: type: string description: Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. For all enum values see `ExternalCategoryPurpose1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - BONU - CASH - CBLK - CCRD - CGWV - CIPC - CONC - CORT - DCRD - DIVI - DVPM - EPAY - FCDT - FCIN - FCOL - GOVT - GP2P - HEDG - ICCP - IDCP - INTC - INTE - LBOX - LOAN - MP2B - MP2P - OTHR - PENS - RPRE - RRCT - RVPM - SALA - SECU - SSBE - SUPP - SWEP - TAXS - TOPG - TRAD - TREA - VATX - VOST - WHLD - ZABA OBAccount6Basic: type: object additionalProperties: false description: Unambiguous identification of the account to which credit and debit entries are made. properties: AccountId: $ref: '#/components/schemas/AccountId' Status: $ref: '#/components/schemas/OBInternalAccountStatus1Code' StatusUpdateDateTime: $ref: '#/components/schemas/StatusUpdateDateTime' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_0' AccountCategory: $ref: '#/components/schemas/OBInternalAccountType1Code' AccountTypeCode: $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/OBInternalSwitchStatusCode' required: - AccountId OBInternalConsentStatus1Code: type: string description: Specifies the status of consent resource in code form. enum: - AWAU - RJCT - AUTH - CANC - EXPD example: AWAU StatementReference: type: string description: Unique reference for the statement. This reference may be optionally populated if available. example: '002' maxLength: 35 minLength: 1 DebtorReference: type: string description: A reference value provided by the PSU to the PISP while setting up the scheduled payment. example: REF51561806 maxLength: 35 minLength: 1 OBFrequency6Code: type: string description: For a full list of values see `OBFrequency6Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - ADHO - YEAR - DAIL - FRTN - INDA - MNTH - QURT - MIAN - WEEK - WODL - FOWK - TWMH - FOMH - FIMH - ALMH - NONE - LWMH - LXMH - TWYR example: MNTH TransactionInformation: type: string description: "Further details of the transaction. \nThis is the transaction narrative, which is unstructured text." maxLength: 500 minLength: 1 BookingDateTime: type: string format: date-time description: "Date and time when a transaction entry is posted to an account on the account servicer's books.\nUsage:\ \ Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.\ \ All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses\ \ must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" OBInternalAccountStatus1Code: type: string description: 'Specifies the status of account resource in code form.
For a full list of enumeration values refer to `OBInternalAccountStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' enum: - Deleted - Disabled - Enabled - Pending - ProForma example: Enabled OBTransactionCashBalance: type: object additionalProperties: false deprecated: false description: Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account. properties: CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_2' Type: $ref: '#/components/schemas/OBBalanceType1Code' Amount: type: object description: Amount of money of the cash balance after a transaction entry is applied to the account.. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency required: - Amount - CreditDebitIndicator - Type nullable: false Frequency_1: type: string 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. WEEK = Event takes place once a week. FRTN = Event takes place every two weeks. FOWK = Event takes place every four weeks. MNTH = Event takes place every month or once a month. TWMH = Event takes place after every 2 months. FOMH = Event takes place after every 4 months MIAN = Event takes place every six months or two times a year. YEAR = Event takes place every year or once a year. QURT = Event takes place every three months or four times a year. 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 WEEK = (ScheduleCode + PointInTime). FRTN = (ScheduleCode + PointInTime). FOWK = (ScheduleCode + PointInTime). MNTH = (ScheduleCode + PointInTime). TWMH = (ScheduleCode + PointInTime). FOMH = (ScheduleCode + PointInTime). MIAN = (ScheduleCode + PointInTime). YEAR = (ScheduleCode + PointInTime). QURT = (ScheduleCode + PointInTime). 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) WEEK combined with PointInTime from 01-05 FRTN combined with PointInTime from 01-05 FOWK combined with PointInTime from 01-05 MNTH combined with PointInTime -1 or 31 or 01-30 or -4 or -3 or -2 or -1 TWMH combined with PointInTime from 01-31 or -4 or -3 or -2 or -1 FOMH combined with PointInTime from 01-31 or -4 or -3 or -2 or -1 MIAN combined with PointInTime from 01-31 or -4 or -3 or -2 or -1 YEAR combined with PointInTime from 01-31 or -4 or -3 or -2 or -1 QURT combined with PointInTime from 01-31 or -4 or -3 or -2 or -1 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))$|^(WEEK)$|^(FRTN)$|^(FOWK)$|^(MNTH)$|^(TWMH)$|^(FOMH)$|^(MIAN)$|^(YEAR)$|^(QURT)$|^(NONE)$|^(LWMH)$|^(LXMH)$|^(TWYR)$' example: WEEK maxLength: 35 minLength: 1 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))$|^(WEEK)$|^(FRTN)$|^(FOWK)$|^(MNTH)$|^(TWMH)$|^(FOMH)$|^(MIAN)$|^(YEAR)$|^(QURT)$|^(NONE)$|^(LWMH)$|^(LXMH)$|^(TWYR)$ OB_Period1Code: type: string description: Period e.g. day, week, month etc. for which the fee/charge is capped enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER OBActiveOrHistoricCurrencyAndAmount_10: type: object description: Transaction charges to be paid by the charge bearer. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency ExternalEntryStatus1Code: type: string description: 'Status of a transaction entry on the books of the account servicer.
For a full list of enumeration values refer to `ExternalEntryStatus1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' enum: - BOOK - FUTR - INFO - PDNG - RJCT OBActiveOrHistoricCurrencyAndAmount_11: type: object description: The amount of the last (most recent) Standing Order instruction. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency OBReadScheduledPayment3: type: object additionalProperties: false deprecated: false properties: Data: type: object properties: ScheduledPayment: type: array items: $ref: '#/components/schemas/OBScheduledPayment3' maxItems: 99999 minItems: 0 Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBTransaction6Basic: type: object additionalProperties: false deprecated: false description: Provides further details on an entry in the report. properties: AccountId: $ref: '#/components/schemas/AccountId' TransactionId: $ref: '#/components/schemas/TransactionId' TransactionReference: $ref: '#/components/schemas/TransactionReference' StatementReference: type: array items: $ref: '#/components/schemas/StatementReference' maxItems: 99999 minItems: 0 CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_1' Status: $ref: '#/components/schemas/ExternalEntryStatus1Code' TransactionMutability: $ref: '#/components/schemas/OBInternalTransactionMutability1Code' 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' ExtendedProprietaryBankTransactionCodes: type: array items: $ref: '#/components/schemas/OBExtendedProprietaryBankTransactionCode' maxItems: 99999 minItems: 0 CardInstrument: $ref: '#/components/schemas/OBTransactionCardInstrument1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' CategoryPurposeCode: $ref: '#/components/schemas/ExternalCategoryPurpose1Code' PaymentPurposeCode: $ref: '#/components/schemas/OBExternalPurpose1Code' required: - AccountId - Amount - BookingDateTime - CreditDebitIndicator - Status nullable: false ExternalProxyAccountType1Code: type: string description: Specifies the external proxy account type code, as published in the proxy account type external code set.
For more information and a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - TELE - EMAL - DNAM - CINC - COTX - COID - CUST - DRLC - EIDN - EWAL - PVTX - LEIC - MBNO - NIDN - CCPT - SHID - SOSE - TOKN - UBIL - VIPN - BIID example: TELE Number_1: type: integer description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount example: 1 maximum: 9999999 minimum: 0 Number_0: type: integer 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. example: 1 maximum: 9999999 minimum: 0 OBExternalAccountSubType1Code: type: string description: Specifies the sub type of account (product family group)
For a full list of enumeration values refer to `OBExternalCashAccountType1Code` *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - CACC - CARD - CASH - CHAR - CISH - COMM - CPAC - LLSV - LOAN - MGLD - MOMA - NREX - ODFT - ONDP - OTHR - SACC - SLRY - SVGS - TAXE - TRAN - TRAS - VACC - NFCA - MORT - WALT OBReadAccount6: type: object additionalProperties: false deprecated: false properties: Data: type: object properties: Account: type: array items: $ref: '#/components/schemas/OBAccount6' maxItems: 99999 minItems: 0 Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OB_InterestCalculationMethod1Code: type: string description: Methods of calculating interest enum: - ITCO - ITOT - ITSI Value: type: string description: Value associated with the statement value type. maxLength: 40 minLength: 1 OBBeneficiary5: type: object additionalProperties: false properties: AccountId: $ref: '#/components/schemas/AccountId' BeneficiaryId: $ref: '#/components/schemas/BeneficiaryId' BeneficiaryType: $ref: '#/components/schemas/OBInternalBeneficiaryType1Code' Reference: $ref: '#/components/schemas/Reference' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' CreditorAgent: $ref: '#/components/schemas/OBBranchAndFinancialInstitutionIdentification6_0' CreditorAccount: $ref: '#/components/schemas/OBCashAccount5_0' OBReadDataTransaction6: type: object additionalProperties: false deprecated: false properties: Transaction: type: array items: $ref: '#/components/schemas/OBTransaction6' maxItems: 99999 minItems: 0 nullable: false File: type: object OBInternalStatementBenefitType1Code: type: string description: Benefit type, in a coded form. For a full list of values see `OBInternalStatementBenefitType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.Cashback x-namespaced-enum: - UK.OBIE.Cashback - UK.OBIE.Insurance - UK.OBIE.TravelDiscount - UK.OBIE.TravelInsurance OB_FeeCategory1Code: type: string description: Categorisation of fees and charges into standard categories. enum: - FCOT - FCRE - FCSV OBTransaction6Detail: type: object additionalProperties: false deprecated: false description: Provides further details on an entry in the report. properties: AccountId: $ref: '#/components/schemas/AccountId' TransactionId: $ref: '#/components/schemas/TransactionId' TransactionReference: $ref: '#/components/schemas/TransactionReference' StatementReference: type: array items: $ref: '#/components/schemas/StatementReference' maxItems: 99999 minItems: 0 CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_1' Status: $ref: '#/components/schemas/ExternalEntryStatus1Code' TransactionMutability: $ref: '#/components/schemas/OBInternalTransactionMutability1Code' 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' ExtendedProprietaryBankTransactionCodes: type: array items: $ref: '#/components/schemas/OBExtendedProprietaryBankTransactionCode' maxItems: 99999 minItems: 0 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' CategoryPurposeCode: $ref: '#/components/schemas/ExternalCategoryPurpose1Code' PaymentPurposeCode: $ref: '#/components/schemas/OBExternalPurpose1Code' UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' required: - AccountId - Amount - BookingDateTime - CreditDebitIndicator - Status nullable: false OB_CodeMnemonic: type: string description: The four letter Mnemonic used within an XML file to identify a code pattern: ^\w{0,4}$ DirectDebitId: type: string description: A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner. maxLength: 40 minLength: 1 StatementFrequencyAndFormat: type: array items: type: object description: Frequency and format of statements for an account properties: Frequency: $ref: '#/components/schemas/OBFrequency2' CommunicationMethod: $ref: '#/components/schemas/OBCommunicationMethod' Format: $ref: '#/components/schemas/OBFileFormat' DeliveryAddress: $ref: '#/components/schemas/OBPostalAddress7' maxItems: 99999 minItems: 0 ScheduledPaymentId: type: string description: A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner. example: SP03 maxLength: 40 minLength: 1 OB_InterestRateType1Code_1: type: string description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) enum: - INBB - INFR - INGR - INLR - INNE - INOT EndDateTime: type: string format: date-time description: "Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO\ \ 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" example: '2017-07-12T00:00:00Z' OBInternalBeneficiaryType1Code: type: string description: Specifies the Beneficiary Type. enum: - Trusted - Ordinary example: Ordinary LastPaymentDateTime: type: string format: date-time 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. \nAll date-time fields in responses must include\ \ the timezone. An example is below:\n2017-04-05T10:43:07+00:00" example: '2017-07-12T00:00:00Z' CountryCode: type: string description: Nation with its own government, occupying a particular territory. pattern: ^[A-Z]{2,2}$ OBProxy1: type: object description: Specifies an alternate assumed name for the identification of the account. properties: Identification: type: string description: Identification used to indicate the account identification under another specified name. example: '2360549017905188' maxLength: 2048 minLength: 1 Code: $ref: '#/components/schemas/ExternalProxyAccountType1Code' Type: type: string description: Type of the proxy identification. maxLength: 35 minLength: 1 required: - Code - Identification Floor: type: string description: Number that identifies the level within a building example: '11' maxLength: 70 minLength: 1 OBInternalPartyType1Code: type: string description: Party type, in a coded form. For a full list see `OBInternalPartyType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - Delegate - Joint - Sole example: Joint MaturityDate: type: string format: date-time description: "Maturity date of the account. All dates in the JSON payloads are represented in ISO 8601 date-time format.\ \ \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" Date: type: string format: date description: "Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO\ \ 8601 date format. \n An example is below:\n2017-04-05" OBInternalStatementInterestType1Code: type: string description: Interest amount type, in a coded form. For a full list of values see `OBInternalStatementInterestType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: UK.OBIE.Total x-namespaced-enum: - UK.OBIE.BalanceTransfer - UK.OBIE.Cash - UK.OBIE.EstimatedNext - UK.OBIE.Purchase - UK.OBIE.Total OB_InterestRateType1Code_0: type: string description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) enum: - INBB - INFR - INGR - INLR - INNE - INOT LEI: type: string description: Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". example: IZ9Q00LZEVUKWCQY6X15 maxLength: 20 minLength: 1 pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ PartyNumber: type: string description: Number assigned by an agent to identify its customer. example: '20202002' maxLength: 35 minLength: 1 StartDateTime: type: string format: date-time description: "Date and time at which the statement period starts. All dates in the JSON payloads are represented in\ \ ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n\ 2017-04-05T10:43:07+00:00" example: '2017-07-12T00:00:00Z' OBTransaction6: type: object additionalProperties: false deprecated: false description: Provides further details on an entry in the report. properties: AccountId: $ref: '#/components/schemas/AccountId' TransactionId: $ref: '#/components/schemas/TransactionId' TransactionReference: $ref: '#/components/schemas/TransactionReference' StatementReference: type: array items: $ref: '#/components/schemas/StatementReference' maxItems: 99999 minItems: 0 CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_1' Status: $ref: '#/components/schemas/ExternalEntryStatus1Code' TransactionMutability: $ref: '#/components/schemas/OBInternalTransactionMutability1Code' 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' ExtendedProprietaryBankTransactionCodes: type: array items: $ref: '#/components/schemas/OBExtendedProprietaryBankTransactionCode' maxItems: 99999 minItems: 0 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' CategoryPurposeCode: $ref: '#/components/schemas/ExternalCategoryPurpose1Code' PaymentPurposeCode: $ref: '#/components/schemas/OBExternalPurpose1Code' UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' IntermediaryAgent1: $ref: '#/components/schemas/OBIntermediaryAgent' IntermediaryAgent2: $ref: '#/components/schemas/OBIntermediaryAgent' IntermediaryAgent3: $ref: '#/components/schemas/OBIntermediaryAgent' required: - AccountId - Amount - BookingDateTime - CreditDebitIndicator - Status nullable: false OBReadBalance1: type: object additionalProperties: false deprecated: false properties: Data: type: object properties: Balance: type: array items: type: object description: Set of elements used to define the balance details. properties: AccountId: $ref: '#/components/schemas/AccountId' CreditDebitIndicator: $ref: '#/components/schemas/OBCreditDebitCode_2' Type: $ref: '#/components/schemas/OBBalanceType1Code' DateTime: type: string format: date-time description: "Indicates the date (and time) of the balance. All dates in the JSON payloads are represented\ \ in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example\ \ is below:\n2017-04-05T10:43:07+00:00" Amount: type: object description: Amount of money of the cash balance. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' SubType: type: string default: BCUR description: Balance sub type, in a coded form. Default if not specified is BCUR of the account enum: - BCUR - LCUR required: - Amount - Currency CreditLine: type: array items: type: object description: Set of elements used to provide details on the credit line. properties: Included: type: boolean 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: type: string description: Limit type, in a coded form.
For a full list of enumeration values refer to `OBInternalLimitType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - Available - Credit - Emergency - Pre-Agreed - Temporary Amount: type: object description: Amount of money of the credit line. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency required: - Included maxItems: 99999 minItems: 0 LocalAmount: type: object description: Optional component providing the equivalent of Amount in local currency. Default is Local Currency (LCUR) if not specified properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' SubType: type: string default: LCUR description: Balance sub type, in a coded form. Default if not specified is LCUR of the account enum: - BCUR - LCUR required: - Amount - Currency required: - AccountId - Amount - CreditDebitIndicator - DateTime - Type maxItems: 99999 minItems: 1 TotalValue: type: object description: Combined sum of all Amounts in the accounts base currency properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_1' required: - Amount - Currency required: - Balance Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false Links: type: object additionalProperties: false description: Links relevant to the payload properties: Self: type: string format: uri First: type: string format: uri Prev: type: string format: uri Next: type: string format: uri Last: type: string format: uri required: - Self ISODateTime: type: string format: date-time description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in\ \ responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" responses: 200AccountsAccountIdTransactionsRead: description: Transactions Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadTransaction6' 200AccountsAccountIdDirectDebitsRead: description: Direct Debits Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadDirectDebit2' examples: get-accounts-direct-debits-response: value: Data: DirectDebit: - AccountId: '22289' DirectDebitId: DD03 MandateRelatedInformation: MandateIdentification: Caravanners Classification: FIXE CategoryPurposeCode: BONU FirstPaymentDateTime: '2024-04-25T12:46:49.425Z' RecurringPaymentDateTime: '2024-04-25T12:46:49.425Z' FinalPaymentDateTime: '2024-04-25T12:46:49.425Z' Reason: To pay monthly membership Frequency: Type: WEEK CountPerPeriod: 1 DirectDebitStatusCode: ACTV Name: Towbar Club 3 - We Love Towbars PreviousPaymentDateTime: '2017-04-05T10:43:07+00:00' PreviousPaymentAmount: Amount: '0.57' Currency: GBP Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/direct-debits/ Meta: TotalPages: 1 200AccountsRead: description: Accounts Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadAccount6' examples: get-accounts-response: value: Data: Account: - AccountId: '22289' Status: Enabled MaturityDate: '2019-01-01T06:06:06+00:00' StatusUpdateDateTime: '2019-01-01T06:06:06+00:00' Currency: GBP AccountCategory: Personal AccountTypeCode: CACC Description: For paying bills Nickname: Bills OpeningDate: '2017-04-05T10:43:07+00:00' SwitchStatus: UK.CASS.NotSwitched StatementFrequencyAndFormat: - Frequency: YEAR CommunicationMethod: EMAL Format: DPDF DeliveryAddress: AddressType: HOME StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK Servicer: SchemeName: UK.OBIE.BICFI Identification: '8020441910203345' Name: ServicerName Account: - SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '80200110203345' Name: Mr Kevin SecondaryIdentification: '00021' LEI: 9193001QZMP2PQT4AK86 - AccountId: '31820' Status: Enabled StatusUpdateDateTime: '2018-01-01T06:06:06+00:00' Currency: GBP AccountCategory: Personal AccountTypeCode: CACC Nickname: Household Account: - SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '80200110203348' Name: Mr Kevin Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/ Meta: TotalPages: 1 415Error: description: Unsupported Media Type headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 401Error: description: Unauthorized headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 204AccountAccessConsentsConsentIdDeleted: description: Account Access Consents Deleted headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 404Error: description: Not found headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 200AccountsAccountIdStatementsRead: description: Statements Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadStatement2' examples: get-account-statement-request: value: Data: Statement: - AccountId: '22289' StatementId: 8sfhke-sifhkeuf-97813 StatementReference: '002' Type: RegularPeriodic StartDateTime: '2017-08-01T00:00:00+00:00' EndDateTime: '2017-08-31T23:59:59+00:00' CreationDateTime: '2017-09-01T00:00:00+00:00' StatementDateTime: - DateTime: '2017-08-01T00:00:00+00:00' Type: UK.OBIE.DirectDebitDue TotalValue: Amount: '1024.00' Currency: GBP StatementDescription: - August 2017 Statement - One Free Uber Ride StatementAmount: - Amount: Amount: '400.00' Currency: GBP SubType: BCUR LocalAmount: Amount: '400.00' Currency: GBP SubType: BCUR CreditDebitIndicator: Credit Type: ClosingBalance - Amount: Amount: '600.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance StatementBenefit: - Type: UK.OBIE.Cashback Amount: Amount: '5.00' Currency: GBP StatementValue: - Type: UK.OBIE.AirMilesPoints Value: '100' StatementFee: - Description: International usage charge Type: UK.OBIE.ForeignTransaction Rate: 0.229 CreditDebitIndicator: Credit RateType: UK.OBIE.AER Frequency: UK.OBIE.StatementMonthly Amount: Amount: '03.75' Currency: GBP StatementInterest: - Description: Interest occurred over statement duration Type: UK.OBIE.Total Rate: 0.229 CreditDebitIndicator: Credit RateType: UK.OBIE.FixedRate Frequency: UK.OBIE.StatementMonthly Amount: Amount: '20.25' Currency: GBP StatementRate: - Rate: '0.229' Type: UK.OBIE.MonthlyPurchase - AccountId: '22289' StatementId: 34hj24u-324h33-31i3p4 StatementReference: '003' Type: RegularPeriodic StartDateTime: '2017-09-01T00:00:00+00:00' EndDateTime: '2017-09-30T23:59:59+00:00' CreationDateTime: '2017-10-01T00:00:00+00:00' StatementDescription: - September 2017 Statement StatementAmount: - Amount: Amount: '200.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance - Amount: Amount: '400.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/statements/ Meta: TotalPages: 1 200AccountsAccountIdBalancesRead: description: Balances Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadBalance1' examples: get-account-balances-response: value: Data: Balance: - AccountId: '22289' Amount: Amount: '300.00' Currency: GBP SubType: BCUR LocalAmount: Amount: '1230.00' Currency: GBP SubType: BCUR TotalAmount: Amount: '1230.00' Currency: GBP CreditDebitIndicator: Credit Type: ITAV DateTime: '2017-04-05T10:43:07+00:00' CreditLine: - Included: false Amount: Amount: '500.00' Currency: GBP Type: Available - Included: false Amount: Amount: '500.00' Currency: GBP Type: Pre-Agreed TotalValue: Amount: '720.39' Currency: GBP Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/balances/ Meta: TotalPages: 1 200AccountsAccountIdScheduledPaymentsRead: description: Scheduled Payments Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadScheduledPayment3' examples: get-account-specific-scheduled-payments-response: value: Data: Product: - AccountId: '22289' ProductId: 51B SecondaryProductId: CA78 MarketingStateId: '22878123' ProductType: PersonalCurrentAccount ProductName: 321 Product PCA: {} BCA: {} Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/product Meta: TotalPages: 1 200AccountsAccountIdStandingOrdersRead: description: Standing Orders Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadStandingOrder6' examples: get-accounts-standing-order-response: value: Data: StandingOrder: - AccountId: '22289' StandingOrderId: Ben3 FirstPaymentAmount: Amount: '0.57' Currency: GBP NextPaymentDateTime: '2017-08-13T00:00:00+00:00' NextPaymentAmount: Amount: '0.56' Currency: GBP FinalPaymentAmount: Amount: '0.56' Currency: GBP LastPaymentDateTime: '2017-07-13T00:00:00+00:00' LastPaymentAmount: Amount: '0.56' Currency: GBP CreditorAgent: SchemeName: UK.OBIE.BICFI Identification: '80200112344562' MandateRelatedInformation: MandateIdentification: Golfers Classification: FIXE CategoryPurposeCode: BONU FirstPaymentDateTime: '2024-04-25T12:46:49.425Z' RecurringPaymentDateTime: '2024-04-25T12:46:49.425Z' FinalPaymentDateTime: '2024-04-25T12:46:49.425Z' Reason: To pay monthly membership Frequency: Type: MNTH CountPerPeriod: 1 StandingOrderStatusCode: ACTV CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '80200112345678' SecondaryIdentification: '80200112895462' Name: Mrs Juniper Proxy: Identification: '441234012345' Code: TELE Type: Telephone Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/standing-orders/ Meta: TotalPages: 1 403Error: description: Forbidden headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 403ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 500Error: description: Internal Server Error headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 500ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 406Error: description: Not Acceptable headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 200AccountsAccountIdStatementsStatementIdRead: description: Statements Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadStatement2' examples: get-account-statement-request: value: Data: Statement: - AccountId: '22289' StatementId: 8sfhke-sifhkeuf-97813 StatementReference: '002' Type: RegularPeriodic StartDateTime: '2017-08-01T00:00:00+00:00' EndDateTime: '2017-08-31T23:59:59+00:00' CreationDateTime: '2017-09-01T00:00:00+00:00' StatementDateTime: - DateTime: '2017-08-01T00:00:00+00:00' Type: UK.OBIE.DirectDebitDue TotalValue: Amount: '1024.00' Currency: GBP StatementDescription: - August 2017 Statement - One Free Uber Ride StatementAmount: - Amount: Amount: '400.00' Currency: GBP SubType: BCUR LocalAmount: Amount: '400.00' Currency: GBP SubType: BCUR CreditDebitIndicator: Credit Type: ClosingBalance - Amount: Amount: '600.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance StatementBenefit: - Type: UK.OBIE.Cashback Amount: Amount: '5.00' Currency: GBP StatementValue: - Type: UK.OBIE.AirMilesPoints Value: '100' StatementFee: - Description: International usage charge Type: UK.OBIE.ForeignTransaction Rate: 0.229 CreditDebitIndicator: Credit RateType: UK.OBIE.AER Frequency: UK.OBIE.StatementMonthly Amount: Amount: '03.75' Currency: GBP StatementInterest: - Description: Interest occurred over statement duration Type: UK.OBIE.Total Rate: 0.229 CreditDebitIndicator: Credit RateType: UK.OBIE.FixedRate Frequency: UK.OBIE.StatementMonthly Amount: Amount: '20.25' Currency: GBP StatementRate: - Rate: '0.229' Type: UK.OBIE.MonthlyPurchase - AccountId: '22289' StatementId: 34hj24u-324h33-31i3p4 StatementReference: '003' Type: RegularPeriodic StartDateTime: '2017-09-01T00:00:00+00:00' EndDateTime: '2017-09-30T23:59:59+00:00' CreationDateTime: '2017-10-01T00:00:00+00:00' StatementDescription: - September 2017 Statement StatementAmount: - Amount: Amount: '200.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance - Amount: Amount: '400.00' Currency: GBP CreditDebitIndicator: Credit Type: PreviousClosingBalance Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/statements/ Meta: TotalPages: 1 200AccountsAccountIdBeneficiariesRead: description: Beneficiaries Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadBeneficiary5' examples: get-account-beneficiaries-response: value: Data: Beneficiary: - AccountId: '22289' BeneficiaryId: Ben1 BeneficiaryType: Ordinary Reference: Towbar Club CreditorAgent: LEI: IZ9Q00LZEVUKWCQY6X15 SchemeName: UK.OBIE.BICFI Identification: '80200112344562' Name: The Credit Agent PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '80200112345678' SecondaryIdentification: ID_0002 Name: Mrs Juniper Proxy: Identification: '2360549017905188' Code: TELE Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/beneficiaries/ Meta: TotalPages: 1 200AccountsAccountIdProductRead: description: Products Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadProduct2' examples: get-accounts-product-response: value: Data: Product: - AccountId: '22289' ProductId: 51B SecondaryProductId: CA78 MarketingStateId: '22878123' ProductType: PersonalCurrentAccount ProductName: 321 Product PCA: {} BCA: {} Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/product Meta: TotalPages: 1 400Error: description: Bad request headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 400ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 200AccountsAccountIdPartiesRead: description: Parties Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadParty3' examples: get-account-parties-response: value: Data: Party: - PartyId: PABC123 PartyType: Sole Name: Semiotec FullLegalName: Semiotec Limited LegalStructure: UK.OBIE.PrivateLimitedCompany BeneficialOwnership: true AccountRole: UK.OBIE.Principal EmailAddress: contact@semiotec.co.jp LEI: 068700IA8DVYPS77MD05 Relationships: Account: Related: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289 Id: '22289' Phone: +44-2079460000 Mobile: +44-7700900000 Address: - AddressType: BIZZ StreetName: Street BuildingNumber: '15' PostCode: NW1 1AB TownName: London Country: GB - PartyId: PXSIF023 PartyNumber: '0000007456' PartyType: Delegate Name: Kevin Atkinson FullLegalName: Mr Kevin Bartholmew Atkinson LegalStructure: UK.OBIE.Individual BeneficialOwnership: false LEI: 068700IA8DVHGY77MD85 AccountRole: UK.OBIE.Administrator EmailAddress: kev@semiotec.co.jp Relationships: Account: Related: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289 Id: '22289' Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/parties Meta: TotalPages: 1 200AccountsAccountIdOffersRead: description: Offers Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadOffer1' examples: get-offers-response: value: Data: Offer: - AccountId: '22289' OfferId: Offer1 OfferType: LimitIncrease Description: Credit limit increase for the account up to £10000.00 StartDateTime: '2024-05-29T00:00:00Z' EndDateime: '2024-06-29T00:00:00Z' Rate: '100.00' Value: 10 Term: Starting first of the month and ending at the end of year Fee: Amount: '01.50' Currency: GBP URL: http://modelbank.com/offer/offer1 Amount: Amount: '10000.00' Currency: GBP - AccountId: '22289' OfferId: Offer2 OfferType: BalanceTransfer StartDateTime: '2024-05-29T00:00:00Z' EndDateTime: '2024-06-29T00:00:00Z' Description: Balance transfer offer up to £2000 Amount: Amount: '2000.00' Currency: GBP Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/22289/offers/ Meta: TotalPages: 1 200AccountsAccountIdRead: description: Accounts Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadAccount6' examples: get-accounts-response: value: Data: Account: - AccountId: '22289' Status: Enabled MaturityDate: '2019-01-01T06:06:06+00:00' StatusUpdateDateTime: '2019-01-01T06:06:06+00:00' Currency: GBP AccountCategory: Personal AccountTypeCode: CACC Description: For paying bills Nickname: Bills OpeningDate: '2017-04-05T10:43:07+00:00' SwitchStatus: UK.CASS.NotSwitched StatementFrequencyAndFormat: - Frequency: YEAR CommunicationMethod: EMAL Format: DPDF DeliveryAddress: AddressType: HOME StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK Servicer: SchemeName: UK.OBIE.BICFI Identification: '8020441910203345' Name: ServicerName Account: - SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '80200110203345' Name: Mr Kevin SecondaryIdentification: '00021' LEI: 9193001QZMP2PQT4AK86 - AccountId: '31820' Status: Enabled StatusUpdateDateTime: '2018-01-01T06:06:06+00:00' Currency: GBP AccountCategory: Personal AccountTypeCode: CACC Nickname: Household Account: - SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '80200110203348' Name: Mr Kevin Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/accounts/ Meta: TotalPages: 1 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait schema: type: integer deprecated: false maximum: 9999999 minimum: 1 nullable: false example: 120 x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 201AccountAccessConsentsCreated: description: Account Access Consents Created headers: Location: description: Mandatory response header for HTTP 201 (Created) response codes schema: type: string deprecated: false maxLength: 492 minLength: 2 pattern: ^(https:\/\/[-a-zA-Z0-9\\._\\\/?=]{2,492})$ nullable: true example: https://www.example.org/index.php x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadConsentResponse1' examples: create-account-access-response: value: Data: ConsentId: urn-alphabank-intent-88379 Status: AWAU StatusUpdateDateTime: '2017-05-02T00:00:00+00:00' CreationDateTime: '2017-05-02T00:00:00+00:00' StatusReason: - StatusReasonCode: U036 StatusReasonDescription: Waiting for completion of consent authorisation to be completed by user Permissions: - ReadAccountsDetail - ReadBalances - ReadBeneficiariesDetail - ReadDirectDebits - ReadProducts - ReadStandingOrdersDetail - ReadTransactionsCredits - ReadTransactionsDebits - ReadTransactionsDetail - ReadOffers - ReadPAN - ReadParty - ReadPartyPSU - ReadScheduledPaymentsDetail - ReadStatementsDetail ExpirationDateTime: '2017-08-02T00:00:00+00:00' TransactionFromDateTime: '2017-05-03T00:00:00+00:00' TransactionToDateTime: '2017-12-03T00:00:00+00:00' Risk: {} Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/account-access-consents/urn-alphabank-intent-88379 Meta: TotalPages: 1 200AccountsAccountIdStatementsStatementIdTransactionsRead: description: Transactions Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadTransaction6' 200AccountAccessConsentsConsentIdRead: description: Account Access Consents Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBReadConsentResponse1' examples: account-access-consent-read-response: value: Data: ConsentId: urn-alphabank-intent-88379 Status: AWAU StatusReason: - StatusReasonCode: U036 StatusReasonDescription: Waiting for completion of consent authorisation to be completed by user StatusReasonDescription: Waiting for completion of consent authorisation to be completed by user StatusUpdateDateTime: '2017-05-02T00:00:00+00:00' CreationDateTime: '2017-05-02T00:00:00+00:00' Permissions: - ReadAccountsDetail - ReadBalances - ReadBeneficiariesDetail - ReadDirectDebits - ReadProducts - ReadStandingOrdersDetail - ReadTransactionsCredits - ReadTransactionsDebits - ReadTransactionsDetail - ReadOffers - ReadPAN - ReadParty - ReadPartyPSU - ReadScheduledPaymentsDetail - ReadStatementsDetail ExpirationDateTime: '2017-08-02T00:00:00+00:00' TransactionFromDateTime: '2017-05-03T00:00:00+00:00' TransactionToDateTime: '2017-12-03T00:00:00+00:00' Risk: {} Links: Self: https://api.alphabank.com/open-banking/v4.0/aisp/account-access-consents/urn-alphabank-intent-88379 Meta: TotalPages: 1 parameters: x-fapi-auth-date: name: x-fapi-auth-date in: header description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as\ \ RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC" required: false schema: type: string deprecated: false maxLength: 29 minLength: 29 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)$ nullable: false example: Sun, 10 Sep 2017 19:43:31 UTC AccountId: name: accountId in: path description: AccountId required: true schema: type: string deprecated: false maxLength: 20 minLength: 1 pattern: ^\d{1,20}$ nullable: false example: '12345678901234567890' x-fapi-customer-ip-address: name: x-fapi-customer-ip-address in: header description: The PSU's IP address if the PSU is currently logged in with the TPP. required: false schema: type: string maxLength: 40 minLength: 7 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([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])))$ nullable: false example: 104.25.212.99 ConsentId: name: consentId in: path description: ConsentId required: true schema: type: string deprecated: false maxLength: 25 minLength: 1 pattern: ^BARCLAYS-[A]-\d{14}$ nullable: false example: BARCLAYS-A-12345678901234 FromBookingDateTimeParam: name: fromBookingDateTime in: query description: 'The UTC ISO 8601 Date Time to filter transactions FROM. Note: Time component is optional - set to 00:00:00 for just Date. The value **must not** include the timezone component. ' schema: type: string deprecated: false nullable: false example: '2026-01-01T00:00:00' Authorization: name: Authorization in: header description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 required: true schema: type: string maxLength: 4871 minLength: 1 pattern: ^Bearer [A-Za-z0-9-_=]{1,256}\.\.[A-Za-z0-9-_=]{1,100}\.[A-Za-z0-9-_=]{1,4096}\.[A-Za-z0-9-_=]{1,100}$ nullable: false example: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0OTk4NTA5NjUsInN1YiI6IkJhcmNsYXlzX1BheW1lbnRfU2VydmljZSIsInNjb3BlIjpbImlkcy5tYW5hZ2Vfa2V5IiwiaWRzLm1hbmFnZV9jbGllbnQiXSwiaXNzIjoiaHR0cDovL2lkZW50aXR5LXNlcnZpY2UvIiwiaWF0IjoxNDk5ODUwMDY1fQ.OX-u14YLs7iksl6gnZ9ZqMBu-ekFi4pSva5mzhuf2xU x-customer-user-agent: name: x-customer-user-agent in: header description: Indicates the user-agent that the PSU is using. required: false schema: type: string deprecated: false maxLength: 500 minLength: 1 nullable: false example: Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405 x-jws-signature: name: x-jws-signature in: header description: A detached JWS signature of the body of the payload. required: true schema: type: string deprecated: false maxLength: 8192 minLength: 10 pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$ nullable: false example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4 FromStatementDateTimeParam: name: fromStatementDateTime in: query description: 'The UTC ISO 8601 Date Time to filter statements FROM. Note: Time component is optional - set to 00:00:00 for just Date. The value **must not** include the timezone component. ' schema: type: string deprecated: false nullable: false example: '2026-01-01T00:00:00' x-fapi-interaction-id: name: x-fapi-interaction-id in: header description: An RFC4122 UID used as a correlation id. required: false schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d StatementId: name: statementId in: path description: StatementId required: true schema: type: string deprecated: false maxLength: 40 minLength: 1 nullable: false example: '1234567890' ToStatementDateTimeParam: name: toStatementDateTime in: query description: 'The UTC ISO 8601 Date Time to filter statements TO. Note: Time component is optional - set to 00:00:00 for just Date. The value **must not** include the timezone component. ' schema: type: string deprecated: false nullable: false example: '2026-12-31T23:59:59' ToBookingDateTimeParam: name: toBookingDateTime in: query description: 'The UTC ISO 8601 Date Time to filter transactions TO. Note: Time component is optional - set to 00:00:00 for just Date. The value **must not** include the timezone component. ' schema: type: string deprecated: false nullable: false example: '2026-12-31T23:59:59' securitySchemes: TPPOAuth2Security: type: oauth2 description: TPP client credential authorisation flow with the ASPSP flows: clientCredentials: tokenUrl: https://authserver.example/token scopes: accounts: Ability to read Accounts information PSUOAuth2Security: type: oauth2 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 flows: authorizationCode: authorizationUrl: https://authserver.example/authorization tokenUrl: https://authserver.example/token scopes: accounts: Ability to read Accounts information