openapi: 3.2.0 info: title: Account and Transactions Products API 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 tags: - name: Products description: Get Products paths: /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 /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 components: schemas: 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 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 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 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 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 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 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 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 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 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_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 OB_MinMaxType1Code: type: string description: Min Max type enum: - FMMN - FMMX 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" OB_CodeMnemonic: type: string description: The four letter Mnemonic used within an XML file to identify a code pattern: ^\w{0,4}$ 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 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. \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}$ 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 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 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 Name_4: type: string description: Long name associated with the code maxLength: 70 minLength: 1 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 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 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_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 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}$ 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}$ OB_FeeType1Code: type: string description: Fee/Charge Type enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX OB_InterestCalculationMethod1Code: type: string description: Methods of calculating interest enum: - ITCO - ITOT - ITSI 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 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. \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}$ 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 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 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 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_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}$ 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 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 OB_Amount1_0: type: string description: Cap amount charged for a fee/charge pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ 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 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 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 OB_InterestFixedVariableType1Code: type: string description: Type of interest rate, Fixed or Variable enum: - INFI - INVA 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_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}$ Description_3: type: string description: Description to describe the purpose of the code maxLength: 350 minLength: 1 OB_FeeCategory1Code: type: string description: Categorisation of fees and charges into standard categories. enum: - FCOT - FCRE - FCSV 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 OB_OverdraftFeeType1Code: type: string description: Overdraft fee type enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT parameters: 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 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 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 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-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 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 responses: 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 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: 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 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: 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 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 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 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 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