openapi: 3.0.0 info: title: Account and Transaction API Specification Account Access Consents Products API description: 'Swagger for Account and Transaction API Specification. **Please Note**: There are no optional fields, if a field is not marked as “Required” it is a Conditional field. ' termsOfService: https://www.openbanking.org.uk/terms contact: name: Service Desk email: ServiceDesk@openbanking.org.uk license: name: open-licence url: https://www.openbanking.org.uk/open-licence version: 4.0.1 servers: - url: /open-banking/v4.0/aisp tags: - name: Products paths: /accounts/{AccountId}/product: get: tags: - Products summary: Get Product for an AccountId description: Enables an AISP to retrieve the account product information for a specific PSU account. operationId: GetAccountsAccountIdProduct parameters: - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-client-id' 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' security: - PSUOAuth2Security: - accounts /products: get: tags: - Products summary: Get Products description: Enables an AISP to retrieve the account product information for account(s) that the PSU has consented to. operationId: GetProducts parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-client-id' responses: '200': $ref: '#/components/responses/200ProductsRead' '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' security: - PSUOAuth2Security: - accounts components: schemas: 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_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_OverdraftFeeType1Code: description: Overdraft fee type type: string enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT OB_Amount1_0: description: Cap amount charged for a fee/charge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Meta: title: MetaData type: object description: Meta Data relevant to the payload properties: TotalPages: type: integer format: int32 FirstAvailableDateTime: $ref: '#/components/schemas/ISODateTime' LastAvailableDateTime: $ref: '#/components/schemas/ISODateTime' additionalProperties: false 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_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_InterestCalculationMethod1Code: description: Methods of calculating interest type: string enum: - ITCO - ITOT - ITSI OBError1: type: object 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'' OBL doesn''t standardise this field' type: string minLength: 1 maxLength: 500 Path: description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency type: string minLength: 1 maxLength: 500 Url: description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc type: string required: - ErrorCode additionalProperties: false minProperties: 1 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 OBBCAData1: type: object title: BCA properties: ProductDetails: type: object title: ProductDetails properties: Segment: description: "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nWith respect to BCA products, they are segmented in relation to different markets that they wish to focus on. " title: Segment type: array items: description: "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nWith respect to BCA products, they are segmented in relation to different markets that they wish to focus on. " type: string enum: - ClientAccount - Standard - NonCommercialChaitiesClbSoc - NonCommercialPublicAuthGovt - Religious - SectorSpecific - Startup - Switcher FeeFreeLength: description: The length/duration of the fee free period title: FeeFreeLength type: number format: float FeeFreeLengthPeriod: description: The unit of period (days, weeks, months etc.) of the promotional length title: FeeFreeLengthPeriod type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: description: Optional additional notes to supplement the Core product details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 additionalProperties: false CreditInterest: description: Details about the interest that may be payable to the BCA account holders type: object title: CreditInterest properties: TierBandSet: description: The group of tiers or bands for which credit interest can be applied. type: array title: TierBandSet items: description: The group of tiers or bands for which credit interest can be applied. type: object properties: TierBandMethod: description: 'The methodology of how credit interest is paid/applied. It can be:- 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' title: TierBandMethod type: string enum: - Banded - Tiered - Whole CalculationMethod: description: Methods of calculating interest title: CalculationMethod type: string enum: - Compound - SimpleInterest Destination: description: Describes whether accrued interest is payable only to the BCA or to another bank account title: Destination type: string enum: - PayAway - SelfCredit Notes: description: Optional additional notes to supplement the Tier Band Set details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 TierBand: description: Tier Band Details type: array title: TierBand items: description: Tier Band Details type: object properties: Identification: description: Unique and unambiguous identification of a Tier Band for a BCA. title: Identification type: string minLength: 1 maxLength: 35 TierValueMinimum: description: Minimum deposit value for which the credit interest tier applies. title: TierValueMinimum type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMaximum: description: Maximum deposit value for which the credit interest tier applies. title: TierValueMaximum type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CalculationFrequency: description: How often is credit interest calculated for the account. title: CalculationFrequency type: string enum: - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly ApplicationFrequency: description: How often is interest applied to the BCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's BCA. title: ApplicationFrequency type: string enum: - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly DepositInterestAppliedCoverage: description: Amount on which Interest applied. title: DepositInterestAppliedCoverage type: string enum: - Banded - Tiered - Whole FixedVariableInterestRateType: description: Type of interest rate, Fixed or Variable title: FixedVariableInterestRateType type: string enum: - Fixed - Variable AER: description: "The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. \nRead more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A" title: AER type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ BankInterestRateType: description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA. title: BankInterestRateType type: string enum: - Gross - Other BankInterestRate: description: Bank Interest for the BCA product title: BankInterestRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: description: Optional additional notes to supplement the Tier Band details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherBankInterestType: description: Other interest rate types which are not available in the standard code list type: object title: OtherBankInterestType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherApplicationFrequency: description: Other application frequencies that are not available in the standard code list type: object title: OtherApplicationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherCalculationFrequency: description: Other calculation frequency which is not available in the standard code set. type: object title: OtherCalculationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description required: - TierValueMinimum - ApplicationFrequency - FixedVariableInterestRateType - AER minItems: 1 required: - TierBandMethod - Destination - TierBand minItems: 1 additionalProperties: false required: - TierBandSet Overdraft: description: Borrowing details type: object title: Overdraft properties: Notes: description: Associated Notes about the overdraft rates title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBandSet: description: Tier band set details type: array title: OverdraftTierBandSet items: description: Tier band set details type: object properties: TierBandMethod: description: "The methodology of how overdraft is charged. It can be:\n'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). \n'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation\n'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation." title: TierBandMethod type: string enum: - Banded - Tiered - Whole OverdraftType: description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. title: OverdraftType type: string enum: - Committed - OnDemand Identification: description: Unique and unambiguous identification of a Tier Band for a overdraft product. title: Identification type: string minLength: 1 maxLength: 35 AuthorisedIndicator: description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) title: AuthorisedIndicator type: boolean BufferAmount: description: 'When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.' title: BufferAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: description: Optional additional notes to supplement the overdraft Tier Band Set details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBand: description: Provides overdraft details for a specific tier or band type: array title: OverdraftTierBand items: description: Provides overdraft details for a specific tier or band type: object properties: Identification: description: Unique and unambiguous identification of a Tier Band for a overdraft. title: Identification type: string minLength: 1 maxLength: 35 TierValueMin: description: Minimum value of Overdraft Tier/Band title: TierValueMin type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMax: description: Maximum value of Overdraft Tier/Band title: TierValueMax type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ EAR: description: 'EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.' title: EAR type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ 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. title: RepresentativeAPR type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ AgreementLengthMin: description: Specifies the minimum length of a band for a fixed overdraft agreement title: AgreementLengthMin type: number format: float AgreementLengthMax: description: Specifies the maximum length of a band for a fixed overdraft agreement title: AgreementLengthMax type: number format: float AgreementPeriod: description: Specifies the period of a fixed length overdraft agreement title: AgreementPeriod type: string enum: - Day - Half Year - Month - Quarter - Week - Year OverdraftInterestChargingCoverage: description: Refers to which interest rate is applied when interests are tiered. For example, if an overdraft balance is £2k and the interest tiers are:- 0-£500 0.1%, 500-1000 0.2%, 1000-10000 0.5%, then the applicable interest rate could either be 0.5% of the entire balance (since the account balance sits in the top interest tier) or (0.1%*500)+(0.2%*500)+(0.5%*1000). In the 1st situation, we say the interest is applied to the ‘Whole’ of the account balance, and in the 2nd that it is ‘Tiered’. title: OverdraftInterestChargingCoverage type: string enum: - Banded - Tiered - Whole BankGuaranteedIndicator: description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. title: BankGuaranteedIndicator type: boolean Notes: description: Optional additional notes to supplement the Tier/band details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeesCharges: description: Overdraft fees and charges type: array title: OverdraftFeesCharges items: description: Overdraft fees and charges type: object properties: OverdraftFeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: array title: OverdraftFeeChargeCap items: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: object properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans minItems: 1 MinMaxType: description: Min Max type title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: description: Notes related to Overdraft fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: description: Details about the fees/charges type: array title: OverdraftFeeChargeDetail items: description: Details about the fees/charges type: object properties: FeeType: description: Overdraft fee type title: FeeType type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans NegotiableIndicator: description: Indicates whether fee and charges are negotiable title: NegotiableIndicator type: boolean OverdraftControlIndicator: description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. title: OverdraftControlIndicator type: boolean IncrementalBorrowingAmount: description: Every additional tranche of an overdraft balance to which an overdraft fee is applied title: IncrementalBorrowingAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeAmount: description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) title: FeeAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) title: FeeRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) title: FeeRateType type: string enum: - Gross - Other ApplicationFrequency: description: Frequency at which the overdraft charge is applied to the account title: ApplicationFrequency type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: description: How often is the overdraft fee/charge calculated for the account. title: CalculationFrequency type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: description: Free text for capturing any other info related to Overdraft Fees Charge Details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: array title: OverdraftFeeChargeCap items: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: object properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans minItems: 1 MinMaxType: description: Min Max type title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: description: Notes related to Overdraft fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OtherFeeType: description: Other Fee type which is not available in the standard code set type: object title: OtherFeeType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherFeeRateType: description: Other fee rate type code which is not available in the standard code set type: object title: OtherFeeRateType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherApplicationFrequency: description: Other application frequencies that are not available in the standard code list type: object title: OtherApplicationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherCalculationFrequency: description: Other calculation frequency which is not available in the standard code set. type: object title: OtherCalculationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description required: - FeeType - ApplicationFrequency minItems: 1 required: - OverdraftFeeChargeDetail required: - TierValueMin minItems: 1 OverdraftFeesCharges: description: Overdraft fees and charges details type: array title: OverdraftFeesCharges items: description: Overdraft fees and charges details type: object properties: OverdraftFeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: array title: OverdraftFeeChargeCap items: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: object properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans minItems: 1 MinMaxType: description: Min Max type title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: description: Notes related to Overdraft fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: description: Details about the fees/charges type: array title: OverdraftFeeChargeDetail items: description: Details about the fees/charges type: object properties: FeeType: description: Overdraft fee type title: FeeType type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans NegotiableIndicator: description: Indicates whether fee and charges are negotiable title: NegotiableIndicator type: boolean OverdraftControlIndicator: description: Indicates if the fee/charge is already covered by an 'Overdraft Control' fee or not. title: OverdraftControlIndicator type: boolean IncrementalBorrowingAmount: description: Every additional tranche of an overdraft balance to which an overdraft fee is applied title: IncrementalBorrowingAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeAmount: description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) title: FeeAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) title: FeeRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) title: FeeRateType type: string enum: - Gross - Other ApplicationFrequency: description: Frequency at which the overdraft charge is applied to the account title: ApplicationFrequency type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: description: How often is the overdraft fee/charge calculated for the account. title: CalculationFrequency type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: description: Free text for capturing any other info related to Overdraft Fees Charge Details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: array title: OverdraftFeeChargeCap items: description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. type: object properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - AnnualReview - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans minItems: 1 MinMaxType: description: Min Max type title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances. title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: description: Notes related to Overdraft fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OtherFeeType: description: Other Fee type which is not available in the standard code set type: object title: OtherFeeType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherFeeRateType: description: Other fee rate type code which is not available in the standard code set type: object title: OtherFeeRateType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherApplicationFrequency: description: Other application frequencies that are not available in the standard code list type: object title: OtherApplicationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherCalculationFrequency: description: Other calculation frequency which is not available in the standard code set. type: object title: OtherCalculationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description required: - FeeType - ApplicationFrequency minItems: 1 required: - OverdraftFeeChargeDetail required: - TierBandMethod - OverdraftTierBand minItems: 1 additionalProperties: false required: - OverdraftTierBandSet OtherFeesCharges: description: Contains details of fees and charges which are not associated with either Overdraft or features/benefits type: array title: OtherFeesCharges items: description: Contains details of fees and charges which are not associated with either Overdraft or features/benefits type: object properties: TariffType: description: TariffType which defines the fee and charges. title: TariffType type: string enum: - Electronic - Mixed - Other TariffName: description: Name of the tariff title: TariffName type: string minLength: 1 maxLength: 350 OtherTariffType: description: Other tariff type which is not in the standard list. type: object title: OtherTariffType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description FeeChargeDetail: description: Other fees/charges details type: array title: FeeChargeDetail items: description: Other fees/charges details type: object properties: FeeCategory: description: Categorisation of fees and charges into standard categories. title: FeeCategory type: string enum: - Other - Servicing FeeType: description: Fee/Charge Type title: FeeType type: string enum: - Other - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCAccountFeeQuarterly - ServiceCFixedTariff - ServiceCBusiDepAccBreakage - ServiceCMinimumMonthlyFee - ServiceCOther NegotiableIndicator: description: Fee/charge which is usually negotiable rather than a fixed amount title: NegotiableIndicator type: boolean FeeAmount: description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) title: FeeAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) title: FeeRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) title: FeeRateType type: string enum: - Gross - Other ApplicationFrequency: description: How frequently the fee/charge is applied to the account title: ApplicationFrequency type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: description: How frequently the fee/charge is calculated title: CalculationFrequency type: string enum: - OnClosing - OnOpening - ChargingPeriod - Daily - PerItem - Monthly - OnAnniversary - Other - PerHundredPounds - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: description: Optional additional notes to supplement the fee/charge details. title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 FeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: array title: FeeChargeCap items: description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: object properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Fee/charge type which is being capped type: string enum: - Other - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCAccountFeeQuarterly - ServiceCFixedTariff - ServiceCBusiDepAccBreakage - ServiceCMinimumMonthlyFee - ServiceCOther minItems: 1 MinMaxType: description: Min Max type title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: description: Free text for adding extra details for fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OtherFeeCategoryType: type: object title: OtherFeeCategoryType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherFeeType: description: Other Fee/charge type which is not available in the standard code set type: object title: OtherFeeType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 FeeCategory: description: Categorisation of fees and charges into standard categories. title: FeeCategory type: string enum: - Other - Servicing Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - FeeCategory - Name - Description OtherFeeRateType: description: Other fee rate type which is not available in the standard code set type: object title: OtherFeeRateType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherApplicationFrequency: description: Other application frequencies not covered in the standard code list type: object title: OtherApplicationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherCalculationFrequency: description: Other calculation frequency which is not available in standard code set. type: object title: OtherCalculationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description FeeApplicableRange: description: Range or amounts or rates for which the fee/charge applies type: object title: FeeApplicableRange properties: MinimumAmount: description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) title: MinimumAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MaximumAmount: description: Maximum Amount on which fee is applicable (where it is expressed as an amount) title: MaximumAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MinimumRate: description: Minimum rate on which fee/charge is applicable(where it is expressed as a rate) title: MinimumRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ MaximumRate: description: Maximum rate on which fee/charge is applicable(where it is expressed as a rate) title: MaximumRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ additionalProperties: false required: - FeeCategory - FeeType - ApplicationFrequency minItems: 1 FeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: array title: FeeChargeCap items: description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge type: object properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Fee/charge type which is being capped type: string enum: - Other - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCAccountFeeQuarterly - ServiceCFixedTariff - ServiceCBusiDepAccBreakage - ServiceCMinimumMonthlyFee - ServiceCOther minItems: 1 MinMaxType: description: Min Max type title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - Day - Half Year - Month - Quarter - Week - Year Notes: description: Free text for adding extra details for fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType required: - FeeChargeDetail additionalProperties: false AccountId: description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. type: string example: '22289' minLength: 1 maxLength: 40 OB_OtherCodeType1_5: type: object required: - Name - Description description: Other fee rate type which is not in the standard rate type list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' additionalProperties: false 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_MinMaxType1Code: description: Min Max type type: string enum: - FMMN - FMMX OB_OtherCodeType1_7: type: object required: - Name - Description description: Other calculation frequency which is not available in standard code set. properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' additionalProperties: false OB_FeeCategory1Code: description: Categorisation of fees and charges into standard categories. type: string enum: - FCOT - FCRE - FCSV 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 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 OBExternalStatusReason1Code: description: Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string minLength: 4 maxLength: 4 example: U001 OB_Amount1_2: description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ OB_OtherCodeType1_2: type: object required: - Name - Description description: Other calculation frequency which is not available in the standard code set. properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' additionalProperties: false OB_OtherCodeType1_1: type: object required: - Name - Description description: Other application frequencies that are not available in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' additionalProperties: false 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_OtherCodeType1_8: type: object required: - Name - Description description: Other fee rate type which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' additionalProperties: false 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 OBReadProduct2: type: object required: - Data description: Product details of Other Product which is not available in the standard list properties: Data: type: object description: Aligning with the read write specs structure. properties: Product: type: array items: type: object description: Product details associated with the Account 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 example: 321 Product minLength: 1 maxLength: 350 ProductId: description: Identifier within the parent organisation for the product. Must be unique in the organisation type: string example: 51B 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 example: CA78 minLength: 1 maxLength: 70 ProductType: description: Descriptive code for the product category. For a full list refer to `OBInternalProductType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)

If ProductType - "Other" is chosen, the object OtherProductType must be populated with name, and description. type: string example: PersonalCurrentAccount enum: - BusinessCurrentAccount - CommercialCreditCard - Other - PersonalCurrentAccount - SMELoan MarketingStateId: description: Unique and unambiguous identification of a Product Marketing State. type: string example: '22878123' minLength: 1 maxLength: 35 OtherProductType: type: object required: - Name - Description description: This field provides extension to the ProductType enumeration. If ProductType - "Other" is chosen, this field must be populated with name, and description for ASPSP specific product type. properties: Name: description: Name of "Other" product type. type: string example: e-Wallet minLength: 1 maxLength: 350 Description: description: Description of "Other" product type type: string example: Virtual wallet 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: type: object required: - TierBandSet description: Details about the interest that may be payable to the Account holders properties: TierBandSet: type: array items: type: object description: The group of tiers or bands for which credit interest can be applied. required: - TierBandMethod - Destination - TierBand properties: TierBandMethod: description: 'The methodology of how credit interest is paid/applied. It can be:- 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 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. \nRead more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A" type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ BankInterestRateType: description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the account holder's account. type: string enum: - INBB - INFR - INGR - INLR - INNE - INOT BankInterestRate: description: Bank Interest for the product type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: description: Optional additional notes to supplement the Tier Band details type: string minLength: 1 maxLength: 2000 OtherBankInterestType: type: object required: - Name - Description description: Other interest rate types which are not available in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_1' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_2' minItems: 1 minItems: 1 Overdraft: type: object required: - OverdraftTierBandSet description: Borrowing details properties: Notes: type: array items: description: Associated Notes about the overdraft rates type: string minLength: 1 maxLength: 2000 OverdraftTierBandSet: type: array items: type: object description: Tier band set details required: - TierBandMethod - OverdraftTierBand properties: TierBandMethod: description: "The methodology of how overdraft is charged. It can be:\n'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). \n'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation\n'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation." type: string enum: - INBA - INTI - INWH OverdraftType: description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. type: string enum: - OVCO - OVOD - OVOT Identification: description: Unique and unambiguous identification of a Tier Band for a overdraft product. type: string minLength: 1 maxLength: 35 AuthorisedIndicator: description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) type: boolean BufferAmount: description: 'When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.' type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: description: Optional additional notes to supplement the overdraft Tier Band Set details type: string minLength: 1 maxLength: 2000 OverdraftTierBand: type: array items: type: object description: Provides overdraft details for a specific tier or band required: - TierValueMin properties: Identification: description: Unique and unambiguous identification of a Tier Band for a overdraft. type: string minLength: 1 maxLength: 35 TierValueMin: description: Minimum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMax: description: Maximum value of Overdraft Tier/Band type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ EAR: description: 'EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently 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 items: description: Fee/charge type which is being capped type: string enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT minItems: 1 MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: 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 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 items: description: Fee/charge type which is being capped type: string enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT minItems: 1 MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: 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' minItems: 1 minItems: 1 OverdraftFeesCharges: type: array items: type: object description: Overdraft fees and charges details required: - OverdraftFeeChargeDetail properties: OverdraftFeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate. required: - FeeType - MinMaxType properties: FeeType: type: array items: description: Fee/charge type which is being capped type: string enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT minItems: 1 MinMaxType: $ref: '#/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 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 items: description: Fee/charge type which is being capped type: string enum: - FBAO - FBAR - FBEB - FBIT - FBOR - FBOS - FBSC - FBTO - FBUB - FBUT - FTOT - FTUT minItems: 1 MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_0' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_0' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Notes related to Overdraft fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: 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' minItems: 1 minItems: 1 LoanInterest: type: object required: - LoanInterestTierBandSet description: Details about the interest that may be payable to the SME Loan holders properties: Notes: type: array items: description: Optional additional notes to supplement the LoanInterest type: string minLength: 1 maxLength: 2000 LoanInterestTierBandSet: type: array items: type: object description: The group of tiers or bands for which debit interest can be applied. required: - TierBandMethod - CalculationMethod - LoanInterestTierBand properties: TierBandMethod: description: 'The methodology of how credit interest is charged. It can be:- 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 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. \nFor SME Loan, this APR is the representative APR which includes any account fees." type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ LoanProviderInterestRateType: description: Interest rate types, other than APR, which financial institutions may use to describe the annual interest rate payable for the SME Loan. type: string enum: - INBB - INFR - INGR - INLR - INNE - INOT LoanProviderInterestRate: description: Loan provider Interest for the SME Loan product type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: type: array items: description: Optional additional notes to supplement the Tier Band details type: string minLength: 1 maxLength: 2000 OtherLoanProviderInterestRateType: type: object required: - Name - Description description: Other loan interest rate types which are not available in the standard code list properties: Code: $ref: '#/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 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' minItems: 1 LoanInterestFeeChargeCap: type: array items: type: object description: Details about any caps (minimum/maximum charges) that apply to a particular fee/charge required: - FeeType - MinMaxType properties: FeeType: type: array items: description: Fee/charge type which is being capped type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX minItems: 1 MinMaxType: $ref: '#/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' minItems: 1 LoanInterestFeesCharges: type: array items: type: object description: Contains details of fees and charges which are not associated with either LoanRepayment or features/benefits required: - LoanInterestFeeChargeDetail properties: LoanInterestFeeChargeDetail: type: array items: type: object description: Other fees/charges details required: - FeeType - ApplicationFrequency - CalculationFrequency properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: description: Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: $ref: '#/components/schemas/OB_Amount1_3' FeeRate: $ref: '#/components/schemas/OB_Rate1_1' FeeRateType: $ref: '#/components/schemas/OB_InterestRateType1Code_1' ApplicationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_2' CalculationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_3' Notes: type: array items: description: Optional additional notes to supplement the fee/charge details. type: string minLength: 1 maxLength: 2000 OtherFeeType: $ref: '#/components/schemas/OB_OtherFeeChargeDetailType' OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_5' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_6' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_7' minItems: 1 LoanInterestFeeChargeCap: type: array items: type: object description: Details about any caps (minimum/maximum charges) that apply to a particular fee/charge required: - FeeType - MinMaxType properties: FeeType: type: array items: description: Fee/charge type which is being capped type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX minItems: 1 MinMaxType: $ref: '#/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' minItems: 1 Repayment: type: object description: Repayment details of the Loan product properties: RepaymentType: description: Repayment type type: string enum: - USBA - USBU - USCI - USCS - USER - USFA - USFB - USFI - USIO - USOT - USPF - USRW - USSL RepaymentFrequency: description: Repayment frequency type: string enum: - SMDA - SMFL - SMFO - SMHY - SMMO - SMOT - SMQU - SMWE - SMYE AmountType: description: The repayment is for paying just the interest only or both interest and capital or bullet amount or balance to date etc type: string enum: - RABD - RABL - RACI - RAFC - RAIO - RALT - USOT Notes: type: array items: description: Optional additional notes to supplement the Repayment type: string minLength: 1 maxLength: 2000 OtherRepaymentType: type: object required: - Name - Description description: Other repayment type which is not in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherRepaymentFrequency: type: object required: - Name - Description description: Other repayment frequency which is not in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' OtherAmountType: type: object required: - Name - Description description: Other amount type which is not in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' RepaymentFeeCharges: type: object required: - RepaymentFeeChargeDetail description: Applicable fee/charges for repayment such as prepayment, full early repayment or non repayment. properties: RepaymentFeeChargeDetail: type: array items: type: object description: Details about specific fees/charges that are applied for repayment required: - FeeType - ApplicationFrequency - CalculationFrequency properties: FeeType: $ref: '#/components/schemas/OB_FeeType1Code' NegotiableIndicator: description: Fee/charge which is usually negotiable rather than a fixed amount type: boolean FeeAmount: $ref: '#/components/schemas/OB_Amount1_3' FeeRate: $ref: '#/components/schemas/OB_Rate1_1' FeeRateType: $ref: '#/components/schemas/OB_InterestRateType1Code_1' ApplicationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_2' CalculationFrequency: $ref: '#/components/schemas/OB_FeeFrequency1Code_3' Notes: type: array items: description: Optional additional notes to supplement the fee/charge details. type: string minLength: 1 maxLength: 2000 OtherFeeType: $ref: '#/components/schemas/OB_OtherFeeChargeDetailType' OtherFeeRateType: $ref: '#/components/schemas/OB_OtherCodeType1_8' OtherApplicationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_6' OtherCalculationFrequency: $ref: '#/components/schemas/OB_OtherCodeType1_7' minItems: 1 RepaymentFeeChargeCap: type: array items: type: object description: RepaymentFeeChargeCap sets daily, weekly, monthly, yearly limits on the fees that are charged required: - FeeType - MinMaxType properties: FeeType: type: array items: description: Fee/charge type which is being capped type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX minItems: 1 MinMaxType: $ref: '#/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: type: object required: - Name - Description description: Other tariff type which is not in the standard list. properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' FeeChargeDetail: type: array 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 items: description: Fee/charge type which is being capped type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX minItems: 1 MinMaxType: $ref: '#/components/schemas/OB_MinMaxType1Code' FeeCapOccurrence: $ref: '#/components/schemas/Number_1' FeeCapAmount: $ref: '#/components/schemas/OB_Amount1_4' CappingPeriod: $ref: '#/components/schemas/OB_Period1Code' Notes: type: array items: description: Free text for adding extra details for fee charge cap type: string minLength: 1 maxLength: 2000 OtherFeeType: type: array items: 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: type: object description: Range or amounts or rates for which the fee/charge applies properties: MinimumAmount: description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MaximumAmount: description: Maximum Amount on which fee is applicable (where it is expressed as an amount) type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MinimumRate: description: Minimum rate on which fee/charge is applicable(where it is expressed as a 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 a rate) type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ minItems: 1 FeeChargeCap: type: array items: type: object description: Details about any caps (maximum charges) that apply to a particular or group of fee/charge required: - FeeType - MinMaxType properties: FeeType: type: array items: description: Fee/charge type which is being capped type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX minItems: 1 MinMaxType: $ref: '#/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' additionalProperties: false OBSupplementaryData1: type: object properties: {} additionalProperties: true description: Additional information that can not be captured in the structured fields and/or any other specific block. Links: type: object description: Links relevant to the payload properties: Self: type: string format: uri First: type: string format: uri Prev: type: string format: uri Next: type: string format: uri Last: type: string format: uri additionalProperties: false required: - Self OB_OtherFeeChargeDetailType: type: object required: - FeeCategory - Name - Description description: Other Fee/charge type which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' FeeCategory: $ref: '#/components/schemas/OB_FeeCategory1Code' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' additionalProperties: false 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}$ Number_1: description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount type: integer OB_CodeMnemonic: description: The four letter Mnemonic used within an XML file to identify a code type: string pattern: ^\w{0,4}$ ISODateTime: description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time OB_InterestFixedVariableType1Code: description: Type of interest rate, Fixed or Variable type: string enum: - INFI - INVA Name_4: description: Long name associated with the code type: string minLength: 1 maxLength: 70 OB_FeeType1Code: description: Fee/Charge Type type: string enum: - FEPF - FTOT - FYAF - FYAM - FYAQ - FYCP - FYDB - FYMI - FYXX OB_OtherCodeType1_3: type: object required: - Name - Description description: Other Fee type which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' additionalProperties: false Description_3: description: Description to describe the purpose of the code type: string minLength: 1 maxLength: 350 OB_OtherCodeType1_6: type: object required: - Name - Description description: Other application frequencies not covered in the standard code list properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' additionalProperties: false OB_FeeFrequency1Code_1: description: How often is the overdraft fee/charge calculated for the account. type: string enum: - FEAC - FEAO - FECP - FEDA - FEHO - FEI - FEMO - FEOA - FEOT - FEPC - FEPH - FEPO - FEPS - FEPT - FEPTA - FEPTP - FEQU - FESM - FEST - FEWE - FEYE OB_OtherCodeType1_4: type: object required: - Name - Description description: Other fee rate type code which is not available in the standard code set properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' additionalProperties: false OBErrorResponse1: description: An array of detail error codes, and messages, and URLs to documentation to help remediation. type: object 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 Code: description: Deprecated
High level textual error code, to help categorise the errors. type: string minLength: 1 example: 400 BadRequest maxLength: 40 Message: description: Deprecated
Brief Error message type: string minLength: 1 example: There is something wrong with the request parameters provided maxLength: 500 Errors: items: $ref: '#/components/schemas/OBError1' type: array minItems: 1 required: - Errors additionalProperties: false OB_OtherCodeType1_0: type: object required: - Name - Description properties: Code: $ref: '#/components/schemas/OB_CodeMnemonic' Name: $ref: '#/components/schemas/Name_4' Description: $ref: '#/components/schemas/Description_3' additionalProperties: false OBPCAData1: type: object title: PCA properties: ProductDetails: type: object title: ProductDetails properties: Segment: description: "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nWith respect to PCA products, they are segmented in relation to different markets that they wish to focus on. " title: Segment type: array items: description: "Market segmentation is a marketing term referring to the aggregating of prospective buyers into groups, or segments, that have common needs and respond similarly to a marketing action. Market segmentation enables companies to target different categories of consumers who perceive the full value of certain products and services differently from one another.\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nWith respect to PCA products, they are segmented in relation to different markets that they wish to focus on. " type: string enum: - Basic - BenefitAndReward - CreditInterest - Cashback - General - Graduate - Other - Overdraft - Packaged - Premium - Reward - Student - YoungAdult - Youth MonthlyMaximumCharge: description: The maximum relevant charges that could accrue as defined fully in Part 7 of the CMA order title: MonthlyMaximumCharge type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: description: Optional additional notes to supplement the Core product details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 additionalProperties: false CreditInterest: description: Details about the interest that may be payable to the PCA account holders type: object title: CreditInterest properties: TierBandSet: description: The group of tiers or bands for which credit interest can be applied. type: array title: TierBandSet items: description: The group of tiers or bands for which credit interest can be applied. type: object properties: TierBandMethod: description: 'The methodology of how credit interest is charged. It can be:- 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' title: TierBandMethod type: string enum: - Tiered - Whole CalculationMethod: description: Methods of calculating interest title: CalculationMethod type: string enum: - Compound - SimpleInterest Destination: description: Describes whether accrued interest is payable only to the PCA or to another bank account title: Destination type: string enum: - PayAway - SelfCredit Notes: description: Optional additional notes to supplement the Tier Band Set details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 TierBand: description: Tier Band Details type: array title: TierBand items: description: Tier Band Details type: object properties: Identification: description: Unique and unambiguous identification of a Tier Band for a PCA. title: Identification type: string minLength: 1 maxLength: 35 TierValueMinimum: description: Minimum deposit value for which the credit interest tier applies. title: TierValueMinimum type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMaximum: description: Maximum deposit value for which the credit interest tier applies. title: TierValueMaximum type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CalculationFrequency: description: How often is credit interest calculated for the account. title: CalculationFrequency type: string enum: - PerAcademicTerm - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly ApplicationFrequency: description: How often is interest applied to the PCA for this tier/band i.e. how often the financial institution pays accumulated interest to the customer's PCA. title: ApplicationFrequency type: string enum: - PerAcademicTerm - Daily - HalfYearly - Monthly - Other - Quarterly - PerStatementDate - Weekly - Yearly DepositInterestAppliedCoverage: description: Amount on which Interest applied. title: DepositInterestAppliedCoverage type: string enum: - Tiered - Whole FixedVariableInterestRateType: description: Type of interest rate, Fixed or Variable title: FixedVariableInterestRateType type: string enum: - Fixed - Variable AER: description: "The annual equivalent rate (AER) is interest that is calculated under the assumption that any interest paid is combined with the original balance and the next interest payment will be based on the slightly higher account balance. Overall, this means that interest can be compounded several times in a year depending on the number of times that interest payments are made. \nRead more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A" title: AER type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ BankInterestRateType: description: Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the PCA. title: BankInterestRateType type: string enum: - LinkedBaseRate - Gross - Net - Other BankInterestRate: description: Bank Interest for the PCA product title: BankInterestRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: description: Optional additional notes to supplement the Tier Band details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherBankInterestType: description: Other interest rate types which are not available in the standard code list type: object title: OtherBankInterestType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherApplicationFrequency: description: Other application frequencies that are not available in the standard code list type: object title: OtherApplicationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherCalculationFrequency: description: Other calculation frequency which is not available in the standard code set. type: object title: OtherCalculationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description required: - TierValueMinimum - ApplicationFrequency - FixedVariableInterestRateType - AER minItems: 1 required: - TierBandMethod - TierBand minItems: 1 additionalProperties: false required: - TierBandSet Overdraft: description: Details about Overdraft rates, fees & charges type: object title: Overdraft properties: Notes: description: Associated Notes about the overdraft rates title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBandSet: description: Tier band set details type: array title: OverdraftTierBandSet items: description: Tier band set details type: object properties: TierBandMethod: description: "The methodology of how overdraft is charged. It can be:\n'Whole' Where the same charge/rate is applied to the entirety of the overdraft balance (where charges are applicable). \n'Tiered' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount tiers defined by the lending financial organisation\n'Banded' Where different charges/rates are applied dependent on overdraft maximum and minimum balance amount bands defined by a government organisation." title: TierBandMethod type: string enum: - Tiered - Whole - Banded OverdraftType: description: An overdraft can either be 'committed' which means that the facility cannot be withdrawn without reasonable notification before it's agreed end date, or 'on demand' which means that the financial institution can demand repayment at any point in time. title: OverdraftType type: string enum: - Committed - OnDemand - Other Identification: description: Unique and unambiguous identification of a Tier Band for a overdraft product. title: Identification type: string minLength: 1 maxLength: 35 AuthorisedIndicator: description: Indicates if the Overdraft is authorised (Y) or unauthorised (N) title: AuthorisedIndicator type: boolean BufferAmount: description: 'When a customer exceeds their credit limit, a financial institution will not charge the customer unauthorised overdraft charges if they do not exceed by more than the buffer amount. Note: Authorised overdraft charges may still apply.' title: BufferAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ Notes: description: Optional additional notes to supplement the overdraft Tier Band Set details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftTierBand: description: Provides overdraft details for a specific tier or band type: array title: OverdraftTierBand items: description: Provides overdraft details for a specific tier or band type: object properties: Identification: description: Unique and unambiguous identification of a Tier Band for a overdraft. title: Identification type: string minLength: 1 maxLength: 35 TierValueMin: description: Minimum value of Overdraft Tier/Band title: TierValueMin type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ TierValueMax: description: Maximum value of Overdraft Tier/Band title: TierValueMax type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ OverdraftInterestChargingCoverage: description: Interest charged on whole amount or tiered/banded title: OverdraftInterestChargingCoverage type: string enum: - Tiered - Whole BankGuaranteedIndicator: description: Indicates that a bank provides the overdraft limit up to TierValueMIn to all customers automatically title: BankGuaranteedIndicator type: boolean EAR: description: 'EAR means Effective Annual Rate and/or Equivalent Annual Rate (frequently used interchangeably), being the actual annual interest rate of an Overdraft.' title: EAR type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ 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. title: RepresentativeAPR type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Notes: description: Optional additional notes to supplement the Tier/band details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OverdraftFeesCharges: description: Overdraft fees and charges type: array title: OverdraftFeesCharges items: description: Overdraft fees and charges type: object properties: OverdraftFeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: array title: OverdraftFeeChargeCap items: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans minItems: 1 OverdraftControlIndicator: description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator type: boolean MinMaxType: description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: description: Notes related to Overdraft fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: description: Details about the fees/charges type: array title: OverdraftFeeChargeDetail items: description: Details about the fees/charges type: object properties: FeeType: description: Overdraft fee type title: FeeType type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans OverdraftControlIndicator: description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator type: boolean IncrementalBorrowingAmount: description: Every additional tranche of an overdraft balance to which an overdraft fee is applied title: IncrementalBorrowingAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeAmount: description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) title: FeeAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) title: FeeRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) title: FeeRateType type: string enum: - LinkedBaseRate - Gross - Net - Other ApplicationFrequency: description: Frequency at which the overdraft charge is applied to the account title: ApplicationFrequency type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: description: How often is the overdraft fee/charge calculated for the account. title: CalculationFrequency type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: description: Free text for capturing any other info related to Overdraft Fees Charge Details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other Fee type which is not available in the standard code set type: object title: OtherFeeType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherFeeRateType: description: Other fee rate type code which is not available in the standard code set type: object title: OtherFeeRateType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherApplicationFrequency: description: Other application frequencies that are not available in the standard code list type: object title: OtherApplicationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherCalculationFrequency: description: Other calculation frequency which is not available in the standard code set. type: object title: OtherCalculationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OverdraftFeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object title: OverdraftFeeChargeCap properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans minItems: 1 OverdraftControlIndicator: description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator type: boolean MinMaxType: description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: description: Notes related to Overdraft fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description additionalProperties: false required: - FeeType - MinMaxType required: - FeeType - ApplicationFrequency minItems: 1 required: - OverdraftFeeChargeDetail required: - TierValueMin minItems: 1 OverdraftFeesCharges: description: Overdraft fees and charges details type: array title: OverdraftFeesCharges items: description: Overdraft fees and charges details type: object properties: OverdraftFeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: array title: OverdraftFeeChargeCap items: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans minItems: 1 OverdraftControlIndicator: description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator type: boolean MinMaxType: description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: description: Notes related to Overdraft fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType OverdraftFeeChargeDetail: description: Details about the fees/charges type: array title: OverdraftFeeChargeDetail items: description: Details about the fees/charges type: object properties: FeeType: description: Overdraft fee type title: FeeType type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans OverdraftControlIndicator: description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator type: boolean IncrementalBorrowingAmount: description: Every additional tranche of an overdraft balance to which an overdraft fee is applied title: IncrementalBorrowingAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeAmount: description: Amount charged for an overdraft fee/charge (where it is charged in terms of an amount rather than a rate) title: FeeAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: description: Rate charged for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) title: FeeRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: description: Rate type for overdraft fee/charge (where it is charged in terms of a rate rather than an amount) title: FeeRateType type: string enum: - LinkedBaseRate - Gross - Net - Other ApplicationFrequency: description: Frequency at which the overdraft charge is applied to the account title: ApplicationFrequency type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: description: How often is the overdraft fee/charge calculated for the account. title: CalculationFrequency type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: description: Free text for capturing any other info related to Overdraft Fees Charge Details title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other Fee type which is not available in the standard code set type: object title: OtherFeeType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherFeeRateType: description: Other fee rate type code which is not available in the standard code set type: object title: OtherFeeRateType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherApplicationFrequency: description: Other application frequencies that are not available in the standard code list type: object title: OtherApplicationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherCalculationFrequency: description: Other calculation frequency which is not available in the standard code set. type: object title: OtherCalculationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OverdraftFeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object title: OverdraftFeeChargeCap properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Overdraft fee type type: string enum: - ArrangedOverdraft - EmergencyBorrowing - BorrowingItem - OverdraftRenewal - AnnualReview - OverdraftSetup - Surcharge - TempOverdraft - UnauthorisedBorrowing - UnauthorisedPaidTrans - Other - UnauthorisedUnpaidTrans minItems: 1 OverdraftControlIndicator: description: Specifies for the overdraft control feature/benefit title: OverdraftControlIndicator type: boolean MinMaxType: description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: description: Notes related to Overdraft fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description additionalProperties: false required: - FeeType - MinMaxType required: - FeeType - ApplicationFrequency minItems: 1 required: - OverdraftFeeChargeDetail required: - TierBandMethod - OverdraftTierBand minItems: 1 additionalProperties: false required: - OverdraftTierBandSet OtherFeesCharges: description: Contains details of fees and charges which are not associated with either borrowing or features/benefits type: object title: OtherFeesCharges properties: FeeChargeDetail: description: Other fees/charges details type: array title: FeeChargeDetail items: description: Other fees/charges details type: object properties: FeeCategory: description: Categorisation of fees and charges into standard categories. title: FeeCategory type: string enum: - Other - Servicing FeeType: description: Fee/Charge Type title: FeeType type: string enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other FeeAmount: description: Fee Amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) title: FeeAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ FeeRate: description: Rate charged for Fee/Charge (where it is charged in terms of a rate rather than an amount) title: FeeRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ FeeRateType: description: Rate type for Fee/Charge (where it is charged in terms of a rate rather than an amount) title: FeeRateType type: string enum: - LinkedBaseRate - Gross - Net - Other ApplicationFrequency: description: How frequently the fee/charge is applied to the account title: ApplicationFrequency type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly CalculationFrequency: description: How frequently the fee/charge is calculated title: CalculationFrequency type: string enum: - AccountClosing - AccountOpening - AcademicTerm - ChargingPeriod - Daily - PerItem - Monthly - OnAccountAnniversary - Other - PerHour - PerOccurrence - PerSheet - PerTransaction - PerTransactionAmount - PerTransactionPercentage - Quarterly - SixMonthly - StatementMonthly - Weekly - Yearly Notes: description: Optional additional notes to supplement the fee/charge details. title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeCategoryType: type: object title: OtherFeeCategoryType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherFeeType: description: Other Fee/charge type which is not available in the standard code set type: object title: OtherFeeType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 FeeCategory: description: Categorisation of fees and charges into standard categories. title: FeeCategory type: string enum: - Other - Servicing Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - FeeCategory - Name - Description OtherFeeRateType: description: Other fee rate type which is not available in the standard code set type: object title: OtherFeeRateType properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherApplicationFrequency: description: Other application frequencies not covered in the standard code list type: object title: OtherApplicationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description OtherCalculationFrequency: description: Other calculation frequency which is not available in standard code set. type: object title: OtherCalculationFrequency properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 additionalProperties: false required: - Name - Description FeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: array title: FeeChargeCap items: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Fee/charge type which is being capped type: string enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other minItems: 1 MinMaxType: description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: description: Free text for adding extra details for fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType FeeApplicableRange: description: Range or amounts or rates for which the fee/charge applies type: object title: FeeApplicableRange properties: MinimumAmount: description: Minimum Amount on which fee/charge is applicable (where it is expressed as an amount) title: MinimumAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MaximumAmount: description: Maximum Amount on which fee is applicable (where it is expressed as an amount) title: MaximumAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ MinimumRate: description: Minimum rate on which fee/charge is applicable(where it is expressed as a rate) title: MinimumRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ MaximumRate: description: Maximum rate on which fee/charge is applicable(where it is expressed as a rate) title: MaximumRate type: string pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ additionalProperties: false required: - FeeCategory - FeeType - ApplicationFrequency minItems: 1 FeeChargeCap: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: array title: FeeChargeCap items: description: Details about any caps (maximum charges) that apply to a particular fee/charge type: object properties: FeeType: description: Fee/charge type which is being capped title: FeeType type: array items: description: Fee/charge type which is being capped type: string enum: - ServiceCAccountFee - ServiceCAccountFeeMonthly - ServiceCOther - Other minItems: 1 MinMaxType: description: Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution title: MinMaxType type: string enum: - Minimum - Maximum FeeCapOccurrence: description: fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount title: FeeCapOccurrence type: number format: float FeeCapAmount: description: Cap amount charged for a fee/charge (where it is charged in terms of an amount rather than a rate) title: FeeCapAmount type: string pattern: ^(-?\d{1,14}){1}(\.\d{1,4}){0,1}$ CappingPeriod: description: Period e.g. day, week, month etc. for which the fee/charge is capped title: CappingPeriod type: string enum: - AcademicTerm - Day - Half Year - Month - Quarter - Week - Year Notes: description: Free text for adding extra details for fee charge cap title: Notes type: array items: description: maxLength 2000 text type: string minLength: 1 maxLength: 2000 OtherFeeType: description: Other fee type code which is not available in the standard code set type: array title: OtherFeeType items: description: Other fee type code which is not available in the standard code set type: object properties: Code: description: The four letter Mnemonic used within an XML file to identify a code title: Code type: string pattern: ^\w{0,4}$ minLength: 0 maxLength: 4 Name: description: Long name associated with the code title: Name type: string minLength: 1 maxLength: 70 Description: description: Description to describe the purpose of the code title: Description type: string minLength: 1 maxLength: 350 required: - Name - Description required: - FeeType - MinMaxType additionalProperties: false required: - FeeChargeDetail additionalProperties: false 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_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}$ responses: 200ProductsRead: description: Products Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadProduct2' application/json: schema: $ref: '#/components/schemas/OBReadProduct2' application/jose+jwe: 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; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 401Error: description: Unauthorized headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 404Error: description: Not found headers: 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 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait schema: type: integer x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. schema: type: string 200AccountsAccountIdProductRead: description: Products Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBReadProduct2' application/json: schema: $ref: '#/components/schemas/OBReadProduct2' application/jose+jwe: schema: $ref: '#/components/schemas/OBReadProduct2' 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; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 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; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: 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 parameters: x-client-id: in: header name: x-client-id required: false description: "Only used if an ASPSP requires the client ID in order to return rate limit headers. \n\nTPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.\n\nThis header __must not__ be used for client authentication\n" schema: type: string x-fapi-auth-date: in: header name: x-fapi-auth-date required: false description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC" 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)$ AccountId: name: AccountId in: path description: AccountId required: true schema: type: string Authorization: in: header name: Authorization required: true description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 schema: type: string x-fapi-interaction-id: in: header name: x-fapi-interaction-id required: false description: An RFC4122 UID used as a correlation id. schema: type: string x-fapi-customer-ip-address: in: header name: x-fapi-customer-ip-address required: false description: The PSU's IP address if the PSU is currently logged in with the TPP. schema: type: string x-customer-user-agent: in: header name: x-customer-user-agent description: Indicates the user-agent that the PSU is using. required: false schema: type: string headers: RateLimit-Policy: required: false description: 'TPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements. A non-empty list of Quota Policy Items. The Item value __MUST__ be a String. Example: `RateLimit-Policy: "default";q=100;w=10` The **REQUIRED** "q" parameter indicates the quota allocated by this policy measured in quota units. The **OPTIONAL** "w" parameter value conveys a time window. ' schema: type: string RateLimit: required: false description: 'TPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements. A server uses the "RateLimit" response header field to communicate the current service limit for a quota policy for a particular partition key. Example: `RateLimit: "default";r=50;t=30` The **REQUIRED** "r" parameter value conveys the remaining quota units for the identified policy. The **OPTIONAL** "t" parameter value conveys the time window reset time for the identified policy. ' schema: type: string securitySchemes: TPPOAuth2Security: type: oauth2 description: TPP client credential authorisation flow with the ASPSP flows: clientCredentials: tokenUrl: https://authserver.example/token scopes: accounts: Ability to read Accounts information PSUOAuth2Security: type: oauth2 description: OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU flows: authorizationCode: authorizationUrl: https://authserver.example/authorization tokenUrl: https://authserver.example/token scopes: accounts: Ability to read Accounts information