openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 350 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"x-twitter":"HSBC_UK"},"title":"Product Finder API","version":"2.2.1","x-apisguru-categories":["financial"],"x-logo":{"url":"https://twitter.com/HSBC_UK/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://developer.hsbc.com/assets/swaggers/open-product-finder-swagger.json","version":"2.0"}],"x-providerName":"hsbc.com","x-serviceName":"product"},"paths":{"/open-banking/v2.2/business-current-accounts":{"get":{"description":"This API will return data about all BCA products and is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.","responses":{"200":{"description":"Success","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/BCADefinitionMeta"}}}},"400":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition400"}}}},"408":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition408"}}}},"429":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition429"}}}},"500":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition500"}}}},"503":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition503"}}}}},"tags":["Products BCA"]}},"/open-banking/v2.2/commercial-credit-cards":{"get":{"description":"This API will return data about all commercial credit cards products and is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.","responses":{"200":{"description":"Success","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/CCCDefinitionMeta"}}}},"400":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition400"}}}},"408":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition408"}}}},"429":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition429"}}}},"500":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition500"}}}},"503":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition503"}}}}},"tags":["Products Commercial Credit Cards"]}},"/open-banking/v2.2/personal-current-accounts":{"get":{"description":"This API will return data about all PCA products and is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.","responses":{"200":{"description":"Success","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/PCADefinitionMeta"}}}},"400":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition400"}}}},"408":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition408"}}}},"429":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition429"}}}},"500":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition500"}}}},"503":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition503"}}}}},"tags":["Products PCA"]}},"/open-banking/v2.2/unsecured-sme-loans":{"get":{"description":"This API will return data about all SME lending products and is prepared to the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. It is regulated by the UK Competition and Markets Authority (CMA). Data is only available for the United Kingdom.","responses":{"200":{"description":"Success","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/SMELendingDefinitionMeta"}}}},"400":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition400"}}}},"408":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition408"}}}},"429":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition429"}}}},"500":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition500"}}}},"503":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition503"}}}}},"tags":["Products SME Lending"]}},"/x-open-banking/v2.2/business-current-accounts/segment/{segment}":{"get":{"description":"This extended API will return data about all BCA products for the specified segment. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.","parameters":[{"description":"Segment name from this list: "ClientAccount", "Standard", "NonCommercial", "Religious", "SectorSpecific", "Startup", "Switcher".","in":"path","name":"segment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/BCADefinitionMeta"}}}},"400":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition400"}}}},"408":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition408"}}}},"429":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition429"}}}},"500":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition500"}}}},"503":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition503"}}}}},"tags":["Products BCA"]}},"/x-open-banking/v2.2/commercial-credit-cards/segment/{segment}":{"get":{"description":"This extended API will return data about all commercial credit cards products for the specified segment. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.","parameters":[{"description":"Segment name from this list: "General".","in":"path","name":"segment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/CCCDefinitionMeta"}}}},"400":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition400"}}}},"408":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition408"}}}},"429":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition429"}}}},"500":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition500"}}}},"503":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition503"}}}}},"tags":["Products Commercial Credit Cards"]}},"/x-open-banking/v2.2/personal-current-accounts/segment/{segment}":{"get":{"description":"This extended API will return data about all PCA products for the specified segment. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.","parameters":[{"description":"Segment name from this list: "Basic", "General", "Graduate", "Packaged", "Premium", "Reward", "Student", "YoungAdult", "Youth".","in":"path","name":"segment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/PCADefinitionMeta"}}}},"400":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition400"}}}},"408":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition408"}}}},"429":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition429"}}}},"500":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition500"}}}},"503":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition503"}}}}},"tags":["Products PCA"]}},"/x-open-banking/v2.2/unsecured-sme-loans/segment/{segment}":{"get":{"description":"This extended API will return data about all SME lending products for the specified segment. It is based-on the Open Banking standards as defined by the Open Banking Implementation Entity (OBIE) in data dictionary version 2.2. The extended functionality may not fully adhere to the non-functional requirements of the regulator. Data is only available for the United Kingdom.","parameters":[{"description":"Segment name from this list: "AgricultureSector", "Business", "FixedGroup", "FlexibleBusinessLoan", "GovernmentScheme", "Other", "SectorSpecific".","in":"path","name":"segment","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/SMELendingDefinitionMeta"}}}},"400":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition400"}}}},"408":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition408"}}}},"429":{"description":"Bad request","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition429"}}}},"500":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition500"}}}},"503":{"description":"System error","content":{"application/prs.openbanking.opendata.v2.2+json":{"schema":{"$ref":"#/components/schemas/ErrorDefinition503"}}}}},"tags":["Products SME Lending"]}}},"servers":[{"url":"https://dikpeqbnwi3kx.cloudfront.net"}],"components":{"schemas":{"BCADefinition":{"description":"Open Banking Business Current Account product data details","properties":{"Brand":{"additionalProperties":false,"description":"Brand registered by the banking group at https://register.fca.org.uk/","items":{"description":"Brand registered by the banking group at https://register.fca.org.uk/","properties":{"BCA":{"additionalProperties":false,"description":"BCA means a Business Current Account.","items":{"description":"BCA means a Business Current Account.","properties":{"BCAMarketingState":{"additionalProperties":false,"description":"The marketing state (promotional or regular) of the BCA Product.","items":{"description":"The marketing state (promotional or regular) of the BCA Product.","properties":{"CoreProduct":{"additionalProperties":false,"description":"BCA core product details.","properties":{"MonthlyCharge":{"description":"Any fees which can be included in a MonthlyCharge. A new field 'IncludedInMonthlyChargeIndicator' in OtherFeeCharges section indicates whether the fees can be grouped in MonthlyCharge.","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"MonthlyCharge","type":"string"},"Notes":{"description":"Optional additional notes to supplement the Core product details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"ProductDescription":{"description":"The description of the BCA product used for marketing purposes from a customer perspective.","maxLength":2000,"minLength":1,"title":"ProductDescription","type":"string"},"ProductURL":{"description":"URL provided by the organisation which redirects to the product (on live products only) available on an external website. There might be more than one product at a given URL.","maxLength":500,"minLength":1,"title":"ProductURL","type":"string"},"SalesAccessChannels":{"description":"Channels via which a customer can open a BCA.","items":{"description":"Channels via which a customer can open a BCA.","enum":["Branch","CallCentre","Post","Online","RelationshipManager"],"type":"string"},"title":"SalesAccessChannels","type":"array"},"ServicingAccessChannels":{"description":"Channels via which customers can access BCA services.","items":{"description":"Channels via which customers can access BCA services.","enum":["ATM","Branch","CallCentre","Post","MobileBankingApp","Online","PostOffice","RelationshipManager","Text"],"type":"string"},"title":"ServicingAccessChannels","type":"array"},"TcsAndCsURL":{"description":"URL provided by the financial institution which redirects to the BCA T&Cs on an external website","maxLength":500,"minLength":1,"title":"TcsAndCsURL","type":"string"}},"title":"CoreProduct","type":"object"},"CreditInterest":{"additionalProperties":false,"description":"Details about the interest that may be payable to the BCA account holders","properties":{"TierBandSet":{"additionalProperties":false,"description":"The group of tiers or bands for which credit interest can be applied.","items":{"description":"The group of tiers or bands for which credit interest can be applied.","properties":{"CalculationMethod":{"description":"Methods of calculating interest","enum":["Compound","SimpleInterest"],"title":"CalculationMethod","type":"string"},"CreditInterestEligibility":{"additionalProperties":false,"description":"Eligibility for credit interest","items":{"description":"Eligibility for credit interest","properties":{"Amount":{"description":"Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"Amount","type":"string"},"Description":{"description":"Full description for the eligibility criteria","maxLength":500,"minLength":1,"title":"Description","type":"string"},"Indicator":{"description":"Any eligibility criteria where the value can be indicated by a true or false value. UKResident is True or False","title":"Indicator","type":"boolean"},"Name":{"description":"Name provided for the eligibility criteria","maxLength":350,"minLength":1,"title":"Name","type":"string"},"Notes":{"description":"Optional additional notes to supplement the eligibility conditions.","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherType":{"additionalProperties":false,"description":"Non-standard eligibility type code.","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherType","type":"object"},"Period":{"description":"Period for which the other eligibility criteria applies.","enum":["Daily","HalfYearly","Monthly","Other","Quarterly","PerStatementDate","Weekly","Yearly"],"title":"Period","type":"string"},"Textual":{"description":"Any eligibility criteria where a long description is supplied","maxLength":500,"minLength":1,"title":"Textual","type":"string"},"Type":{"description":"Eligibility type - method by which we group eligibilities for comparison purposes.","enum":["AnyBusinessCustomer","MinimumAnniversary","ExistingCustomers","MinimumDeposit","MinimumTransactions","NewCustomersOnly","Other","SwitchersOnly","StartUp","SoleUkAccount","ThirdSectorOnly"],"title":"Type","type":"string"}},"required":["Name","Type"],"type":"object"},"title":"CreditInterestEligibility","type":"array"},"Destination":{"description":"Describes whether accrued interest is payable only to the BCA or to another bank account","enum":["PayAway","SelfCredit"],"title":"Destination","type":"string"},"Notes":{"description":"Optional additional notes to supplement the Tier Band Set details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"TierBand":{"additionalProperties":false,"description":"Tier Band Details","items":{"description":"Tier Band Details","properties":{"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. \n\nRead more: Annual Equivalent Rate (AER) http://www.investopedia.com/terms/a/aer.asp#ixzz4gfR7IO1A","pattern":"^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$","title":"AER","type":"string"},"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.","enum":["Daily","HalfYearly","Monthly","Other","Quarterly","PerStatementDate","Weekly","Yearly"],"title":"ApplicationFrequency","type":"string"},"BankInterestRate":{"description":"Bank Interest for the BCA product","pattern":"^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$","title":"BankInterestRate","type":"string"},"BankInterestRateType":{"description":"Interest rate types, other than AER, which financial institutions may use to describe the annual interest rate payable to the BCA.","enum":["Gross","Other"],"title":"BankInterestRateType","type":"string"},"CalculationFrequency":{"description":"How often is credit interest calculated for the account.","enum":["Daily","HalfYearly","Monthly","Other","Quarterly","PerStatementDate","Weekly","Yearly"],"title":"CalculationFrequency","type":"string"},"DepositInterestAppliedCoverage":{"description":"Amount on which Interest applied.","enum":["Banded","Tiered","Whole"],"title":"DepositInterestAppliedCoverage","type":"string"},"FixedVariableInterestRateType":{"description":"Type of interest rate, Fixed or Variable","enum":["Fixed","Variable"],"title":"FixedVariableInterestRateType","type":"string"},"Identification":{"description":"Unique and unambiguous identification of a Tier Band for a BCA.","maxLength":35,"minLength":1,"title":"Identification","type":"string"},"Notes":{"description":"Optional additional notes to supplement the Tier Band details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherApplicationFrequency":{"additionalProperties":false,"description":"Other application frequencies that are not available in the standard code list","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherApplicationFrequency","type":"object"},"OtherBankInterestType":{"additionalProperties":false,"description":"Other interest rate types which are not available in the standard code list","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherBankInterestType","type":"object"},"OtherCalculationFrequency":{"additionalProperties":false,"description":"Other calculation frequency which is not available in the standard code set.","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherCalculationFrequency","type":"object"},"TierValueMaximum":{"description":"Maximum deposit value for which the credit interest tier applies.","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"TierValueMaximum","type":"string"},"TierValueMinimum":{"description":"Minimum deposit value for which the credit interest tier applies.","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"TierValueMinimum","type":"string"}},"required":["TierValueMinimum","CalculationFrequency","ApplicationFrequency","FixedVariableInterestRateType","AER"],"type":"object"},"minItems":1,"title":"TierBand","type":"array"},"TierBandMethod":{"description":"The methodology of how credit interest is paid/applied. It can be:-\n\n1. Banded\nInterest rates are banded. i.e. Increasing rate on whole balance as balance increases.\n\n2. Tiered\nInterest 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.\n\n3. Whole\nThe same interest rate is applied irrespective of the BCA balance","enum":["Banded","Tiered","Whole"],"title":"TierBandMethod","type":"string"}},"required":["TierBandMethod","Destination","TierBand"],"type":"object"},"minItems":1,"title":"TierBandSet","type":"array"}},"required":["TierBandSet"],"title":"CreditInterest","type":"object"},"Eligibility":{"additionalProperties":false,"description":"Eligibility details for this product i.e. the criteria that an accountholder has to meet in order to be eligible for the BCA product.","properties":{"AgeEligibility":{"additionalProperties":false,"description":"Age eligibility for BCA product","properties":{"MaximumAge":{"description":"Maximum age that a person is eligible to hold this account","format":"float","title":"MaximumAge","type":"number"},"MinimumAge":{"description":"Minimum age that a person is eligible to hold this account","format":"float","title":"MinimumAge","type":"number"},"Notes":{"description":"Optional additional notes to supplement the AgeEligibility details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"}},"title":"AgeEligibility","type":"object"},"CreditCheckEligibility":{"additionalProperties":false,"description":"Credit check criteria that the account holder will need to meet to take out the BCA product","properties":{"Notes":{"description":"Optional additional notes to supplement the CreditCheck details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"ScoringType":{"description":"Opening Credit Scoring Type (Hard or Soft)","enum":["Hard","Soft"],"title":"ScoringType","type":"string"}},"title":"CreditCheckEligibility","type":"object"},"IDEligibility":{"additionalProperties":false,"description":"Identity verification criteria that the account holder will need to meet to take out the BCA product","properties":{"Notes":{"description":"Optional additional notes to supplement the ID Verification details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"URL":{"description":"URL to identity verification document list which is required for obtaining the product.","maxLength":500,"minLength":1,"title":"URL","type":"string"}},"title":"IDEligibility","type":"object"},"IndustryEligibility":{"additionalProperties":false,"description":"Industry Eligibility that the account holder will need to meet to take out the BCA product","properties":{"Notes":{"description":"Optional additional notes to supplement the IndustryEligibility details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherSICCode":{"additionalProperties":false,"description":"Other SICCODE which is not present in the standard code set","properties":{"Code":{"description":"SICCode which is not present in the standard code set.","maxLength":5,"minLength":0,"pattern":"^[0-9]{0,5}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherSICCode","type":"object"},"SICCode":{"description":"UK Standard Industry Code of the business eligible to access the BCA product. Ref http://resources.companieshouse.gov.uk/sic/","items":{"description":"Specifies a numeric string with a maximum length of 5 digits.","maxLength":5,"minLength":0,"pattern":"^[0-9]{0,5}$","type":"string"},"minItems":1,"title":"SICCode","type":"array"}},"required":["SICCode"],"title":"IndustryEligibility","type":"object"},"LegalStructureEligibility":{"additionalProperties":false,"description":"Legal structure eligibility requirement to access the BCA product.","items":{"description":"Legal structure eligibility requirement to access the BCA product.","properties":{"LegalStructure":{"description":"Defines the legal structure of the business to access the BCA product.","enum":["CIO","ClubSociety","Charity","Ltd","LBG","LLP","Other","Partnership","SoleTrader","Trust"],"title":"LegalStructure","type":"string"},"Notes":{"description":"Optional additional notes to supplement the LegalStructureEligibility details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherLegalStructure":{"additionalProperties":false,"description":"Other legal structure code of the business which is not present in the standard list","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherLegalStructure","type":"object"}},"type":"object"},"title":"LegalStructureEligibility","type":"array"},"OfficerEligibility":{"additionalProperties":false,"description":"Describes the requirement of the officers(owner, partner, directors) to access the BCA product.","items":{"description":"Describes the requirement of the officers(owner, partner, directors) to access the BCA product.","properties":{"MaxAmount":{"description":"Maximum amount of officers (for a particular officer type) required to the BCA product","format":"int32","title":"MaxAmount","type":"integer"},"MinAmount":{"description":"Minimum amount of officers (for a particular officer type) required to the BCA product","format":"int32","title":"MinAmount","type":"integer"},"Notes":{"description":"Optional additional notes to supplement the OfficerEligibility details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OfficerType":{"description":"Defines the types of officers eligible for the BCA product. Examples are Directors, Owners etc.","enum":["Director","Owner","Other","Partner"],"title":"OfficerType","type":"string"},"OtherOfficerType":{"additionalProperties":false,"description":"Other Officer Type which is not available in the standard code list.","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherOfficerType","type":"object"}},"type":"object"},"title":"OfficerEligibility","type":"array"},"OtherEligibility":{"additionalProperties":false,"description":"Other eligibility which is not covered by the main eligibility of the BCA product","items":{"description":"Other eligibility which is not covered by the main eligibility of the BCA product","properties":{"Amount":{"description":"Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"Amount","type":"string"},"Description":{"description":"Full description for the eligibility criteria","maxLength":500,"minLength":1,"title":"Description","type":"string"},"Indicator":{"description":"Any eligibility criteria where the value can be indicated by a true or false value. UKResident is True or False","title":"Indicator","type":"boolean"},"Name":{"description":"Name provided for the eligibility criteria","maxLength":350,"minLength":1,"title":"Name","type":"string"},"Notes":{"description":"Optional additional notes to supplement the eligibility conditions.","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherType":{"additionalProperties":false,"description":"Non-standard eligibility type code.","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherType","type":"object"},"Period":{"description":"Period for which the other eligibility criteria applies.","enum":["Daily","HalfYearly","Monthly","Other","Quarterly","PerStatementDate","Weekly","Yearly"],"title":"Period","type":"string"},"Textual":{"description":"Any eligibility criteria where a long description is supplied","maxLength":500,"minLength":1,"title":"Textual","type":"string"},"Type":{"description":"Eligibility type - method by which we group eligibilities for comparison purposes.","enum":["AnyBusinessCustomer","MinimumAnniversary","ExistingCustomers","MinimumDeposit","MinimumTransactions","NewCustomersOnly","Other","SwitchersOnly","StartUp","SoleUkAccount","ThirdSectorOnly"],"title":"Type","type":"string"}},"required":["Name","Type"],"type":"object"},"title":"OtherEligibility","type":"array"},"ResidencyEligibility":{"additionalProperties":false,"description":"Countries in which an accountholder can reside and, therefore, be eligible to open an account","items":{"description":"Countries in which an accountholder can reside and, therefore, be eligible to open an account","properties":{"Notes":{"description":"Optional additional notes to supplement the ResidencyEligibility details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherResidencyType":{"additionalProperties":false,"description":"Other residency type which is not available in standard code list.","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherResidencyType","type":"object"},"ResidencyIncluded":{"description":"Country code for which BCA product is allowed.","items":{"description":"CodeMnemonic","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","type":"string"},"minItems":1,"title":"ResidencyIncluded","type":"array"},"ResidencyType":{"description":"Residency type like Tax residency, Owner residency etc.","enum":["Incorporated","Owner","Other","Trading","CompanyTax"],"title":"ResidencyType","type":"string"}},"required":["ResidencyIncluded"],"type":"object"},"title":"ResidencyEligibility","type":"array"},"TradingHistoryEligibility":{"additionalProperties":false,"description":"Describes the trading history requirements to access the BCA product.","items":{"description":"Describes the trading history requirements to access the BCA product.","properties":{"Amount":{"description":"Amount indicating the min max type","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"Amount","type":"string"},"Indicator":{"description":"Any eligibility criteria where the value can be indicated by a true or false value. e.g. PreviousCCJS is True or False","title":"Indicator","type":"boolean"},"MinMaxType":{"description":"Min Max type","enum":["Minimum","Maximum"],"title":"MinMaxType","type":"string"},"Notes":{"description":"Optional additional notes to supplement the TradingHistoryEligibility details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherTradingType":{"additionalProperties":false,"description":"Other trading type which is not exist in standard code list","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherTradingType","type":"object"},"Period":{"description":"The unit of period (days, weeks, months etc.)","enum":["Day","Half Year","Month","Quarter","Week","AcademicTerm","Year"],"title":"Period","type":"string"},"Textual":{"description":"Any eligibility criteria where a long description is supplied","maxLength":500,"minLength":1,"title":"Textual","type":"string"},"TradingType":{"description":"Trading type eligibility for the BCA product","enum":["AnnualReturns","PreviousCCJSAllowed","GoodTradingHistory","Other","PreviousBankruptcyAllowed","TradingLength","Turnover"],"title":"TradingType","type":"string"}},"type":"object"},"title":"TradingHistoryEligibility","type":"array"}},"title":"Eligibility","type":"object"},"FeaturesAndBenefits":{"additionalProperties":false,"description":"Feature And Benefits Details","properties":{"Card":{"additionalProperties":false,"description":"Payment Card Details","items":{"description":"Payment Card Details","properties":{"ContactlessIndicator":{"description":"Indicates if the card can be used for contactless payments or not.","title":"ContactlessIndicator","type":"boolean"},"MaxDailyCardWithdrawalLimit":{"description":"Maximum daily cash withdrawal limit on the card.","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"MaxDailyCardWithdrawalLimit","type":"string"},"Notes":{"description":"Optional additional notes to supplement the Card details","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherScheme":{"additionalProperties":false,"description":"Operator of a card scheme which is not available in the standard scheme code list","items":{"description":"Operator of a card scheme which is not available in the standard scheme code list","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"type":"object"},"title":"OtherScheme","type":"array"},"OtherType":{"additionalProperties":false,"description":"Any other Card Type which is not available in the standard card type","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherType","type":"object"},"Scheme":{"description":"Operator of Card Scheme e.g. Visa","items":{"description":"Operator of Card Scheme e.g. Visa","enum":["MasterCard","Other","Visa"],"type":"string"},"minItems":1,"title":"Scheme","type":"array"},"Type":{"description":"Card Type available e.g. Debit","enum":["BusinessQuickLodgeCard","CashCard","DebitCard","DepositCard","Other"],"title":"Type","type":"string"}},"required":["Type","Scheme","ContactlessIndicator"],"type":"object"},"title":"Card","type":"array"},"FeatureBenefitGroup":{"additionalProperties":false,"description":"FeatureBenefitGroup can be used to group features & benefits in to packages (which may be chargeable at the group level). E.g. Barclays Student Account allows you to purchase extra benefits packages","items":{"description":"FeatureBenefitGroup can be used to group features & benefits in to packages (which may be chargeable at the group level). E.g. Barclays Student Account allows you to purchase extra benefits packages","properties":{"ApplicationFrequency":{"description":"How frequently is the charge for the feature/benefit group applied to the customer account","enum":["Daily","HalfYearly","Monthly","Other","Quarterly","PerStatementDate","Weekly","Yearly"],"title":"ApplicationFrequency","type":"string"},"BenefitGroupNominalValue":{"description":"BenefitGroupNominalValue is to allow banks to state what they feel their benefit package is worth","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"BenefitGroupNominalValue","type":"string"},"CalculationFrequency":{"description":"How frequently is the charge for the feature/benefit group calculated for the customer account","enum":["Daily","HalfYearly","Monthly","Other","Quarterly","PerStatementDate","Weekly","Yearly"],"title":"CalculationFrequency","type":"string"},"FeatureBenefitEligibility":{"additionalProperties":false,"description":"Feature and Benefit eligibility","items":{"description":"Feature and Benefit eligibility","properties":{"Amount":{"description":"Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"Amount","type":"string"},"Description":{"description":"Full description for the eligibility criteria","maxLength":500,"minLength":1,"title":"Description","type":"string"},"Indicator":{"description":"Any eligibility criteria where the value can be indicated by a true or false value. UKResident is True or False","title":"Indicator","type":"boolean"},"Name":{"description":"Name provided for the eligibility criteria","maxLength":350,"minLength":1,"title":"Name","type":"string"},"Notes":{"description":"Optional additional notes to supplement the eligibility conditions.","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherType":{"additionalProperties":false,"description":"Non-standard eligibility type code.","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherType","type":"object"},"Period":{"description":"Period for which the other eligibility criteria applies.","enum":["Day","Half Year","Month","Quarter","Week","AcademicTerm","Year"],"title":"Period","type":"string"},"Textual":{"description":"Any eligibility criteria where a long description is supplied","maxLength":500,"minLength":1,"title":"Textual","type":"string"},"Type":{"description":"eligibility type - method by which we group eligibilities for comparison purposes.","enum":["AnyBusinessCustomer","MinimumAnniversary","ExistingCustomers","MinimumDeposit","MinimumTransactions","NewCustomersOnly","Other","SwitchersOnly","StartUp","SoleUkAccount","ThirdSectorOnly"],"title":"Type","type":"string"}},"required":["Name","Type"],"type":"object"},"title":"FeatureBenefitEligibility","type":"array"},"FeatureBenefitItem":{"additionalProperties":false,"description":"Detailed features or benefits which may or may not be a part of a feature/benefit group/pack","items":{"description":"Detailed features or benefits which may or may not be a part of a feature/benefit group/pack","properties":{"Amount":{"description":"Amount associated to the feature/benefit where applicable e.g. 200 Pounds worth of travel insurance","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"Amount","type":"string"},"FeatureBenefitEligibility":{"additionalProperties":false,"description":"Feature and Benefit eligibility","items":{"description":"Feature and Benefit eligibility","properties":{"Amount":{"description":"Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"Amount","type":"string"},"Description":{"description":"Full description for the eligibility criteria","maxLength":500,"minLength":1,"title":"Description","type":"string"},"Indicator":{"description":"Any eligibility criteria where the value can be indicated by a true or false value. UKResident is True or False","title":"Indicator","type":"boolean"},"Name":{"description":"Name provided for the eligibility criteria","maxLength":350,"minLength":1,"title":"Name","type":"string"},"Notes":{"description":"Optional additional notes to supplement the eligibility conditions.","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherType":{"additionalProperties":false,"description":"Non-standard eligibility type code.","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherType","type":"object"},"Period":{"description":"Period for which the other eligibility criteria applies.","enum":["Day","Half Year","Month","Quarter","Week","AcademicTerm","Year"],"title":"Period","type":"string"},"Textual":{"description":"Any eligibility criteria where a long description is supplied","maxLength":500,"minLength":1,"title":"Textual","type":"string"},"Type":{"description":"eligibility type - method by which we group eligibilities for comparison purposes.","enum":["AnyBusinessCustomer","MinimumAnniversary","ExistingCustomers","MinimumDeposit","MinimumTransactions","NewCustomersOnly","Other","SwitchersOnly","StartUp","SoleUkAccount","ThirdSectorOnly"],"title":"Type","type":"string"}},"required":["Name","Type"],"type":"object"},"title":"FeatureBenefitEligibility","type":"array"},"Identification":{"description":"Unique and unambiguous identification of a Feature and Benefit Item.","maxLength":35,"minLength":1,"title":"Identification","type":"string"},"Indicator":{"description":"True/False indicator for a particular feature/benefit e.g. Interest Free Overdraft? Yes or No","title":"Indicator","type":"boolean"},"Name":{"description":"Name which can be attached to the feature/benefit","maxLength":350,"minLength":1,"title":"Name","type":"string"},"Notes":{"description":"Optional additional notes to supplement the feature/benefit item. Only used for very specific conditions","items":{"description":"maxLength 2000 text","maxLength":2000,"minLength":1,"type":"string"},"title":"Notes","type":"array"},"OtherType":{"additionalProperties":false,"description":"Other common types of features & benefits which are not available in the standard code set","properties":{"Code":{"description":"The four letter Mnemonic used within an XML file to identify a code","maxLength":4,"minLength":0,"pattern":"^\\w{0,4}$","title":"Code","type":"string"},"Description":{"description":"Description to describe the purpose of the code","maxLength":350,"minLength":1,"title":"Description","type":"string"},"Name":{"description":"Long name associated with the code","maxLength":70,"minLength":1,"title":"Name","type":"string"}},"required":["Name","Description"],"title":"OtherType","type":"object"},"Textual":{"description":"Provides textual information about a feature/benefit e.g. 10% off cinema tickets on Tuesday nights","maxLength":500,"minLength":1,"title":"Textual","type":"string"},"Type":{"description":"Feature and Benefit type","enum":["AccountManagement","AccountOpeningOrSwitchingIncentive","Cashback","InternationalPaymentsSupport","Other","PreferentialRates","RelationshipManager","Rewards","SecureCash"],"title":"Type","type":"string"}},"required":["Type"],"type":"object"},"title":"FeatureBenefitItem","type":"array"},"Fee":{"description":"Amount that is charged to the customer for a pack of features/benefits","pattern":"^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$","title":"Fee","type":"string"},"Name":{"description":"Feature/Benefit Name","maxLength":350,"minLength":1,"title":"Name","type":"string"},"Notes":{"description":"Optional additional