openapi: 3.2.0 info: title: Account and Transaction - UK OB Products API description: Retrieve account details and transaction information. version: 4.0.0 servers: - description: prod Environment url: https://obp-api.danskebank.com/open-banking/v4.0/aisp tags: - name: Products paths: /accounts/{AccountId}/product: get: tags: - Products summary: Get Products operationId: GetAccountsAccountIdProduct security: - BearerAuth: [] parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdProductRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' '503': $ref: '#/components/responses/503Error' components: schemas: OB_FeeCategory1Code: description: Categorisation of fees and charges into standard categories. type: string enum: - FCOT - FCRE - FCSV OB_Amount1_1: description: Every additional tranche of an overdraft balance to which an overdraft fee is applied type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ OB_Amount1_4: description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ OB_Amount1_2: description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Number_0: description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it's part of a government scheme, or whether the rate may vary dependent on the applicant's circumstances. type: integer OB_InterestCalculationMethod1Code: description: Methods of calculating interest type: string enum: - ITCO - ITOT - ITSI OB_OtherCodeType1_6: description: Other application frequencies not covered in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' Links: description: Links relevant to the payload type: object additionalProperties: false required: - Self 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 Number_1: description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: integer OBPCAData1: title: PCA type: object additionalProperties: false properties: ProductDetails: title: ProductDetails type: object additionalProperties: false properties: Segment: title: Segment description: 'Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to PCA products, they are segmented in relation to different markets that they wish to focus on. ' type: array items: description: 'Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to PCA products, they are segmented in relation to different markets that they wish to focus on. ' type: string enum: - Basic - BenefitAndReward - CreditInterest - Cashback - General - Graduate - Other - Overdraft - Packaged - Premium - Reward - Student - YoungAdult - Youth MonthlyMaximumCharge: title: MonthlyMaximumCharge description: The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: title: Notes description: Optional additional notes to supplement the Core product details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 CreditInterest: title: CreditInterest description: Details about the interest that may be payable to the PCA account holders type: object additionalProperties: false required: - TierBandSet properties: TierBandSet: title: TierBandSet description: The group of tiers or bands for which credit interest can be applied. type: array minItems: 1 items: description: The group of tiers or bands for which credit interest can be applied. type: object properties: TierBandMethod: title: TierBandMethod description: 'The methodology of how credit interest is charged. It can be: 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. 3. Whole The same interest rate is applied irrespective of the PCA balance ' type: string enum: - Tiered - Whole CalculationMethod: title: CalculationMethod description: Methods of calculating interest type: string enum: - Compound - SimpleInterest Destination: title: Destination description: Describes whether accrued interest is payable only to the PCA or to another bank account type: string enum: - PayAway - SelfCredit Notes: title: Notes description: Optional additional notes to supplement the Tier Band Set details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 TierBand: title: TierBand description: Tier Band Details type: array minItems: 1 items: description: Tier Band Details type: object properties: Identification: title: Identification description: Unique and unambiguous identification of a Tier Band for a PCA. type: string minLength: 1 maxLength: 35 TierValueMinimum: title: TierValueMinimum description: Minimum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMaximum: title: TierValueMaximum description: Maximum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CalculationFrequency: title: CalculationFrequency description: How often is credit interest calculated for the account. type: string enum: - PerAcademicTerm - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly ApplicationFrequency: title: ApplicationFrequency description: How often is interest applied to the PCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's PCA. type: string enum: - PerAcademicTerm - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly DepositInterestAppliedCoverage: title: DepositInterestAppliedCoverage description: Amount on which Interest applied. type: string enum: - Tiered - Whole FixedVariableInterestRateType: title: FixedVariableInterestRateType description: Type of interest rate, Fixed or Variable type: string enum: - Fixed - Variable AER: title: AER description: 'The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A ' type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ BankInterestRateType: title: BankInterestRateType description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA. type: string enum: - LinkedBaseRate - Gross - Net - Other BankInterestRate: title: BankInterestRate description: Bank Interest for the PCA product type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: title: Notes description: Optional additional notes to supplement the Tier Band details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherBankInterestType: title: OtherBankInterestType description: Other interest rate types which are not available in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherApplicationFrequency: title: OtherApplicationFrequency description: Other application frequencies that are not available in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherCalculationFrequency: title: OtherCalculationFrequency description: Other calculation frequency which is not available in the standard code set. type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - TierValueMinimum - ApplicationFrequency - FixedVariableInterestRateType - AER required: - TierBandMethod - TierBand Overdraft: title: Overdraft description: Details about Overdraft rates, fees & charges type: object additionalProperties: false required: - OverdraftTierBandSet properties: Notes: title: Notes description: Associated Notes about the overdraft rates type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBandSet: title: OverdraftTierBandSet description: Tier band set details type: array minItems: 1 items: description: Tier band set details type: object properties: TierBandMethod: title: TierBandMethod description: 'The methodology of how overdraft is charged. It can be: ''Whole'' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). ''Tiered'' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation. ''Banded'' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. ' type: string enum: - Tiered - Whole - Banded OverdraftType: title: OverdraftType description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. type: string enum: - Committed - OnDemand - Other Identification: title: Identification description: Unique and unambiguous identification of a Tier Band for a overdraft product. type: string minLength: 1 maxLength: 35 AuthorisedIndicator: title: AuthorisedIndicator description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) type: boolean BufferAmount: title: BufferAmount description: 'When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.' type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: title: Notes description: Optional additional notes to supplement the overdraft Tier Band Set details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBand: title: OverdraftTierBand description: Provides overdraft details for a specific tier or band type: array minItems: 1 items: description: Provides overdraft details for a specific tier or band type: object properties: Identification: title: Identification description: Unique and unambiguous identification of a Tier Band for a overdraft. type: string minLength: 1 maxLength: 35 TierValueMin: title: TierValueMin description: Minimum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMax: title: TierValueMax description: Maximum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ OverdraftInterestChargingCoverage: title: OverdraftInterestChargingCoverage description: Interest charged on whole amount or tiered/banded type: string enum: - Tiered - Whole BankGuaranteedIndicator: title: BankGuaranteedIndicator description: Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically type: boolean EAR: title: EAR description: 'EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft. ' type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ RepresentativeAPR: title: RepresentativeAPR description: An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account. type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: title: Notes description: Optional additional notes to supplement the Tier/band details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeesCharges: title: OverdraftFeesCharges description: Overdraft fees and charges type: array items: description: Overdraft fees and charges type: object properties: OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: Details about any caps (maximum charges) that apply to a particular fee/charge type: array items: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans OverdraftControlIndicator: title: OverdraftControlIndicator description: Specifies for the overdraft control feature/benefit type: boolean MinMaxType: title: MinMaxType description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: title: OverdraftFeeChargeDetail description: Details about the fees/charges type: array minItems: 1 items: description: Details about the fees/charges type: object properties: FeeType: title: FeeType description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans OverdraftControlIndicator: title: OverdraftControlIndicator description: Specifies for the overdraft control feature/benefit type: boolean IncrementalBorrowingAmount: title: IncrementalBorrowingAmount description: Every additional tranche of an overdraft balance to which an overdraft fee is applied type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeAmount: title: FeeAmount description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: title: FeeRate description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: title: FeeRateType description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string enum: - LinkedBaseRate - Gross - Net - Other ApplicationFrequency: title: ApplicationFrequency description: Frequency at which the overdraft charge is applied to the account type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: title: CalculationFrequency description: How often is the overdraft fee/charge calculated for the account. type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: title: Notes description: Free text for capturing any other info related to Overdraft Fees Charge Details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other Fee type which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherFeeRateType: title: OtherFeeRateType description: Other fee rate type code which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherApplicationFrequency: title: OtherApplicationFrequency description: Other application frequencies that are not available in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherCalculationFrequency: title: OtherCalculationFrequency description: Other calculation frequency which is not available in the standard code set. type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object additionalProperties: false required: - FeeType - MinMaxType properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans OverdraftControlIndicator: title: OverdraftControlIndicator description: Specifies for the overdraft control feature/benefit type: boolean MinMaxType: title: MinMaxType description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - ApplicationFrequency required: - OverdraftFeeChargeDetail required: - TierValueMin OverdraftFeesCharges: title: OverdraftFeesCharges description: Overdraft fees and charges details type: array items: description: Overdraft fees and charges details type: object properties: OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: Details about any caps (maximum charges) that apply to a particular fee/charge type: array items: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans OverdraftControlIndicator: title: OverdraftControlIndicator description: Specifies for the overdraft control feature/benefit type: boolean MinMaxType: title: MinMaxType description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: title: OverdraftFeeChargeDetail description: Details about the fees/charges type: array minItems: 1 items: description: Details about the fees/charges type: object properties: FeeType: title: FeeType description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans OverdraftControlIndicator: title: OverdraftControlIndicator description: Specifies for the overdraft control feature/benefit type: boolean IncrementalBorrowingAmount: title: IncrementalBorrowingAmount description: Every additional tranche of an overdraft balance to which an overdraft fee is applied type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeAmount: title: FeeAmount description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: title: FeeRate description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: title: FeeRateType description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string enum: - LinkedBaseRate - Gross - Net - Other ApplicationFrequency: title: ApplicationFrequency description: Frequency at which the overdraft charge is applied to the account type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: title: CalculationFrequency description: How often is the overdraft fee/charge calculated for the account. type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: title: Notes description: Free text for capturing any other info related to Overdraft Fees Charge Details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other Fee type which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherFeeRateType: title: OtherFeeRateType description: Other fee rate type code which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherApplicationFrequency: title: OtherApplicationFrequency description: Other application frequencies that are not available in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherCalculationFrequency: title: OtherCalculationFrequency description: Other calculation frequency which is not available in the standard code set. type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object additionalProperties: false required: - FeeType - MinMaxType properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans OverdraftControlIndicator: title: OverdraftControlIndicator description: Specifies for the overdraft control feature/benefit type: boolean MinMaxType: title: MinMaxType description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - ApplicationFrequency required: - OverdraftFeeChargeDetail required: - TierBandMethod - OverdraftTierBand OtherFeesCharges: title: OtherFeesCharges description: Contains details of fees and charges which are not associated with either borrowing or features/benefits type: object additionalProperties: false required: - FeeChargeDetail properties: FeeChargeDetail: title: FeeChargeDetail description: Other fees/charges details type: array minItems: 1 items: description: Other fees/charges details type: object properties: FeeCategory: title: FeeCategory description: Categorisation of fees and charges into standard categories. type: string enum: - Other - Servicing FeeType: title: FeeType description: Fee/Charge Type type: string enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other FeeAmount: title: FeeAmount description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: title: FeeRate description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: title: FeeRateType description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) type: string enum: - LinkedBaseRate - Gross - Net - Other ApplicationFrequency: title: ApplicationFrequency description: How frequently the fee/charge is applied to the account type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: title: CalculationFrequency description: How frequently the fee/charge is calculated type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: title: Notes description: Optional additional notes to supplement the fee/charge details. type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeCategoryType: title: OtherFeeCategoryType type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherFeeType: title: OtherFeeType description: Other Fee/charge type which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 FeeCategory: title: FeeCategory description: Categorisation of fees and charges into standard categories. type: string enum: - Other - Servicing Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherFeeRateType: title: OtherFeeRateType description: Other fee rate type which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherApplicationFrequency: title: OtherApplicationFrequency description: Other application frequencies not covered in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherCalculationFrequency: title: OtherCalculationFrequency description: Other calculation frequency which is not available in standard code set. type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 FeeChargeCap: title: FeeChargeCap description: Details about any caps (maximum charges) that apply to a particular fee/charge type: array items: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other MinMaxType: title: MinMaxType description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Free text for adding extra details for fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType FeeApplicableRange: title: FeeApplicableRange description: Range or amounts or rates for which the fee/charge applies type: object additionalProperties: false properties: MinimumAmount: title: MinimumAmount description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MaximumAmount: title: MaximumAmount description: Maximum Amount on which fee is applicable (where it is expressed as an amount) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MinimumRate: title: MinimumRate description: Minimum rate on which fee/charge is applicable(where it is expressed as an rate) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ MaximumRate: title: MaximumRate description: Maximum rate on which fee/charge is applicable(where it is expressed as an rate) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ required: - FeeCategory - FeeType - ApplicationFrequency FeeChargeCap: title: FeeChargeCap description: Details about any caps (maximum charges) that apply to a particular fee/charge type: array items: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other MinMaxType: title: MinMaxType description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Free text for adding extra details for fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OB_FeeFrequency1Code_2: description: How frequently the fee/charge is applied to the account type: string enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE OB_Rate1_0: description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Meta: title: MetaData description: Meta Data relevant to the payload type: object additionalProperties: false properties: TotalPages: type: integer format: int32 FirstAvailableDateTime: $ref: '#/components/schemas/ISODateTime' LastAvailableDateTime: $ref: '#/components/schemas/ISODateTime' OBError1: type: object minProperties: 1 additionalProperties: false required: - ErrorCode properties: ErrorCode: $ref: '#/components/schemas/OBExternalStatusReason1Code' Message: description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future'' OBIE doesn''t standardise this field ' type: string minLength: 1 maxLength: 500 Path: description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency type: string minLength: 1 maxLength: 500 Url: description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc type: string OB_OtherCodeType1_8: description: Other fee rate type which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_OtherCodeType1_0: type: object additionalProperties: false required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_Rate1_1: description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ OB_OtherCodeType1_3: description: Other Fee type which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_FeeFrequency1Code_1: description: How often is the overdraft fee/charge calculated for the account. type: string enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE OBBCAData1: title: BCA type: object additionalProperties: false properties: ProductDetails: title: ProductDetails type: object additionalProperties: false properties: Segment: title: Segment description: 'Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation https://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to BCA products, they are segmented in relation to different markets that they wish to focus on. ' type: array items: description: 'Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation https://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd With respect to BCA products, they are segmented in relation to different markets that they wish to focus on. ' type: string enum: - ClientAccount - Standard - NonCommercialChaitiesClbSoc - NonCommercialPublicAuthGovt - Religious - SectorSpecific - Startup - Switcher FeeFreeLength: title: FeeFreeLength description: The length/duration of the fee free period type: number format: float FeeFreeLengthPeriod: title: FeeFreeLengthPeriod description: The unit of period (days, weeks, months etc.) of the promotional length type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Optional additional notes to supplement the Core product details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 CreditInterest: title: CreditInterest description: Details about the interest that may be payable to the BCA account holders type: object additionalProperties: false required: - TierBandSet properties: TierBandSet: title: TierBandSet description: The group of tiers or bands for which credit interest can be applied. type: array minItems: 1 items: description: The group of tiers or bands for which credit interest can be applied. type: object properties: TierBandMethod: title: TierBandMethod description: 'The methodology of how credit interest is paid/applied. It can be: 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. 3. Whole The same interest rate is applied irrespective of the BCA balance ' type: string enum: - Banded - Tiered - Whole CalculationMethod: title: CalculationMethod description: Methods of calculating interest type: string enum: - Compound - SimpleInterest Destination: title: Destination description: Describes whether accrued interest is payable only to the BCA or to another bank account type: string enum: - PayAway - SelfCredit Notes: title: Notes description: Optional additional notes to supplement the Tier Band Set details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 TierBand: title: TierBand description: Tier Band Details type: array minItems: 1 items: description: Tier Band Details type: object properties: Identification: title: Identification description: Unique and unambiguous identification of a Tier Band for a BCA. type: string minLength: 1 maxLength: 35 TierValueMinimum: title: TierValueMinimum description: Minimum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMaximum: title: TierValueMaximum description: Maximum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CalculationFrequency: title: CalculationFrequency description: How often is credit interest calculated for the account. type: string enum: - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly ApplicationFrequency: title: ApplicationFrequency description: How often is interest applied to the BCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's BCA. type: string enum: - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly DepositInterestAppliedCoverage: title: DepositInterestAppliedCoverage description: Amount on which Interest applied. type: string enum: - Banded - Tiered - Whole FixedVariableInterestRateType: title: FixedVariableInterestRateType description: Type of interest rate, Fixed or Variable type: string enum: - Fixed - Variable AER: title: AER description: 'The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A ' type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ BankInterestRateType: title: BankInterestRateType description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA. type: string enum: - Gross - Other BankInterestRate: title: BankInterestRate description: Bank Interest for the BCA product type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: title: Notes description: Optional additional notes to supplement the Tier Band details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherBankInterestType: title: OtherBankInterestType description: Other interest rate types which are not available in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherApplicationFrequency: title: OtherApplicationFrequency description: Other application frequencies that are not available in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherCalculationFrequency: title: OtherCalculationFrequency description: Other calculation frequency which is not available in the standard code set. type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - TierValueMinimum - ApplicationFrequency - FixedVariableInterestRateType - AER required: - TierBandMethod - Destination - TierBand Overdraft: title: Overdraft description: Borrowing details type: object additionalProperties: false required: - OverdraftTierBandSet properties: Notes: title: Notes description: Associated Notes about the overdraft rates type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBandSet: title: OverdraftTierBandSet description: Tier band set details type: array minItems: 1 items: description: Tier band set details type: object properties: TierBandMethod: title: TierBandMethod description: 'The methodology of how overdraft is charged. It can be: ''Whole'' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). ''Tiered'' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation. ''Banded'' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. ' type: string enum: - Banded - Tiered - Whole OverdraftType: title: OverdraftType description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. type: string enum: - Committed - OnDemand Identification: title: Identification description: Unique and unambiguous identification of a Tier Band for a overdraft product. type: string minLength: 1 maxLength: 35 AuthorisedIndicator: title: AuthorisedIndicator description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) type: boolean BufferAmount: title: BufferAmount description: 'When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.' type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: title: Notes description: Optional additional notes to supplement the overdraft Tier Band Set details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBand: title: OverdraftTierBand description: Provides overdraft details for a specific tier or band type: array minItems: 1 items: description: Provides overdraft details for a specific tier or band type: object properties: Identification: title: Identification description: Unique and unambiguous identification of a Tier Band for a overdraft. type: string minLength: 1 maxLength: 35 TierValueMin: title: TierValueMin description: Minimum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMax: title: TierValueMax description: Maximum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ EAR: title: EAR description: 'EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft. ' type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ RepresentativeAPR: title: RepresentativeAPR description: An annual percentage rate (APR) is the annual rate charged for borrowing or earned through an investment. APR is expressed as a percentage that represents the actual yearly cost of funds over the term of a loan. This includes any fees or additional costs associated with the transaction but does not take compounding into account. type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ AgreementLengthMin: title: AgreementLengthMin description: Specifies the minimum length of a band for a fixed overdraft agreement type: number format: float AgreementLengthMax: title: AgreementLengthMax description: Specifies the maximum length of a band for a fixed overdraft agreement type: number format: float AgreementPeriod: title: AgreementPeriod description: Specifies the period of a fixed length overdraft agreement type: string enum: - Day - Half Year - Month - Quarter - Week - Year OverdraftInterestChargingCoverage: title: OverdraftInterestChargingCoverage description: 'Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is £2k and the interest tiers are: 0-£500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%*500)+(0.2%*500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the ‘Whole’ of the account balance, and in the 2nd that it is ‘Tiered’.' type: string enum: - Banded - Tiered - Whole BankGuaranteedIndicator: title: BankGuaranteedIndicator description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. type: boolean Notes: title: Notes description: Optional additional notes to supplement the Tier/band details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeesCharges: title: OverdraftFeesCharges description: Overdraft fees and charges type: array items: description: Overdraft fees and charges type: object properties: OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: array items: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans MinMaxType: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: title: OverdraftFeeChargeDetail description: Details about the fees/charges type: array minItems: 1 items: description: Details about the fees/charges type: object properties: FeeType: title: FeeType description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans NegotiableIndicator: title: NegotiableIndicator description: Indicates whether fee and charges are negotiable type: boolean OverdraftControlIndicator: title: OverdraftControlIndicator description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. type: boolean IncrementalBorrowingAmount: title: IncrementalBorrowingAmount description: Every additional tranche of an overdraft balance to which an overdraft fee is applied type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeAmount: title: FeeAmount description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: title: FeeRate description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: title: FeeRateType description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string enum: - Gross - Other ApplicationFrequency: title: ApplicationFrequency description: Frequency at which the overdraft charge is applied to the account type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: title: CalculationFrequency description: How often is the overdraft fee/charge calculated for the account. type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: title: Notes description: Free text for capturing any other info related to Overdraft Fees Charge Details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: array items: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans MinMaxType: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OtherFeeType: title: OtherFeeType description: Other Fee type which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherFeeRateType: title: OtherFeeRateType description: Other fee rate type code which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherApplicationFrequency: title: OtherApplicationFrequency description: Other application frequencies that are not available in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherCalculationFrequency: title: OtherCalculationFrequency description: Other calculation frequency which is not available in the standard code set. type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - FeeType - ApplicationFrequency required: - OverdraftFeeChargeDetail required: - TierValueMin OverdraftFeesCharges: title: OverdraftFeesCharges description: Overdraft fees and charges details type: array items: description: Overdraft fees and charges details type: object properties: OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: array items: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans MinMaxType: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: title: OverdraftFeeChargeDetail description: Details about the fees/charges type: array minItems: 1 items: description: Details about the fees/charges type: object properties: FeeType: title: FeeType description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans NegotiableIndicator: title: NegotiableIndicator description: Indicates whether fee and charges are negotiable type: boolean OverdraftControlIndicator: title: OverdraftControlIndicator description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. type: boolean IncrementalBorrowingAmount: title: IncrementalBorrowingAmount description: Every additional tranche of an overdraft balance to which an overdraft fee is applied type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeAmount: title: FeeAmount description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: title: FeeRate description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: title: FeeRateType description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string enum: - Gross - Other ApplicationFrequency: title: ApplicationFrequency description: Frequency at which the overdraft charge is applied to the account type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: title: CalculationFrequency description: How often is the overdraft fee/charge calculated for the account. type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: title: Notes description: Free text for capturing any other info related to Overdraft Fees Charge Details type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeeChargeCap: title: OverdraftFeeChargeCap description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: array items: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans MinMaxType: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Notes related to Overdraft fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OtherFeeType: title: OtherFeeType description: Other Fee type which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherFeeRateType: title: OtherFeeRateType description: Other fee rate type code which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherApplicationFrequency: title: OtherApplicationFrequency description: Other application frequencies that are not available in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherCalculationFrequency: title: OtherCalculationFrequency description: Other calculation frequency which is not available in the standard code set. type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - FeeType - ApplicationFrequency required: - OverdraftFeeChargeDetail required: - TierBandMethod - OverdraftTierBand OtherFeesCharges: title: OtherFeesCharges description: Contains details of fees and charges which are not associated with either Overdraft or features/benefits type: array items: description: Contains details of fees and charges which are not associated with either Overdraft or features/benefits type: object properties: TariffType: title: TariffType description: TariffType which defines the fee and charges. type: string enum: - Electronic - Mixed - Other TariffName: title: TariffName description: Name of the tariff type: string minLength: 1 maxLength: 350 OtherTariffType: title: OtherTariffType description: Other tariff type which is not in the standard list. type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 FeeChargeDetail: title: FeeChargeDetail description: Other fees/charges details type: array minItems: 1 items: description: Other fees/charges details type: object properties: FeeCategory: title: FeeCategory description: Categorisation of fees and charges into standard categories. type: string enum: - Other - Servicing FeeType: title: FeeType description: Fee/Charge Type type: string enum: - Other - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCAccountFeeQuarterly - ServiceCFixedTariff - ServiceCBusiDepAccBreakage - ServiceCMinimumMonthlyFee - ServiceCOther NegotiableIndicator: title: NegotiableIndicator description: Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: title: FeeAmount description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: title: FeeRate description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: title: FeeRateType description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) type: string enum: - Gross - Other ApplicationFrequency: title: ApplicationFrequency description: How frequently the fee/charge is applied to the account type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: title: CalculationFrequency description: How frequently the fee/charge is calculated type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: title: Notes description: Optional additional notes to supplement the fee/charge details. type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 FeeChargeCap: title: FeeChargeCap description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: array items: description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - Other - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCAccountFeeQuarterly - ServiceCFixedTariff - ServiceCBusiDepAccBreakage - ServiceCMinimumMonthlyFee - ServiceCOther MinMaxType: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Free text for adding extra details for fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OtherFeeCategoryType: title: OtherFeeCategoryType type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherFeeType: title: OtherFeeType description: Other Fee/charge type which is not available in the standard code set type: object additionalProperties: false required: - FeeCategory - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 FeeCategory: title: FeeCategory description: Categorisation of fees and charges into standard categories. type: string enum: - Other - Servicing Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherFeeRateType: title: OtherFeeRateType description: Other fee rate type which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherApplicationFrequency: title: OtherApplicationFrequency description: Other application frequencies not covered in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OtherCalculationFrequency: title: OtherCalculationFrequency description: Other calculation frequency which is not available in standard code set. type: object additionalProperties: false required: - Name - Description properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 FeeApplicableRange: title: FeeApplicableRange description: Range or amounts or rates for which the fee/charge applies type: object additionalProperties: false properties: MinimumAmount: title: MinimumAmount description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MaximumAmount: title: MaximumAmount description: Maximum Amount on which fee is applicable (where it is expressed as an amount) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MinimumRate: title: MinimumRate description: Minimum rate on which fee/charge is applicable(where it is expressed as an rate) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ MaximumRate: title: MaximumRate description: Maximum rate on which fee/charge is applicable(where it is expressed as an rate) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ required: - FeeCategory - FeeType - ApplicationFrequency FeeChargeCap: title: FeeChargeCap description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: array items: description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: object properties: FeeType: title: FeeType description: Fee/charge type which is being capped type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - Other - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCAccountFeeQuarterly - ServiceCFixedTariff - ServiceCBusiDepAccBreakage - ServiceCMinimumMonthlyFee - ServiceCOther MinMaxType: title: MinMaxType description: Min Max type type: string enum: - Minimum - Maximum FeeCapOccurrence: title: FeeCapOccurrence description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: number format: float FeeCapAmount: title: FeeCapAmount description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: title: CappingPeriod description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: title: Notes description: Free text for adding extra details for fee charge cap type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: title: OtherFeeType description: Other fee type code which is not available in the standard code set type: array items: description: Other fee type code which is not available in the standard code set type: object properties: Code: title: Code description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: title: Name description: Long name associated with the code type: string minLength: 1 maxLength: 70 Description: title: Description description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType required: - FeeChargeDetail Description_3: description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OB_OtherFeeChargeDetailType: description: Other Fee/charge type which is not available in the standard code set type: object additionalProperties: false required: - FeeCategory - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' FeeCategory: $ref: '#/components/schemas/OB_FeeCategory1Code' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_FeeFrequency1Code_3: description: How frequently the fee/charge is calculated type: string enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE OB_MinMaxType1Code: description: Min Max type type: string enum: - FMMN - FMMX OB_OtherCodeType1_1: description: Other application frequencies that are not available in the standard code list type: object additionalProperties: false required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_Amount1_0: description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ OB_FeeFrequency1Code_0: description: Frequency at which the overdraft charge is applied to the account type: string enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE OB_OverdraftFeeType1Code: description: Overdraft fee type type: string enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT OBErrorResponse1: description: An array of detail error codes, and messages, and URLs to documentation to help remediation. type: object additionalProperties: false required: - Errors properties: Id: description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. type: string minLength: 1 maxLength: 40 Errors: type: array minItems: 1 items: $ref: '#/components/schemas/OBError1' OB_InterestRateType1Code_1: description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) type: string enum: - INBB - INFR - INGR - INLR - INNE - INOT OB_InterestFixedVariableType1Code: description: Type of interest rate, Fixed or Variable type: string enum: - INFI - INVA OB_OtherCodeType1_7: description: Other calculation frequency which is not available in standard code set. type: object additionalProperties: false required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_Amount1_3: description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ OB_InterestRateType1Code_0: description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) type: string enum: - INBB - INFR - INGR - INLR - INNE - INOT AccountId: description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. type: string minLength: 1 maxLength: 40 OBExternalStatusReason1Code: description: Low level textual error code, for all enum values see `ExternalReason1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string minLength: 4 maxLength: 4 example: AC17 Name_4: description: Long name associated with the code type: string minLength: 1 maxLength: 70 OBSupplementaryData1: type: object properties: {} additionalProperties: true description: Additional information that can not be captured in the structured fields and/or any other specific block. OB_OtherCodeType1_2: description: Other calculation frequency which is not available in the standard code set. type: object additionalProperties: false required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' ISODateTime: description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 ' type: string format: date-time OB_FeeFrequency1Code_4: description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE OBReadProduct2: description: Product details of Other Product which is not avaiable in the standard list type: object additionalProperties: false required: - Data properties: Data: description: Aligning with the read write specs structure. type: object properties: Product: type: array items: type: object description: Product details associated with the Account required: - AccountId - ProductType properties: ProductName: description: The name of the Product used for marketing purposes from a customer perspective. I.e. what the customer would recognise. type: string minLength: 1 maxLength: 350 ProductId: description: Identifier within the parent organisation for the product. Must be unique in the organisation type: string minLength: 1 maxLength: 40 AccountId: $ref: '#/components/schemas/AccountId' SecondaryProductId: description: Any secondary Identification which supports Product Identifier to uniquely identify the current account banking products. type: string minLength: 1 maxLength: 70 ProductType: description: Descriptive code for the product category. If ProductType - Other is chosen, the object OtherProductType must be populated with name, and description. type: string enum: - BusinessCurrentAccount - CommercialCreditCard - Other - PersonalCurrentAccount - SMELoan MarketingStateId: description: Unique and unambiguous identification of a Product Marketing State. type: string minLength: 1 maxLength: 35 OtherProductType: description: Other product type details associated with the account. type: object required: - Name - Description properties: Name: description: Name of Other product type. type: string minLength: 1 maxLength: 350 Description: description: Description of Other product type type: string minLength: 1 maxLength: 350 ProductDetails: type: object properties: Segment: type: array items: description: 'Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another. Read more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd ' type: string enum: - GEAS - GEBA - GEBR - GEBU - GECI - GECS - GEFB - GEFG - GEG - GEGR - GEGS - GEOT - GEOV - GEPA - GEPR - GERE - GEST - GEYA - GEYO - PSCA - PSES - PSNC - PSNP - PSRG - PSSS - PSST - PSSW FeeFreeLength: description: The length/duration of the fee free period type: integer FeeFreeLengthPeriod: description: The unit of period (days, weeks, months etc.) of the promotional length type: string enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER MonthlyMaximumCharge: description: The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: description: Optional additional notes to supplement the Core product details type: string minLength: 1 maxLength: 2000 OtherSegment: $ref: '#/components/schemas/OB_OtherCodeType1_0' CreditInterest: description: Details about the interest that may be payable to the Account holders type: object required: - TierBandSet properties: TierBandSet: type: array minItems: 1 items: type: object description: The group of tiers or bands for which credit interest can be applied. required: - TierBandMethod - Destination - TierBand properties: TierBandMethod: description: 'The methodology of how credit interest is paid/applied. It can be: 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. 3. Whole The same interest rate is applied irrespective of the product holder''s account balance ' type: string enum: - INBA - INTI - INWH CalculationMethod: $ref: '#/components/schemas/OB_InterestCalculationMethod1Code' Destination: description: Describes whether accrued interest is payable only to the BCA or to another bank account type: string enum: - INOT - INPA - INSC Notes: type: array items: description: Optional additional notes to supplement the Tier Band Set details type: string minLength: 1 maxLength: 2000 OtherCalculationMethod: $ref: '#/components/schemas/OB_OtherCodeType1_0' OtherDestination: $ref: '#/components/schemas/OB_OtherCodeType1_0' TierBand: type: array minItems: 1 items: type: object description: Tier Band Details required: - TierValueMinimum - ApplicationFrequency - FixedVariableInterestRateType - AER properties: Identification: description: Unique and unambiguous identification of a Tier Band for the Product. type: string minLength: 1 maxLength: 35 TierValueMinimum: description: Minimum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMaximum: description: Maximum deposit value for which the credit interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CalculationFrequency: description: How often is credit interest calculated for the account. type: string enum: - FQAT - FQDY - FQHY - FQMY - FQOT - FQQY - FQSD - FQWY - FQYY ApplicationFrequency: description: How often is interest applied to the Product for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's account. type: string enum: - FQAT - FQDY - FQHY - FQMY - FQOT - FQQY - FQSD - FQWY - FQYY DepositInterestAppliedCoverage: description: Amount on which Interest applied. type: string enum: - INBA - INTI - INWH FixedVariableInterestRateType: $ref: '#/components/schemas/OB_InterestFixedVariableType1Code' AER: description: 'The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. Read more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A ' type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ BankInterestRateType: description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the account holder's account. type: string enum: - INBB - INFR - INGR - INLR - INNE - INOT BankInterestRate: description: Bank Interest for the product type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: description: Optional additional notes to supplement the Tier Band details type: string minLength: 1 maxLength: 2000 OtherBankInterestType: description: Other interest rate types which are not available in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_1' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_2' Overdraft: description: Borrowing details type: object required: - OverdraftTierBandSet properties: Notes: type: array items: description: Associated Notes about the overdraft rates type: string minLength: 1 maxLength: 2000 OverdraftTierBandSet: type: array minItems: 1 items: type: object description: Tier band set details required: - TierBandMethod - OverdraftTierBand properties: TierBandMethod: description: 'The methodology of how overdraft is charged. It can be: ''Whole'' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). ''Tiered'' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation. ''Banded'' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation. ' type: string enum: - INBA - INTI - INWH OverdraftType: description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. type: string enum: - OVCO - OVOD - OVOT Identification: description: Unique and unambiguous identification of a Tier Band for a overdraft product. type: string minLength: 1 maxLength: 35 AuthorisedIndicator: description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) type: boolean BufferAmount: description: 'When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.' type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: description: Optional additional notes to supplement the overdraft Tier Band Set details type: string minLength: 1 maxLength: 2000 OverdraftTierBand: type: array minItems: 1 items: type: object description: Provides overdraft details for a specific tier or band required: - TierValueMin properties: Identification: description: Unique and unambiguous identification of a Tier Band for a overdraft. type: string minLength: 1 maxLength: 35 TierValueMin: description: Minimum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMax: description: Maximum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ EAR: description: 'EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft. ' type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ AgreementLengthMin: description: Specifies the minimum length of a band for a fixed overdraft agreement type: integer AgreementLengthMax: description: Specifies the maximum length of a band for a fixed overdraft agreement type: integer AgreementPeriod: description: Specifies the period of a fixed length overdraft agreement type: string enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER OverdraftInterestChargingCoverage: description: 'Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is 2k and the interest tiers are: 0-500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%*500)+(0.2%*500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the ''Whole'' of the account balance, and in the 2nd that it is ''Tiered''.' type: string enum: - INBA - INTI - INWH BankGuaranteedIndicator: description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it's part of a government scheme, or whether the rate may vary dependent on the applicant's circumstances. type: boolean Notes: type: array items: description: Optional additional notes to supplement the Tier/band details type: string minLength: 1 maxLength: 2000 OverdraftFeesCharges: type: array items: type: object description: Overdraft fees and charges required: - OverdraftFeeChargeDetail properties: OverdraftFeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. required: - FeeType - MinMaxType properties: FeeType: type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OverdraftFeeChargeDetail: type: array minItems: 1 items: type: object description: Details about the fees/charges required: - FeeType - ApplicationFrequency properties: FeeType: $ref: '#/components/schemas/OB_OverdraftFeeType1Code' NegotiableIndicator: description: Indicates whether fee and charges are negotiable type: boolean OverdraftControlIndicator: description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. type: boolean IncrementalBorrowingAmount: $ref: '#/components/schemas/OB_Amount1_1' FeeAmount: $ref: '#/components/schemas/OB_Amount1_2' FeeRate: $ref: '#/components/schemas/OB_Rate1_0' FeeRateType: $ref: '#/components/schemas/OB_InterestRateType1Code_0' ApplicationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_0' CalculationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_1' Notes: type: array items: description: Free text for capturing any other info related to Overdraft Fees Charge Details type: string minLength: 1 maxLength: 2000 OverdraftFeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. required: - FeeType - MinMaxType properties: FeeType: type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherFeeType: $ref: '#/components/schemas/OB_OtherCodeType1_3' OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_4' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_1' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_2' OverdraftFeesCharges: type: array items: type: object description: Overdraft fees and charges details required: - OverdraftFeeChargeDetail properties: OverdraftFeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. required: - FeeType - MinMaxType properties: FeeType: type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OverdraftFeeChargeDetail: type: array minItems: 1 items: type: object description: Details about the fees/charges required: - FeeType - ApplicationFrequency properties: FeeType: $ref: '#/components/schemas/OB_OverdraftFeeType1Code' NegotiableIndicator: description: Indicates whether fee and charges are negotiable type: boolean OverdraftControlIndicator: description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. type: boolean IncrementalBorrowingAmount: $ref: '#/components/schemas/OB_Amount1_1' FeeAmount: $ref: '#/components/schemas/OB_Amount1_2' FeeRate: $ref: '#/components/schemas/OB_Rate1_0' FeeRateType: $ref: '#/components/schemas/OB_InterestRateType1Code_0' ApplicationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_0' CalculationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_1' Notes: type: array items: description: Free text for capturing any other info related to Overdraft Fees Charge Details type: string minLength: 1 maxLength: 2000 OverdraftFeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. required: - FeeType - MinMaxType properties: FeeType: type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherFeeType: $ref: '#/components/schemas/OB_OtherCodeType1_3' OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_4' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_1' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_2' LoanInterest: description: Details about the interest that may be payable to the SME Loan holders type: object required: - LoanInterestTierBandSet properties: Notes: type: array items: description: Optional additional notes to supplement the LoanInterest type: string minLength: 1 maxLength: 2000 LoanInterestTierBandSet: type: array minItems: 1 items: type: object description: The group of tiers or bands for which debit interest can be applied. required: - TierBandMethod - CalculationMethod - LoanInterestTierBand properties: TierBandMethod: description: 'The methodology of how credit interest is charged. It can be: 1. Banded Interest rates are banded. i.e. Increasing rate on whole balance as balance increases. 2. Tiered Interest rates are tiered. i.e. increasing rate for each tier as balance increases, but interest paid on tier fixed for that tier and not on whole balance. 3. Whole The same interest rate is applied irrespective of the SME Loan balance ' type: string enum: - INBA - INTI - INWH Identification: description: Loan interest tierbandset identification. Used by loan providers for internal use purpose. type: string minLength: 1 maxLength: 35 CalculationMethod: $ref: '#/components/schemas/OB_InterestCalculationMethod1Code' Notes: type: array items: description: Optional additional notes to supplement the Tier Band Set details type: string minLength: 1 maxLength: 2000 OtherCalculationMethod: $ref: '#/components/schemas/OB_OtherCodeType1_0' LoanInterestTierBand: type: array minItems: 1 items: type: object description: Tier Band Details required: - TierValueMinimum - TierValueMinTerm - MinTermPeriod - FixedVariableInterestRateType - RepAPR properties: Identification: description: Unique and unambiguous identification of a Tier Band for a SME Loan. type: string minLength: 1 maxLength: 35 TierValueMinimum: description: Minimum loan value for which the loan interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMaximum: description: Maximum loan value for which the loan interest tier applies. type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMinTerm: description: Minimum loan term for which the loan interest tier applies. type: integer MinTermPeriod: description: The unit of period (days, weeks, months etc.) of the Minimum Term type: string enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER TierValueMaxTerm: description: Maximum loan term for which the loan interest tier applies. type: integer MaxTermPeriod: description: The unit of period (days, weeks, months etc.) of the Maximum Term type: string enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER FixedVariableInterestRateType: $ref: '#/components/schemas/OB_InterestFixedVariableType1Code' RepAPR: description: 'The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. For SME Loan, this APR is the representative APR which includes any account fees. ' type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ LoanProviderInterestRateType: description: Interest rate types, other than APR, which financial institutions may use to describe the annual interest rate payable for the SME Loan. type: string enum: - INBB - INFR - INGR - INLR - INNE - INOT LoanProviderInterestRate: description: Loan provider Interest for the SME Loan product type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: description: Optional additional notes to supplement the Tier Band details type: string minLength: 1 maxLength: 2000 OtherLoanProviderInterestRateType: description: Other loan interest rate types which are not available in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' LoanInterestFeesCharges: type: array items: type: object description: Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits required: - LoanInterestFeeChargeDetail properties: LoanInterestFeeChargeDetail: type: array minItems: 1 items: type: object description: Other fees/charges details required: - FeeType - ApplicationFrequency - CalculationFrequency properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: description: Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: $ref: '#/components/schemas/OB_Amount1_3' FeeRate: $ref: '#/components/schemas/OB_Rate1_1' FeeRateType: $ref: '#/components/schemas/OB_InterestRateType1Code_1' ApplicationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_2' CalculationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_3' Notes: type: array items: description: Optional additional notes to supplement the fee/charge details. type: string minLength: 1 maxLength: 2000 OtherFeeType: $ref: '#/components/schemas/OB_OtherFeeChargeDetailType' OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_5' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_6' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_7' LoanInterestFeeChargeCap: type: array items: type: object description: Details about any caps (minimum/maximum charges) that apply to a particular fee/charge required: - FeeType - MinMaxType properties: FeeType: type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: '#/components/schemas/OB_FeeFrequency1Code_4' Notes: type: array items: description: Free text for adding extra details for fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' LoanInterestFeesCharges: type: array items: type: object description: Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits required: - LoanInterestFeeChargeDetail properties: LoanInterestFeeChargeDetail: type: array minItems: 1 items: type: object description: Other fees/charges details required: - FeeType - ApplicationFrequency - CalculationFrequency properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: description: Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: $ref: '#/components/schemas/OB_Amount1_3' FeeRate: $ref: '#/components/schemas/OB_Rate1_1' FeeRateType: $ref: '#/components/schemas/OB_InterestRateType1Code_1' ApplicationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_2' CalculationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_3' Notes: type: array items: description: Optional additional notes to supplement the fee/charge details. type: string minLength: 1 maxLength: 2000 OtherFeeType: $ref: '#/components/schemas/OB_OtherFeeChargeDetailType' OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_5' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_6' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_7' LoanInterestFeeChargeCap: type: array items: type: object description: Details about any caps (minimum/maximum charges) that apply to a particular fee/charge required: - FeeType - MinMaxType properties: FeeType: type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: '#/components/schemas/OB_FeeFrequency1Code_4' Notes: type: array items: description: Free text for adding extra details for fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' Repayment: description: Repayment details of the Loan product type: object properties: RepaymentType: description: Repayment type type: string enum: - USBA - USBU - USCI - USCS - USER - USFA - USFB - USFI - USIO - USOT - USPF - USRW - USSL RepaymentFrequency: description: Repayment frequency type: string enum: - SMDA - SMFL - SMFO - SMHY - SMMO - SMOT - SMQU - SMWE - SMYE AmountType: description: The repayment is for paying just the interest only or both interest and capital or bullet amount or balance to date etc type: string enum: - RABD - RABL - RACI - RAFC - RAIO - RALT - USOT Notes: type: array items: description: Optional additional notes to supplement the Repayment type: string minLength: 1 maxLength: 2000 OtherRepaymentType: description: Other repayment type which is not in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherRepaymentFrequency: description: Other repayment frequency which is not in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherAmountType: description: Other amount type which is not in the standard code list type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' RepaymentFeeCharges: description: Applicable fee/charges for repayment such as prepayment, full early repayment or non repayment. type: object required: - RepaymentFeeChargeDetail properties: RepaymentFeeChargeDetail: type: array minItems: 1 items: type: object description: Details about specific fees/charges that are applied for repayment required: - FeeType - ApplicationFrequency - CalculationFrequency properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: description: Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: $ref: '#/components/schemas/OB_Amount1_3' FeeRate: $ref: '#/components/schemas/OB_Rate1_1' FeeRateType: $ref: '#/components/schemas/OB_InterestRateType1Code_1' ApplicationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_2' CalculationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_3' Notes: type: array items: description: Optional additional notes to supplement the fee/charge details. type: string minLength: 1 maxLength: 2000 OtherFeeType: $ref: '#/components/schemas/OB_OtherFeeChargeDetailType' OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_8' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_6' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_7' RepaymentFeeChargeCap: type: array items: type: object description: RepaymentFeeChargeCap sets daily, weekly, monthly, yearly limits on the fees that are charged required: - FeeType - MinMaxType properties: FeeType: type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Free text for adding extra details for fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' RepaymentHoliday: type: array items: type: object description: Details of capital repayment holiday if any properties: MaxHolidayLength: description: The maximum length/duration of a Repayment Holiday type: integer MaxHolidayPeriod: description: The unit of period (days, weeks, months etc.) of the repayment holiday type: string enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER Notes: type: array items: description: Free text for adding details for repayment holiday type: string minLength: 1 maxLength: 2000 OtherFeesCharges: type: array items: type: object description: Contains details of fees and charges which are not associated with either Overdraft or features/benefits required: - FeeChargeDetail properties: TariffType: description: TariffType which defines the fee and charges. type: string enum: - TTEL - TTMX - TTOT TariffName: description: Name of the tariff type: string minLength: 1 maxLength: 350 OtherTariffType: description: Other tariff type which is not in the standard list. type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' FeeChargeDetail: type: array minItems: 1 items: type: object description: Other fees/charges details required: - FeeCategory - FeeType - ApplicationFrequency properties: FeeCategory: $ref: '#/components/schemas/OB_FeeCategory1Code' FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: description: Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: $ref: '#/components/schemas/OB_Amount1_3' FeeRate: $ref: '#/components/schemas/OB_Rate1_1' FeeRateType: $ref: '#/components/schemas/OB_InterestRateType1Code_1' ApplicationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_2' CalculationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_3' Notes: type: array items: description: Optional additional notes to supplement the fee/charge details. type: string minLength: 1 maxLength: 2000 FeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge required: - FeeType - MinMaxType properties: FeeType: type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Free text for adding extra details for fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherFeeCategoryType: $ref: '#/components/schemas/OB_OtherCodeType1_0' OtherFeeType: $ref: '#/components/schemas/OB_OtherFeeChargeDetailType' OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_8' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_6' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_7' FeeApplicableRange: description: Range or amounts or rates for which the fee/charge applies type: object properties: MinimumAmount: description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MaximumAmount: description: Maximum Amount on which fee is applicable (where it is expressed as an amount) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MinimumRate: description: Minimum rate on which fee/charge is applicable(where it is expressed as an rate) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ MaximumRate: description: Maximum rate on which fee/charge is applicable(where it is expressed as an rate) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge required: - FeeType - MinMaxType properties: FeeType: type: array minItems: 1 items: description: Fee/charge type which is being capped type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Free text for adding extra details for fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: type: object description: Other fee type code which is not available in the standard code set required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' BCA: $ref: '#/components/schemas/OBBCAData1' PCA: $ref: '#/components/schemas/OBPCAData1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OB_FeeType1Code: description: Fee/Charge Type type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX OB_Period1Code: description: Period e.g. day, week, month etc. for which the fee/charge is capped type: string enum: - PACT - PDAY - PHYR - PMTH - PQTR - PWEK - PYER OB_OtherCodeType1_4: description: Other fee rate type code which is not available in the standard code set type: object additionalProperties: false required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OB_CodeMnemonic: description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ OB_OtherCodeType1_5: description: Other fee rate type which is not in the standard rate type list type: object additionalProperties: false required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' parameters: AccountId: name: AccountId in: path description: AccountId required: true schema: type: string 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 x-fapi-auth-date: name: x-fapi-auth-date in: header description: 'The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC ' required: false schema: type: string pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$ 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 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 responses: 404Error: description: Not found headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 200AccountsAccountIdProductRead: description: Products Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBReadProduct2' 400Error: description: Bad request headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' 503Error: description: Service temporary unavailable headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' 406Error: description: Not Acceptable headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 403Error: description: Forbidden headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait required: true schema: type: integer x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 500Error: description: Internal Server Error headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' 401Error: description: Unauthorized headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT