{ "swagger": "2.0", "info": { "version": "v2.0", "title": "Open Data API", "description": "Swagger specification for OpenData: Commercial Credit Card" }, "host": "developer.openbanking.org.uk", "basePath": "/reference-implementation/open-banking/v2.0", "schemes": [ "https" ], "produces": [ "application/prs.openbanking.opendata.v2.0+json" ], "tags": [ { "name": "CCC", "description": "Endpoint for getting Commercial Credit Card data" } ], "paths": { "/commercial-credit-cards": { "get": { "tags": [ "CCC" ], "description": "Gets a list of all `Commerical Credit Card` objects.", "parameters": [ { "name": "If-Modified-Since", "type": "string", "description": "Used for conditional request, to retrieve data only if modified since a given date", "in": "header", "required": false }, { "name": "If-None-Match", "type": "string", "description": "Used for conditional request, to retrieve data only if the given Etag value does not match", "in": "header", "required": false } ], "responses": { "200": { "description": "Successful response with a list of `Commercial Credit Card` data", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header", "default": "max-age=31536000" }, "Etag": { "type": "string", "description": "A unique ID identifying whether this resource has changed" }, "Cache-Control": { "type": "string", "description": "Describes how long this response can be cached", "default": "max-age=28800" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" } }, "schema": { "type": "object", "properties": { "meta": { "title": "Meta data", "type": "object", "properties": { "LastUpdated": { "type": "string", "format": "date-time" }, "TotalResults": { "type": "integer" }, "Agreement": { "type": "string", "enum": [ "Use of the APIs and any related data will be subject to the terms of the Open Licence and subject to terms and conditions" ] }, "License": { "description": "Open Banking License", "type": "string", "format": "uri", "enum": [ "https://www.openbanking.org.uk/open-licence" ] }, "TermsOfUse": { "description": "Open Banking Terms of Use", "type": "string", "format": "uri", "enum": [ "https://www.openbanking.org.uk/terms" ] } }, "required": [ "LastUpdated", "TotalResults", "Agreement", "License", "TermsOfUse" ], "additionalProperties": false }, "data": { "type": "array", "items": { "properties": { "Brand": { "description": "Brand registered by the banking group at https://register.fca.org.uk/", "type": "array", "title": "Brand", "items": { "description": "Brand registered by the banking group at https://register.fca.org.uk/", "type": "object", "properties": { "BrandName": { "description": "Brand Name that an organisation uses to market its products or services to a consumer as registered at https://register.fca.org.uk/", "title": "BrandName", "type": "string", "minLength": 1, "maxLength": 140 }, "CCC": { "description": "CCC means a Commercial Credit Card.", "type": "array", "title": "CCC", "items": { "description": "CCC means a Commercial Credit Card.", "type": "object", "properties": { "Name": { "description": "The name of the CCC product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.", "title": "Name", "type": "string", "minLength": 1, "maxLength": 350 }, "Identification": { "description": "The unique ID that has been internally assigned by the financial institution to each of the Commercial Credit Card products they market to their retail and/or small to medium enterprise (SME) customers.", "title": "Identification", "type": "string", "minLength": 1, "maxLength": 35 }, "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.\n\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nFollow us: Investopedia on Facebook\n\nWith respect to CCC 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.\n\nRead more: Market Segmentation http://www.investopedia.com/terms/m/marketsegmentation.asp#ixzz4gfEEalTd \nFollow us: Investopedia on Facebook\n\nWith respect to CCC products, they are segmented in relation to different markets that they wish to focus on.", "type": "string", "enum": [ "General" ] }, "minItems": 1 }, "CCCMarketingState": { "description": "The marketing state (promotional or regular) of the CCC Product.", "type": "array", "title": "CCCMarketingState", "items": { "description": "The marketing state (promotional or regular) of the CCC Product.", "type": "object", "properties": { "Identification": { "description": "Unique and unambiguous identification of a CCC Product Marketing State.", "title": "Identification", "type": "string", "minLength": 1, "maxLength": 35 }, "PredecessorID": { "description": "Identifies the marketing state that precedes this marketing state", "title": "PredecessorID", "type": "string", "minLength": 1, "maxLength": 35 }, "MarketingState": { "description": "Describes the marketing state (regular or promotional) of the CCC Product", "title": "MarketingState", "type": "string", "enum": [ "Promotional", "Regular" ] }, "FirstMarketedDate": { "description": "Marketing state start date", "title": "FirstMarketedDate", "type": "string", "format": "date" }, "LastMarketedDate": { "description": "Marketing state end date", "title": "LastMarketedDate", "type": "string", "format": "date" }, "StateTenureLength": { "description": "The length/duration of a promotional state", "title": "StateTenureLength", "type": "number", "format": "float" }, "StateTenurePeriod": { "description": "The unit of period (days, weeks, months etc.) of the promotional length", "title": "StateTenurePeriod", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Free text for adding details for marketing state", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "Repayment": { "description": "Repayment details of the CCC product", "type": "object", "title": "Repayment", "properties": { "MinBalanceRepaymentRate": { "description": "The percentage of the outstanding balance that you have to repay per month", "title": "MinBalanceRepaymentRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" }, "MinBalanceRepaymentAmount": { "description": "The minimum amount that you have to repay (if it is higher than MinBalancePaymentRate applied to outstanding balance) and if it is lower than the total outstanding balance remaining.", "title": "MinBalanceRepaymentAmount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Notes": { "description": "Optional additional notes to supplement the Repayment details.", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "NonRepaymentFeeCharges": { "description": "Non repayment fee charges details", "type": "array", "title": "NonRepaymentFeeCharges", "items": { "description": "Non repayment fee charges details", "type": "object", "properties": { "NonRepaymentFeeChargeDetail": { "description": "Details about specific fees/charges that are applied for non repayment", "type": "array", "title": "NonRepaymentFeeChargeDetail", "items": { "description": "Details about specific fees/charges that are applied for non repayment", "type": "object", "properties": { "FeeType": { "description": "Non repayment fee type code", "title": "FeeType", "type": "string", "enum": [ "LatePayment", "OverCreditLimit", "Other", "ReturnPayment" ] }, "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": [ "LinkedBaseRate", "Gross", "Net", "Other" ] }, "ApplicationFrequency": { "description": "How frequently the fee/charge is applied to the account", "title": "ApplicationFrequency", "type": "string", "enum": [ "PerAcademicTerm", "Daily", "HalfYearly", "Monthly", "Quarterly", "PerStatementDate", "Weekly", "Yearly" ] }, "CalculationFrequency": { "description": "How frequently the fee/charge is calculated", "title": "CalculationFrequency", "type": "string", "enum": [ "PerAcademicTerm", "Daily", "HalfYearly", "Monthly", "Quarterly", "PerStatementDate", "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 } }, "OtherFeeType": { "description": "Other non repayment 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": "[A-Z]{4}" }, "FeeCategory": { "description": "Categorisation of fees and charges into standard categories.", "title": "FeeCategory", "type": "string", "enum": [ "ATM", "BankersDrafts", "Card", "Cheque", "CounterServices", "Foreign", "International", "Legal", "Online", "PaymentScheme", "Report", "Safekeeping", "Servicing", "Transaction" ] }, "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": "[A-Z]{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": "[A-Z]{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": "[A-Z]{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" ] } } }, "additionalProperties": false, "minItems": 1, "required": [ "FeeType", "ApplicationFrequency", "CalculationFrequency" ] }, "NonRepaymentFeeChargeCap": { "description": "NonRepaymentFeeChargeCap sets daily, weekly, monthly, yearly limits on the fees that are charged", "type": "array", "title": "NonRepaymentFeeChargeCap", "items": { "description": "NonRepaymentFeeChargeCap sets daily, weekly, monthly, yearly limits on the fees that are charged", "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": [ "LatePayment", "OverCreditLimit", "Other", "ReturnPayment" ] }, "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": "[A-Z]{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" ] } } }, "additionalProperties": false, "required": [ "FeeType", "MinMaxType" ] } } }, "additionalProperties": false, "required": [ "NonRepaymentFeeChargeDetail" ] }, "RepaymentAllocation": { "description": "Repayment allocation details", "type": "object", "title": "RepaymentAllocation", "properties": { "Notes": { "description": "Additional notes to supplement the Repayment Allocation details.", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 }, "minItems": 1 } }, "additionalProperties": false, "required": [ "Notes" ] } }, "additionalProperties": false, "required": [ "RepaymentAllocation" ] }, "Eligibility": { "description": "Eligibility details for this product i.e. the criteria that an accountholder has to meet in order to be eligible for the CCC product.", "type": "object", "title": "Eligibility", "properties": { "OtherEligibility": { "description": "Other eligibility which is not covered by the main eligibility of the CCC product", "type": "array", "title": "OtherEligibility", "items": { "description": "Other eligibility which is not covered by the main eligibility of the CCC product", "type": "object", "properties": { "Name": { "description": "Name provided for the eligibility criteria", "title": "Name", "type": "string", "minLength": 1, "maxLength": 350 }, "Description": { "description": "Full description for the eligibility criteria", "title": "Description", "type": "string", "minLength": 1, "maxLength": 500 }, "Type": { "description": "Eligibility type - method by which we group eligibilities for comparison purposes.", "title": "Type", "type": "string", "enum": [ "DirectDebits", "ExistingCustomers", "MinimumOperatingBalance", "MinimumDeposit", "NewCustomersOnly", "PreviousBankruptcyAllowed", "Other", "SwitchersOnly", "SoleStudentAccount", "SoleUkAccount", "UCASFulltimeTwoYears" ] }, "Amount": { "description": "Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.", "title": "Amount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Indicator": { "description": "Any eligibility criteria where an amount is required to be specified e.g. UKResident", "title": "Indicator", "type": "boolean" }, "Textual": { "description": "Any eligibility criteria where a long description is supplied", "title": "Textual", "type": "string", "minLength": 1, "maxLength": 500 }, "Period": { "description": "Period for which the other eligibility criteria applies.", "title": "Period", "type": "string", "enum": [ "PerAcademicTerm", "Daily", "HalfYearly", "Monthly", "Quarterly", "PerStatementDate", "Weekly", "Yearly" ] }, "Notes": { "description": "Optional additional notes to supplement the eligibility conditions.", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherType": { "description": "Non-standard eligibility type code.", "type": "object", "title": "OtherType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] } } }, "additionalProperties": false, "required": [ "Name", "Type" ] }, "AgeEligibility": { "description": "Age eligibility for CCC product", "type": "object", "title": "AgeEligibility", "properties": { "MinimumAge": { "description": "Minimum age that a person is eligible to hold this CCC product", "title": "MinimumAge", "type": "number", "format": "float" }, "MaximumAge": { "description": "Maximum age that a person is eligible to hold this CCC product", "title": "MaximumAge", "type": "number", "format": "float" }, "Notes": { "description": "Optional additional notes to supplement the AgeEligibility details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } } }, "additionalProperties": false }, "ResidencyEligibility": { "description": "Countries in which an accountholder can reside and, therefore, be eligible to open an account", "type": "array", "title": "ResidencyEligibility", "items": { "description": "Countries in which an accountholder can reside and, therefore, be eligible to open an account", "type": "object", "properties": { "ResidencyType": { "description": "Residency type like Tax residency, Owner residency etc.", "title": "ResidencyType", "type": "string", "enum": [ "Incorporated", "Owner", "Other", "Trading", "CompanyTax" ] }, "ResidencyIncluded": { "description": "Country code for which CCC product is allowed.", "title": "ResidencyIncluded", "type": "array", "items": { "description": "CodeMnemonic", "type": "string", "pattern": "[A-Z]{4}" }, "minItems": 1 }, "Notes": { "description": "Optional additional notes to supplement the ResidencyEligibility details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherResidencyType": { "description": "Other residency type which is not available in standard code list.", "type": "object", "title": "OtherResidencyType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] } } }, "additionalProperties": false, "required": [ "ResidencyIncluded" ] }, "TradingHistoryEligibility": { "description": "Describes the trading history requirements to access the CCC product.", "type": "array", "title": "TradingHistoryEligibility", "items": { "description": "Describes the trading history requirements to access the CCC product.", "type": "object", "properties": { "TradingType": { "description": "Trading type eligibility for the CCC product", "title": "TradingType", "type": "string", "enum": [ "AnnualReturns", "PreviousCCJSAllowed", "GoodTradingHistory", "Other", "PreviousBankruptcyAllowed", "TradingLength", "Turnover" ] }, "MinMaxType": { "description": "Min Max type", "title": "MinMaxType", "type": "string", "enum": [ "Minimum", "Maximum" ] }, "Amount": { "description": "Amount indicating the min max type", "title": "Amount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Indicator": { "description": "Any eligibility criteria where an amount is required to be specified e.g. PreviousCCJS", "title": "Indicator", "type": "boolean" }, "Textual": { "description": "Any eligibility criteria where a long description is supplied", "title": "Textual", "type": "string", "minLength": 1, "maxLength": 500 }, "Period": { "description": "The unit of period (days, weeks, months etc.)", "title": "Period", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Optional additional notes to supplement the TradingHistoryEligibility details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherTradingType": { "description": "Other trading type which is not exist in standard code list", "type": "object", "title": "OtherTradingType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] } } }, "additionalProperties": false }, "LegalStructureEligibility": { "description": "Legal structure eligibility requirement to access the CCC product.", "type": "array", "title": "LegalStructureEligibility", "items": { "description": "Legal structure eligibility requirement to access the CCC product.", "type": "object", "properties": { "LegalStructure": { "description": "Defines the legal structure of the business to access the CCC product.", "title": "LegalStructure", "type": "string", "enum": [ "CIO", "ClubSociety", "Charity", "Ltd", "LBG", "LLP", "Other", "Partnership", "SoleTrader", "Trust" ] }, "Notes": { "description": "Optional additional notes to supplement the LegalStructureEligibility details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherLegalStructure": { "description": "Other legal structure code of the business which is not present in the standard list", "type": "object", "title": "OtherLegalStructure", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] } } }, "additionalProperties": false }, "OfficerEligibility": { "description": "Describes the requirement of the officers(owner, partner, directors) to access the CCC product.", "type": "array", "title": "OfficerEligibility", "items": { "description": "Describes the requirement of the officers(owner, partner, directors) to access the CCC product.", "type": "object", "properties": { "OfficerType": { "description": "Defines the types of officers eligible for the CCC product. Examples are Directors, Owners etc.", "title": "OfficerType", "type": "string", "enum": [ "Director", "Owner", "Other", "Partner", "SignificantControl" ] }, "MaxAmount": { "description": "Maximum amount of officers (for a particular officer type) required to the CCC product", "title": "MaxAmount", "type": "integer", "format": "int32" }, "MinAmount": { "description": "Minimum amount of officers (for a particular officer type) required to the CCC product", "title": "MinAmount", "type": "integer", "format": "int32" }, "Notes": { "description": "Optional additional notes to supplement the OfficerEligibility details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherOfficerType": { "description": "Other Officer Type which is not available in the standard code list.", "type": "object", "title": "OtherOfficerType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] } } }, "additionalProperties": false }, "IDEligibility": { "description": "Identity verification criteria that the account holder will need to meet to take out the CCC product", "type": "object", "title": "IDEligibility", "properties": { "URL": { "description": "URL to identity verification document list which is required for obtaining the product.", "title": "URL", "type": "string", "minLength": 1, "maxLength": 500 }, "Notes": { "description": "Optional additional notes to supplement the ID Verification details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } } }, "additionalProperties": false }, "CreditCheckEligibility": { "description": "Credit check criteria that the account holder will need to meet to take out the CCC product", "type": "object", "title": "CreditCheckEligibility", "properties": { "ScoringType": { "description": "Opening Credit Scoring Type (Hard or Soft)", "title": "ScoringType", "type": "string", "enum": [ "Hard", "Soft" ] }, "Notes": { "description": "Optional additional notes to supplement the CreditCheck details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } } }, "additionalProperties": false }, "IndustryEligibility": { "description": "Industry Eligibility that the account holder will need to meet to take out the CCC product", "type": "object", "title": "IndustryEligibility", "properties": { "SICCodeIncluded": { "description": "UK Standard Industry Code of the business eligible to access the CCC product. Ref http://resources.companieshouse.gov.uk/sic/", "title": "SICCodeIncluded", "type": "array", "items": { "description": "maxLength 5 text", "type": "string", "minLength": 1, "maxLength": 5 } }, "SICCodeExcluded": { "description": "UK Standard Industry Code of the business not eligible to access the CCC product. Ref http://resources.companieshouse.gov.uk/sic/", "title": "SICCodeExcluded", "type": "array", "items": { "description": "maxLength 5 text", "type": "string", "minLength": 1, "maxLength": 5 } }, "Notes": { "description": "Optional additional notes to supplement the IndustryEligibility details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherSICCodeIncluded": { "description": "Other SICCode which is not in the standard code list", "type": "array", "title": "OtherSICCodeIncluded", "items": { "description": "Other SICCode which is not in the standard code list", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] }, "OtherSICCodeExcluded": { "description": "Other SICCode which is not in the standard code list", "type": "array", "title": "OtherSICCodeExcluded", "items": { "description": "Other SICCode which is not in the standard code list", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] } }, "additionalProperties": false } }, "additionalProperties": false }, "FeaturesAndBenefits": { "description": "Feature And Benefits Details", "type": "object", "title": "FeaturesAndBenefits", "properties": { "FeatureBenefitGroup": { "description": "FeatureBenefitGroup can be used to group features & benefits in to packages (which may be chargeable at the group level).", "type": "array", "title": "FeatureBenefitGroup", "items": { "description": "FeatureBenefitGroup can be used to group features & benefits in to packages (which may be chargeable at the group level).", "type": "object", "properties": { "Name": { "description": "Feature/Benefit Name", "title": "Name", "type": "string", "minLength": 1, "maxLength": 350 }, "Type": { "description": "Common types of features & benefits", "title": "Type", "type": "string", "enum": [ "AccountManagement", "AccountOpeningOrSwitching Incentive", "Cashback", "Entertainment", "HomeInsurance", "HomeProtection", "InternationalPaymentSupport", "Lifestyle", "MotorBreakdown", "OverdraftControl", "Other", "PreferentialRates", "PremiumService", "RelationshipManager", "Rewards", "TechnologyInsurance", "TravelInsurance", "Travel" ] }, "BenefitGroupNominalValue": { "description": "BenefitGroupNominalValue is to allow banks to state what they feel their benefit package is worth", "title": "BenefitGroupNominalValue", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Fee": { "description": "Amount that is charged to the customer for a pack of features/benefits", "title": "Fee", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "ApplicationFrequency": { "description": "How often is the charge for the feature/benefit group applied to the customer account", "title": "ApplicationFrequency", "type": "string", "enum": [ "PerAcademicTerm", "Daily", "HalfYearly", "Monthly", "Quarterly", "PerStatementDate", "Weekly", "Yearly" ] }, "CalculationFrequency": { "description": "How often is the charge for the feature/benefit group calculated for the customer account", "title": "CalculationFrequency", "type": "string", "enum": [ "PerAcademicTerm", "Daily", "HalfYearly", "Monthly", "Quarterly", "PerStatementDate", "Weekly", "Yearly" ] }, "Notes": { "description": "Optional additional notes to supplement the Feature Benefit Group details", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherType": { "description": "Any other types of features & benefits which is not available in the standard code list.", "type": "object", "title": "OtherType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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 frequency which is not available in the standard code set", "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": "[A-Z]{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": "[A-Z]{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" ] }, "FeatureBenefitItem": { "description": "Detailed features or benefits which may or may not be a part of a feature/benefit group/pack", "type": "array", "title": "FeatureBenefitItem", "items": { "description": "Detailed features or benefits which may or may not be a part of a feature/benefit group/pack", "type": "object", "properties": { "Identification": { "description": "Unique and unambiguous identification of a Feature and Benefit Item.", "title": "Identification", "type": "string", "minLength": 1, "maxLength": 35 }, "Type": { "description": "Feature and Benefit type", "title": "Type", "type": "string", "enum": [ "AccountManagement", "AccountOpeningOrSwitching Incentive", "Cashback", "Entertainment", "HomeInsurance", "HomeProtection", "InternationalPaymentSupport", "Lifestyle", "MotorBreakdown", "OverdraftControl", "Other", "PreferentialRates", "PremiumService", "RelationshipManager", "Rewards", "TechnologyInsurance", "TravelInsurance", "Travel" ] }, "Name": { "description": "Name which can be attached to the feature/benefit", "title": "Name", "type": "string", "minLength": 1, "maxLength": 350 }, "Amount": { "description": "Amount associated to the feature/benefit where applicable e.g. 200 Pounds worth of travel insurance", "title": "Amount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Indicator": { "description": "True/False indicator for a particular feature/benefit e.g. Interest Free Overdraft?", "title": "Indicator", "type": "boolean" }, "Textual": { "description": "Provides textual information about a feature/benefit e.g. 10% off cinema tickets on Tuesday nights", "title": "Textual", "type": "string", "minLength": 1, "maxLength": 500 }, "Notes": { "description": "Optional additional notes to supplement the feature/benefit item. Only used for very specific conditions", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherType": { "description": "Other common types of features & benefits which are not available in the standard code set", "type": "object", "title": "OtherType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] }, "FeatureBenefitEligibility": { "description": "Feature and Benefit eligibility", "type": "array", "title": "FeatureBenefitEligibility", "items": { "description": "Feature and Benefit eligibility", "type": "object", "properties": { "Name": { "description": "Name provided for the eligibility criteria", "title": "Name", "type": "string", "minLength": 1, "maxLength": 350 }, "Description": { "description": "Full description for the eligibility criteria", "title": "Description", "type": "string", "minLength": 1, "maxLength": 500 }, "Type": { "description": "Method by which we group eligibilities for comparison purposes.", "title": "Type", "type": "string", "enum": [ "DirectDebits", "ExistingCustomers", "MinimumOperatingBalance", "MinimumDeposit", "NewCustomersOnly", "PreviousBankruptcyAllowed", "Other", "SwitchersOnly", "SoleStudentAccount", "SoleUkAccount", "UCASFulltimeTwoYears" ] }, "Amount": { "description": "Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.", "title": "Amount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Indicator": { "description": "Any eligibility criteria where an amount is required to be specified e.g. UKResident", "title": "Indicator", "type": "boolean" }, "Textual": { "description": "Any eligibility criteria where a long description is supplied", "title": "Textual", "type": "string", "minLength": 1, "maxLength": 500 }, "Period": { "description": "Period for which the other eligibility criteria applies.", "title": "Period", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Optional additional notes to supplement the eligibility conditions.", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherType": { "description": "Non-standard eligibility type code.", "type": "object", "title": "OtherType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] } } }, "additionalProperties": false, "required": [ "Name", "Type" ] } } }, "additionalProperties": false, "required": [ "Type" ] }, "FeatureBenefitEligibility": { "description": "Feature and Benefit eligibility", "type": "array", "title": "FeatureBenefitEligibility", "items": { "description": "Feature and Benefit eligibility", "type": "object", "properties": { "Name": { "description": "Name provided for the eligibility criteria", "title": "Name", "type": "string", "minLength": 1, "maxLength": 350 }, "Description": { "description": "Full description for the eligibility criteria", "title": "Description", "type": "string", "minLength": 1, "maxLength": 500 }, "Type": { "description": "Method by which we group eligibilities for comparison purposes.", "title": "Type", "type": "string", "enum": [ "DirectDebits", "ExistingCustomers", "MinimumOperatingBalance", "MinimumDeposit", "NewCustomersOnly", "PreviousBankruptcyAllowed", "Other", "SwitchersOnly", "SoleStudentAccount", "SoleUkAccount", "UCASFulltimeTwoYears" ] }, "Amount": { "description": "Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.", "title": "Amount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Indicator": { "description": "Any eligibility criteria where an amount is required to be specified e.g. UKResident", "title": "Indicator", "type": "boolean" }, "Textual": { "description": "Any eligibility criteria where a long description is supplied", "title": "Textual", "type": "string", "minLength": 1, "maxLength": 500 }, "Period": { "description": "Period for which the other eligibility criteria applies.", "title": "Period", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Optional additional notes to supplement the eligibility conditions.", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherType": { "description": "Non-standard eligibility type code.", "type": "object", "title": "OtherType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] } } }, "additionalProperties": false, "required": [ "Name", "Type" ] } } }, "additionalProperties": false, "required": [ "Name" ] }, "FeatureBenefitItem": { "description": "Detailed features or benefits which may or may not be a part of a feature/benefit group/pack", "type": "array", "title": "FeatureBenefitItem", "items": { "description": "Detailed features or benefits which may or may not be a part of a feature/benefit group/pack", "type": "object", "properties": { "Identification": { "description": "Unique and unambiguous identification of a Feature and Benefit Item.", "title": "Identification", "type": "string", "minLength": 1, "maxLength": 35 }, "Type": { "description": "Feature and Benefit type", "title": "Type", "type": "string", "enum": [ "AccountManagement", "AccountOpeningOrSwitching Incentive", "Cashback", "Entertainment", "HomeInsurance", "HomeProtection", "InternationalPaymentSupport", "Lifestyle", "MotorBreakdown", "OverdraftControl", "Other", "PreferentialRates", "PremiumService", "RelationshipManager", "Rewards", "TechnologyInsurance", "TravelInsurance", "Travel" ] }, "Name": { "description": "Name which can be attached to the feature/benefit", "title": "Name", "type": "string", "minLength": 1, "maxLength": 350 }, "Amount": { "description": "Amount associated to the feature/benefit where applicable e.g. 200 Pounds worth of travel insurance", "title": "Amount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Indicator": { "description": "True/False indicator for a particular feature/benefit e.g. Interest Free Overdraft?", "title": "Indicator", "type": "boolean" }, "Textual": { "description": "Provides textual information about a feature/benefit e.g. 10% off cinema tickets on Tuesday nights", "title": "Textual", "type": "string", "minLength": 1, "maxLength": 500 }, "Notes": { "description": "Optional additional notes to supplement the feature/benefit item. Only used for very specific conditions", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherType": { "description": "Other common types of features & benefits which are not available in the standard code set", "type": "object", "title": "OtherType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] }, "FeatureBenefitEligibility": { "description": "Feature and Benefit eligibility", "type": "array", "title": "FeatureBenefitEligibility", "items": { "description": "Feature and Benefit eligibility", "type": "object", "properties": { "Name": { "description": "Name provided for the eligibility criteria", "title": "Name", "type": "string", "minLength": 1, "maxLength": 350 }, "Description": { "description": "Full description for the eligibility criteria", "title": "Description", "type": "string", "minLength": 1, "maxLength": 500 }, "Type": { "description": "Method by which we group eligibilities for comparison purposes.", "title": "Type", "type": "string", "enum": [ "DirectDebits", "ExistingCustomers", "MinimumOperatingBalance", "MinimumDeposit", "NewCustomersOnly", "PreviousBankruptcyAllowed", "Other", "SwitchersOnly", "SoleStudentAccount", "SoleUkAccount", "UCASFulltimeTwoYears" ] }, "Amount": { "description": "Any eligibility criteria where an amount is required to be specified e.g. Minimum Age.", "title": "Amount", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Indicator": { "description": "Any eligibility criteria where an amount is required to be specified e.g. UKResident", "title": "Indicator", "type": "boolean" }, "Textual": { "description": "Any eligibility criteria where a long description is supplied", "title": "Textual", "type": "string", "minLength": 1, "maxLength": 500 }, "Period": { "description": "Period for which the other eligibility criteria applies.", "title": "Period", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "Notes": { "description": "Optional additional notes to supplement the eligibility conditions.", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherType": { "description": "Non-standard eligibility type code.", "type": "object", "title": "OtherType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] } } }, "additionalProperties": false, "required": [ "Name", "Type" ] } } }, "additionalProperties": false, "required": [ "Type" ] } }, "additionalProperties": false }, "OtherFeesCharges": { "description": "Contains details of fees and charges which are not associated with either NonRepayment 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": [ "ATM", "BankersDrafts", "Card", "Cheque", "CounterServices", "Foreign", "International", "Legal", "Online", "PaymentScheme", "Report", "Safekeeping", "Servicing", "Transaction" ] }, "FeeType": { "description": "Fee/Charge Type", "title": "FeeType", "type": "string", "enum": [ "ReportCertBalance", "ATMAbroadConVisaDebit", "ATMConGroupATM", "ATMAbroad", "ATMForeignCashDebCard", "ATMAbroadGoldVisaDebit", "ATMNonSterlingWithdrawal", "ATMAbroadVisaDebit", "CHAPSOutBranch", "CHAPSCancellation", "CHAPSIn", "CHAPSOutInterBank", "CHAPSInterBank", "CHAPSOutPost", "CHAPSOutInterBranch", "CHAPSOut", "CHAPSOutOnline", "CardCardReplacement", "DraftsCounter", "DraftsBankers", "DraftsCancellation", "CardGuaranteed", "DraftsIntlPayableAbroad", "DraftsLostStolen", "CardPersonalisedCard", "DraftsIntlStoppedCancelled", "EmergencyLending", "FPSInBranch", "LegalCourtOrder", "IntlPayFXPaymentIn", "IntlPayForeignPaymentInUKAcc", "IntlPayForeignCharge", "IntlPayForeignInternet", "IntlPayFXPaymentOut", "IntlPayFXPaymentOutIR", "IntlPayPurchaseNonSterling", "IntlPayPaymentTracing", "IntlPayTransNonSterling", "IntlPayTransRateNonSterling", "IntlPayWorldpayPayment", "InvPayBankDetailsWrong", "InvPayForeignBCNR", "InvPayForeignRecall", "InvPayStandingOrdUnpaid", "SafeKeepingEnvelope", "SafeKeepingInspection", "SafeKeepingLargeItem", "SafeKeepingParcel", "NightSafeNightSafePaidIn", "OverdraftReview", "ChqBookTheftLossAllStopped", "ChqSpecialChqClearance", "ChqDraftSterling", "ChqOutIssued", "ChqSpecialChqPresentation", "ChqStopped", "ChqDraftFX", "ChqForeignCourier", "ChqGiftCheque", "ChqForeign", "ChqChequePhotocopy", "ChqChequeRetrieval", "ChqSpecialPresentationCount", "ChqSpecialPresentationPTT", "ChqUnpaidCharge", "ChqUnpaidTransIn", "ChqUnpaidTransOut", "ChqUnpaidCheque", "ReportCertInterestDuplicate", "ReportCertInterest", "ReportReference", "ReportReferralItem", "ReportStatementCopyRegular", "ReportStatusEnquiry", "ReportStatementFrequent", "ReportStatementCopy1", "SEPAIn", "SEPAEuro", "SEPAOut", "TransCreditTransferUKDifferent", "TransCredit", "TransCreditTransfer", "TransBuyForeignWithGBP", "TransSWIFTOutUKForeign", "TransPOSSaleForeign", "TransReturnPayment", "TransTransferExGroup", "TransSWIFTOutNonEEASterling", "AutoAutomatedEntries", "OnlineReplacementCardReader", "OnlineUrgentPayment", "ForeignChqSent", "ForeignFXInwardsCust", "ForeignFXOutwards", "ForeignPurchase", "ForeignChqDraft", "ServiceCAccountFee", "ServiceCAccountFeeMonthly", "ServiceCOther", "CounterCashOut", "CounterForeignNoteHandling", "CounterForeignCashOut", "CounterCashFeeRate", "Other" ] }, "NegotiableIndicator": { "description": "Fee/charge which is usually negotiable rather than a fixed amount", "title": "NegotiableIndicator", "type": "boolean" }, "IncludedInPeriodicFeeIndicator": { "description": "Commercial credit cards often have a periodic fee charged (defined in CoreProduct section). Some Fees/charges may be covered by the periodic fee, and you can use the IncludedInPeriodicFeeIndicator to indicate that this is so", "title": "IncludedInPeriodicFeeIndicator", "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": [ "LinkedBaseRate", "Gross", "Net", "Other" ] }, "ApplicationFrequency": { "description": "How frequently the fee/charge is applied to the account", "title": "ApplicationFrequency", "type": "string", "enum": [ "PerAcademicTerm", "Daily", "HalfYearly", "Monthly", "Quarterly", "PerStatementDate", "Weekly", "Yearly" ] }, "CalculationFrequency": { "description": "How frequently the fee/charge is calculated", "title": "CalculationFrequency", "type": "string", "enum": [ "PerAcademicTerm", "Daily", "HalfYearly", "Monthly", "Quarterly", "PerStatementDate", "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 } }, "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": "[A-Z]{4}" }, "FeeCategory": { "description": "Categorisation of fees and charges into standard categories.", "title": "FeeCategory", "type": "string", "enum": [ "ATM", "BankersDrafts", "Card", "Cheque", "CounterServices", "Foreign", "International", "Legal", "Online", "PaymentScheme", "Report", "Safekeeping", "Servicing", "Transaction" ] }, "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": "[A-Z]{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": "[A-Z]{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": "[A-Z]{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 an 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 an rate)", "title": "MaximumRate", "type": "string", "pattern": "^(-?\\d{1,3}){1}(\\.\\d{1,4}){0,1}$" } }, "additionalProperties": false } } }, "additionalProperties": false, "minItems": 1, "required": [ "FeeCategory", "FeeType", "ApplicationFrequency", "CalculationFrequency" ] }, "FeeChargeCap": { "description": "Details about any caps (minimum/maximum charges) that apply to a particular fee/charge", "type": "array", "title": "FeeChargeCap", "items": { "description": "Details about any caps (minimum/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": [ "ReportCertBalance", "ATMAbroadConVisaDebit", "ATMConGroupATM", "ATMAbroad", "ATMForeignCashDebCard", "ATMAbroadGoldVisaDebit", "ATMNonSterlingWithdrawal", "ATMAbroadVisaDebit", "CHAPSOutBranch", "CHAPSCancellation", "CHAPSIn", "CHAPSOutInterBank", "CHAPSInterBank", "CHAPSOutPost", "CHAPSOutInterBranch", "CHAPSOut", "CHAPSOutOnline", "CardCardReplacement", "DraftsCounter", "DraftsBankers", "DraftsCancellation", "CardGuaranteed", "DraftsIntlPayableAbroad", "DraftsLostStolen", "CardPersonalisedCard", "DraftsIntlStoppedCancelled", "EmergencyLending", "FPSInBranch", "LegalCourtOrder", "IntlPayFXPaymentIn", "IntlPayForeignPaymentInUKAcc", "IntlPayForeignCharge", "IntlPayForeignInternet", "IntlPayFXPaymentOut", "IntlPayFXPaymentOutIR", "IntlPayPurchaseNonSterling", "IntlPayPaymentTracing", "IntlPayTransNonSterling", "IntlPayTransRateNonSterling", "IntlPayWorldpayPayment", "InvPayBankDetailsWrong", "InvPayForeignBCNR", "InvPayForeignRecall", "InvPayStandingOrdUnpaid", "SafeKeepingEnvelope", "SafeKeepingInspection", "SafeKeepingLargeItem", "SafeKeepingParcel", "NightSafeNightSafePaidIn", "OverdraftReview", "ChqBookTheftLossAllStopped", "ChqSpecialChqClearance", "ChqDraftSterling", "ChqOutIssued", "ChqSpecialChqPresentation", "ChqStopped", "ChqDraftFX", "ChqForeignCourier", "ChqGiftCheque", "ChqForeign", "ChqChequePhotocopy", "ChqChequeRetrieval", "ChqSpecialPresentationCount", "ChqSpecialPresentationPTT", "ChqUnpaidCharge", "ChqUnpaidTransIn", "ChqUnpaidTransOut", "ChqUnpaidCheque", "ReportCertInterestDuplicate", "ReportCertInterest", "ReportReference", "ReportReferralItem", "ReportStatementCopyRegular", "ReportStatusEnquiry", "ReportStatementFrequent", "ReportStatementCopy1", "SEPAIn", "SEPAEuro", "SEPAOut", "TransCreditTransferUKDifferent", "TransCredit", "TransCreditTransfer", "TransBuyForeignWithGBP", "TransSWIFTOutUKForeign", "TransPOSSaleForeign", "TransReturnPayment", "TransTransferExGroup", "TransSWIFTOutNonEEASterling", "AutoAutomatedEntries", "OnlineReplacementCardReader", "OnlineUrgentPayment", "ForeignChqSent", "ForeignFXInwardsCust", "ForeignFXOutwards", "ForeignPurchase", "ForeignChqDraft", "ServiceCAccountFee", "ServiceCAccountFeeMonthly", "ServiceCOther", "CounterCashOut", "CounterForeignNoteHandling", "CounterForeignCashOut", "CounterCashFeeRate", "Other" ] }, "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": "[A-Z]{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" ] } } }, "additionalProperties": false, "required": [ "FeeType", "MinMaxType" ] } }, "additionalProperties": false, "required": [ "FeeChargeDetail" ] }, "CoreProduct": { "description": "CCC core product details.", "type": "object", "title": "CoreProduct", "properties": { "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.", "title": "ProductURL", "type": "string", "minLength": 1, "maxLength": 500 }, "ProductDescription": { "description": "The description of the CCC product used for marketing purposes from a customer perspective. I.e. what the customer would recognise.", "title": "ProductDescription", "type": "string", "minLength": 1, "maxLength": 2000 }, "TcsAndCsURL": { "description": "URL provided by the financial institution which redirects to the CCC T&Cs on an external website", "title": "TcsAndCsURL", "type": "string", "minLength": 1, "maxLength": 500 }, "MaxDailyCardWithdrawalLimit": { "description": "The maximum amount of money that you can withdraw per day (so long as you do not exceed your available credit limit) ", "title": "MaxDailyCardWithdrawalLimit", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "MinCreditLimit": { "description": "The minimum amount of credit that the bank will offer against the card account", "title": "MinCreditLimit", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "MaxCreditLimit": { "description": "The maximum amount of credit that the bank will offer against the card account and is normally “subject to status”", "title": "MaxCreditLimit", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "MaxPurchaseInterestFreeLengthDays": { "description": "The maximum number of days that you have between making a purchase via the credit card and having to repay the balance without incurring interest charges", "title": "MaxPurchaseInterestFreeLengthDays", "type": "integer", "format": "int32" }, "SalesAccessChannels": { "description": "Channels via which a customer can open a CCC. ", "title": "SalesAccessChannels", "type": "array", "items": { "description": "Methods by which a customer can access the services associated to the PCA product", "type": "string", "enum": [ "ATM", "Branch", "CallCentre", "Post", "MobileBankingApp", "Online", "Phone", "PostOffice", "RelationshipManager", "Text" ] }, "minItems": 1 }, "ServicingAccessChannels": { "description": "Channels via which customers can access CCC services.", "title": "ServicingAccessChannels", "type": "array", "items": { "description": "Methods by which a customer can access the services associated to the PCA product", "type": "string", "enum": [ "ATM", "Branch", "CallCentre", "Post", "MobileBankingApp", "Online", "Phone", "PostOffice", "RelationshipManager", "Text" ] }, "minItems": 1 }, "CardScheme": { "description": "Operator of Card Scheme", "title": "CardScheme", "type": "array", "items": { "description": "Operator of Card Scheme", "type": "string", "enum": [ "Mastercard", "Other", "Visa" ] }, "minItems": 1 }, "ContactlessIndicator": { "description": "Indicates whether the card can be used with a contactless terminal", "title": "ContactlessIndicator", "type": "boolean" }, "PeriodicFee": { "description": "Charge made on a periodic basis for the card account e.g. Annual Fee", "title": "PeriodicFee", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "PeriodicFeePeriod": { "description": "The unit of period (days, weeks, months etc.) of the Periodic Fee", "title": "PeriodicFeePeriod", "type": "string", "enum": [ "Day", "Half Year", "Month", "Quarter", "Week", "Year" ] }, "APR": { "description": "Annual Percentage Rate (APR) is a measure that attempts to calculate what percentage of the principal you’ll pay per period (in this case a year), taking every charge – monthly payments over the course of the loan, upfront fees, etc. – into account. For commercial credit cards, this APR is the representative APR which includes any account fees.", "title": "APR", "type": "string", "pattern": "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$" }, "Notes": { "description": "Free text for adding details for core product.", "title": "Notes", "type": "array", "items": { "description": "maxLength 2000 text", "type": "string", "minLength": 1, "maxLength": 2000 } }, "OtherCardScheme": { "description": "Other card scheme which is not available in the standard code list", "type": "array", "title": "OtherCardScheme", "items": { "description": "Other card scheme which is not available in the standard code list", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "[A-Z]{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" ] } }, "additionalProperties": false, "required": [ "ProductURL", "TcsAndCsURL", "SalesAccessChannels", "ServicingAccessChannels", "CardScheme", "ContactlessIndicator", "APR" ] } } }, "additionalProperties": false, "minItems": 1, "required": [ "Identification", "MarketingState", "Eligibility", "FeaturesAndBenefits", "OtherFeesCharges", "CoreProduct" ] } } }, "additionalProperties": false, "minItems": 1, "required": [ "Name", "Identification", "Segment", "CCCMarketingState" ] } } }, "additionalProperties": false, "minItems": 1, "required": [ "BrandName", "CCC" ] } }, "required": [ "Brand" ], "description": "Open Banking Commercial Credit Card product data details", "type": "object" } } }, "required": [ "meta", "data" ], "additionalProperties": false } }, "400": { "description": "You have sent a request which could not be understood.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "400 Error object", "type": "object", "properties": { "status": { "type": "string", "enum": [ "400" ] }, "title": { "type": "string", "enum": [ "Bad request" ] }, "description": { "type": "string", "enum": [ "You have sent a request which could not be understood." ] } }, "required": [ "status", "title", "description" ], "additionalProperties": false } }, "408": { "description": "Your client has failed to submit a request, and a timeout has occurred.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "408 Error object", "type": "object", "properties": { "status": { "type": "string", "enum": [ "408" ] }, "title": { "type": "string", "enum": [ "Client timeout" ] }, "description": { "type": "string", "enum": [ "Your client has failed to submit a request, and a timeout has occurred." ] } }, "required": [ "status", "title", "description" ], "additionalProperties": false } }, "429": { "description": "You have requested this resource too often. Slow down.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "429 Error object", "type": "object", "properties": { "status": { "type": "string", "enum": [ "429" ] }, "title": { "type": "string", "enum": [ "Too many requests" ] }, "description": { "type": "string", "enum": [ "You have requested this resource too often. Slow down." ] } }, "required": [ "status", "title", "description" ], "additionalProperties": false } }, "500": { "description": "An error occurred on the server. No further information is available.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "500 Error object", "type": "object", "properties": { "status": { "type": "string", "enum": [ "500" ] }, "title": { "type": "string", "enum": [ "Internal server error" ] }, "description": { "type": "string", "enum": [ "An error occurred on the server. No further information is available." ] } }, "required": [ "status", "title", "description" ], "additionalProperties": false } }, "503": { "description": "The service is temporarily unavailable.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "503 Error object", "type": "object", "properties": { "status": { "type": "string", "enum": [ "503" ] }, "title": { "type": "string", "enum": [ "Service temporarily unavailable" ] }, "description": { "type": "string", "enum": [ "The service is temporarily unavailable." ] } }, "required": [ "status", "title", "description" ], "additionalProperties": false } }, "default": { "description": "A standard error response.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "Error object", "type": "object", "properties": { "status": { "description": "This corresponds to the HTTP status code", "type": "string" }, "title": { "description": "A short title of the type of error", "type": "string" }, "description": { "description": "Further details describing the error", "type": "string" } }, "required": [ "status", "title", "description" ], "additionalProperties": false } } } }, "head": { "tags": [ "CCC" ], "description": "Gets header information on the current set of `Commerical Credit Card` data", "parameters": [ { "name": "If-Modified-Since", "type": "string", "description": "Used for conditional request, to retrieve data only if modified since a given date", "in": "header", "required": false }, { "name": "If-None-Match", "type": "string", "description": "Used for conditional request, to retrieve data only if the given Etag value does not match", "in": "header", "required": false } ], "responses": { "default": { "description": "No response", "schema": { "title": "No response", "type": "object", "properties": {} } } } } } } }