Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
outlinetrue

Version Control


Version
Date
Author
Comments
2.0.024 Jul 2017Open Banking Open Data API Team

This is the baseline version.

2.1.021 Aug 2017Open Banking Open Data API Team

This release incorporates all known issues with 2.0.0 up to 18 Aug 2017. Please see the release notes for details.


Overview

This specification includes all relevant artefacts for the Open Data Business SME Commercial Credit Cards (CCC) API Specification.

...

This endpoint can contain multiple brands owned by a particular banking group. Each brand can own multiple SME Commercial Credit Card products.

CCC

This section covers CCC attributes that will change only under rare circumstances (see CoreProduct section for additional attributes that will be updated regularly). 

...

  • Product Name i.e. the name marketed to the consumers.
  • Identification is the unique id created by the financial institution to internally define the product
  • Segment – currently only ‘general’

MarketingState

Within our design, we have a concept of a "marketing state" for the product. This concept is required because for any "On Sale" CCC product:-

...

  1. PredecessorID is used to sequence the Balance and Purchase interest states offered to the customer when they take out the CCC, it does not record change history.
  2. FirstMarketedDate and LastMarkedDate cover the period when the particular marketing state was advertised to the customer.
  3. CMA9 Banks only have to provide information for current (and known future, if they wish) marketing states. There is no open data requirement to provide an audit history of all marketing states that ever applied to the CCC. When the future marketing state becomes the current marketing state, the original marketing state information no longer needs to be published.
  4. When CP1 Marketing state is replaced by CP3 Marketing state, the PredecessorID in CP2 will also need to be updated to point to CP3, as shown.
  5. The Identification column is simply for internal bank use. The ID column is required so that we can sequence states.

Core Product

This sections includes information that can change relatively often. Information to be provided includes:-

  • Product URL allows a link to the financial institution's website where more detail about the product can be found
  • URL to the product's terms & conditions
  • Minimum & Maximum Credit Limits on the card
  • Maximum days of interest free credit on purchases when paid in full and on time each month
  • Sales Access Channels cover all of the channels by which a customer can be sold a CCC ( e.g. Branch, Online )
  • Servicing Access Channels cover all of the channels by which a customer can receive service for their CCC. Note: This covers servicing of all aspects of the CCC. Some aspects may not be serviceable via certain channels.
  • Card Scheme
  • Indicator to show if contactless capable
  • Account service fee amount for the card and how often it is charged ( monthly, quarterly, annually)
  • Representative APR
  • Specify any restrictions on how soon a balance needs to be transferred from opening the account and getting the promotional offer in the notes section

Repayment

Minimum Payment

This is the minimum payment that has to be paid every period ( typically every month ). This amount is the larger of the MinBalanceRepaymentRate applied to the outstanding statement balance or the MinBalanceRepaymentAmount.

...

Use the notes field to indicate what balance type you are allocating the fee to, as well as, indicating how interest is charged on the fee.

Other Fees & Charges 

Key Fees & Charges that a customer has to pay can be specified in the Core Product, Repayment and Features & Benefits sections (see above).

...

Use the notes field to indicate what balance type you are allocating the fee to, as well as, indicating how interest is charged on the fee.

Eligibility

In order to get a CCC a mix of qualifications are required for both the Business and Business owners. For example:

...

Specify any restrictions on Transferring a Balance from another Card in the Notes.

Features & Benefits

In this section, information about any inherent product features or value-added benefits (whether they're charged or not) can be captured.

...

For a benefits group or for individual benefits, any eligibility criteria required to obtain that benefit can be specified as notes.

Specification

The following UML Class Diagram provides the hierarchical structure of the message in a graphical form, which is easier to digest.

...

  • Data Dictionary - provides detailed descriptions for each field in the message specification along with the associated code lists, constraints and other technical details such as cardinality, any pattern constraints, min, max length etc.
  • Swagger - the API specification written using the Swagger API specification format.

Compliance Report

Message Implementation Guide

...