SUPPORT

Open Data APIs

OPEN DATA APIs

The following section contains useful information for TPPs who wish to consume Lloyds Banking Group’s Open Data APIs, broken down by each group of APIs.

DATA LATENCY IN LLOYDS BANKING GROUP OPEN DATA API

TPPs should be aware that on the initial release of Open Data v2.1.1, in some circumstances (for example Bank of England rate changes), the Open Data API may be up to 18 hrs out of sync with equivalent data presented via the bank’s public website. TPPs can expect full synchronicity at the latest by 18:00 each day.

TPPs are advised to consider the possibility of this latency in the design of their services, communications with PSUs and, in the case of price comparison uses, take steps to advise the customer that in exceptional circumstances the product available at the point of application may differ from that at the point of comparison.

ATM / BRANCH

Exception Description
Branch Identification

For ATMs that are linked to a physical branch, ATM API Branch Identification = Branch API Branch Identification.

For ATMs that are not linked to a physical branch, the ATM API Branch Identification’s final 2 digits are ‘99’.

 

PCA

Exception Description
Account Behaviour Conditions

The data standard does not currently allow for conditions to be associated with certain fees and benefits. Lloyds Banking Group has addressed this by including notes with the related items. TPPs should be aware of this when consuming the data in the API. For example, as at launch of the API, the following notes were included in the data for certain products:

Notes from OtherFeesCharges for Club Lloyds:

The Club Lloyds monthly account fee comprises of:

Club Lloyds monthly account fee is Free or £3 per month.

The £3 fee is waived for each month you pay in at least £1,500 into your account. If in any month you don't pay in this amount, you will need to pay the £3 monthly account fee.

Notes from OtherFeesCharges for Club Lloyds Platinum:

The Club Lloyds Platinum monthly account fee comprises of:

  • Platinum Account monthly account fee of £17 per month
  • Club Lloyds monthly account fee is Free or £3 per month

The £3 fee is waived for each month you pay in at least £1,500 into your account. If in any month you don't pay in this amount, you will need to pay the £3 monthly account fee.

Maximum combined monthly account fee of £20 per month.

Notes from FeaturesBenefits for Halifax Reward:

£3 reward each month you pay in £750 or more, pay out at least 2 different direct debits and stay in credit. If in any month you miss out on the £3 reward, you can still get it in future months too (when you meet the qualifying requirements.

Notes from FeaturesBenefits for Halifax Ultimate Reward Account:

A lower monthly fee of £12 applies if in the previous calendar month you pay in £750 or more and pay out at least 2 different direct debits and remain in credit.

You also need to keep your account open/not change it to a different current account until the fee is due to be debited (by the 2nd working day of the following calendar month).

Packaged Accts “Packaged” is shown as Segment under PCA; there is no FeatureBenefitGroup - Type option specifically for “Packaged” Bank Accounts so Lloyds Banking Group are recording as ‘Other’.
Vantage Product Lloyds Banking Group maintains separate API data records for Bank of Scotland Classic Vantage Account and Bank of Scotland Platinum Vantage Account as these are distinct products with their own product identifiers.
Club Products Lloyds Banking Group maintains separate API data records for Club Lloyds and Club Lloyds Platinum as these are distinct products with their own product identifiers.
PCAs not eligible for Overdrafts

Lloyds Banking Group has the following products that do not provide an overdraft facility, and has referenced this as a product Note on the PCAMarketingState tab

  • Lloyds Basic Account
  • Lloyds Under 19’s Account
  • Bank of Scotland Basic Account
  • Bank of Scotland Under 19’s Account
  • Halifax Basic Account
  • Halifax ExpressCash Account
Unplanned Overdrafts Lloyds Banking Group no longer charges for Unplanned Overdrafts so this is not referenced anywhere in API data records.
Card withdrawal limits No specific field for ATM daily withdrawal limits so Lloyds Banking Group uses the Notes fields in the Features and Benefits.
Linking Account Information API to Open Data PCA products

Account Information API can only be linked to the Open Data for front book (on sale) products. Where Product Identifier is returned for a particular customer account (following a call to Account Information /accounts/{AccountId}/product) it means that the customer is on a product for which the terms, features and benefits can be found in the Open Data. This Product Identifier can be used to locate that product in the Open Data PCA API

This linking mechanism is only available at a product level so if multiple marketing state variations exist in Open Data for that product then the TPP should engage in further dialogue with the account holder to determine which applies to their present situation.

For example, for the Lloyds Bank Student product terms vary depending on the academic year the student is in. These are represented as marketing states in the Open Data API, so while the linkage will allow a TPP to identify if the customer has a student product it will not facilitate the identification of the year of study, therefore the TPP will have to gather further information from the customer to identify the relevant PCA information.

Promotional vs. Destination products

Distinction between promotion ending and destination products:

  1. Promotions are detailed on the MarketingState within each applicable product. For example, in URCA, the Marketing State section indicates that there is a promotional offer available on the product, the duration and what this relates to, e.g. overdraft switcher offer for 6 months. There is then a promotional section with details of the overdraft offer and a regular section with the standard overdraft details. The promotional section includes notes on the promotion and the fee is showing as zero, whereas in the regular tab it has 1p per £7 borrowed.
  2. Destination products – on a student account, the customer will eventually graduate and not be eligible. The next account is not detailed.
Credit Interest

Lloyds Banking Group has the following products that offer Credit Interest on account balances within a defined tier and this will be reflected on the CreditInterest tab. Any account balance outside of the defined tier values will not receive credit interest.

  • Lloyds Under 19’s Account
  • Lloyds Club Lloyds Account
  • Lloyds Club Platinum Account
  • Halifax ExpressCash Account
  • Bank of Scotland Under 19’s Account
  • Bank of Scotland Classic Vantage Account
  • Bank of Scotland Platinum Vantage Account
 

BUSINESS CURRENT ACCOUNTS (BCAS) - £0 - £1M TURNOVER

API Section Field(s) Usage Notes
Overdraft

Overdraft/Notes

OverdraftFeeCharge Cap/Notes

Notes fields within the Overdraft section have been set as String (len 2000) rather than Array of strings (len 2000).
Overdraft OverdraftFeeCharge Detail/Notes Conditions which are applied to when certain fee/charges may be applied to an account are shown within the corresponding Notes field, linked via the corresponding OverdraftFeeChargeDetail (ID) value.
Eligibility ResidencyIncluded Regex pattern for this field insists on four characters, although it ought to be defined as up to four characters.
Other Fees Charges

FeeChargeDetail(ID)/ FeeType

FeeChargeDetail(ID)/ OtherFeeType

FeeChargeDetail(ID)/ FeeCategory

FeeCategory to FeeType mapping from CodeList references different enumerations compared to DD and Swagger specifications; the reason for this because the stated enumerations do not accurately reflect the categorisation of Fees and Charges by Lloyds Banking Group.

This will not impact consumption of the data because the enumeration mappings are not forced within the Swagger.

Other Fees Charges

FeeChargeDetail(ID)/ FeeAmount

FeeChargeDetail(ID)/ Notes

For some FeeTypes, the corresponding FeeAmount fields may be blank because:

Conditions may apply which determine what price is charged for a particular transaction.

The price of a particular transaction may vary depending on Customer and/or Account behaviour.

The price of a particular transaction may be controlled/determined by a third party (i.e. not Lloyds Banking Group).

Prices for a particular non-standard transaction are available via a discussion with the Customer.

Anywhere where the FeeAmount field is blank will be explained/supported within the corresponding Notes field, linked via the corresponding FeeChargeDetail (ID) value.

Mapping of Account Information API (Transactional Data) to the Open Data API (Product Information) BCA(ID)/Identification

Transactional data made available via the Account Information API can only be linked/mapped to the Open Data API for front book (on sale) products only; these include products which may have elements within them which are no longer offered (e.g. discontinued overdraft offerings no longer available for new lending).

Where a Product Identifier is returned for a particular customer account (following a call to Account Information /accounts/{AccountId}/product) it means that the account is on a product for which the terms and conditions, features and benefits, and pricing information can be found in the Open Data API content. This Product Identifier can be used to locate that product within the Open Data BCA API content.

Exceptions to the above will be where an underlying product may be shared by different customer segments (e.g. which have distinct Terms and Conditions which will apply) each of which is published via the Open Data API, but where customer and/or segment level (in addition to Account-level) information would be required to determine the correct mapping; this complexity for specialist BCA products is not supported at this time. Examples of these products would be the Schools Account, Treasurers’ Account and Credit Union Account.

 

SME BUSINESS CURRENT ACCOUNTS (BCAS) - TURNOVER £1M-25M

Exception Description
Mandatory / optional fields Most optional fields have been left unpopulated due to either (a) being not applicable for the product (b) having variations depending on the customer type.
Products All Lloyds Bank products currently are identical to those for Bank of Scotland with the exception of brand, product identifiers, product naming and the Unauthorised Borrowing Rate for overdrafts which is different for each brand.
Marketing State No products have promotional marketing states – only one single regular state per product.
Credit interest Only one product (School Banking Account) currently pays credit interest as standard. It has no tiers or banding just a single gross rate applicable for balances of £1 and above.
Overdrafts Only customers with Business Extra or Electronic Business Tariff products can currently have an overdraft facility. Identical overdrafts rates (with the exception mentioned above) and fees are applicable for all tiers/bands. Unauthorised Borrowing and Unpaid Item fees are represented in the Overdraft section not under Other Fees and Charges section.
Eligibility Only the entity yearly turnover (£1m-25m) is specified as a requirement for opening or managing accounts. Other eligibility requirements are handled at account opening and may vary depending on the customer – they are optional fields and are left blank.
Fees and Charges

Several fees have been bundled under the ‘Other’ FeeCategory as the codelist supplied did not sufficiently represent the type of fee (description).

Fees and charges are generally unsorted. It was unknown whether they should be sorted according to FeeCategory, how we as a bank should wish to sort them or how a TPP would approach sorting and display to the customer. In addition, if sorted by FeeCategory the fees under the ‘Other’ FeeCategory may be badly ‘positioned’ in a list. Criteria for sorting or presentation of data may also apply equally to features and benefits.

Where fees have been represented under the ‘Other’ FeeCategory the description of the fee will reside under the ‘OtherFeetype’ construct.

Where fee amounts (FeeAmounts) could not be represented by a single value then they are defined under the FeeChargeDetail construct.

 

SME LOANS (SMELS) - £0 - £1M TURNOVER

API Section Field(s) Usage Notes
Eligibility ResidencyIncluded Regex pattern for this field insists on four characters, although it ought to be defined as up to four characters. Values provided state “UK” which would be highlighted as a fail.
 

SME LOANS (SMELS) - £1M - £25M TURNOVER

Exception Description
Product Maximum Loan Amount The largest standard loan amount is £25,000 however in exceptional circumstances if the client’s situation and financial stability is sufficient a loan of up to £50,000 may be considered. This is covered in the notes section.
Eligibility Financial Holdings It is necessary for a customer to hold a current account with Lloyds Banking Group in order to facilitate the business loan. Customers reviewing data may also therefore be interested in viewing Lloyds Banking Group business current accounts on offer.
SIC Codes Lloyds Banking Group has opted to leave the SIC code section blank as there are no industries which would be considered automatically ineligible for a business loan. Customers should be encouraged to contact the bank if they would like additional details.
Fixed Rate APR Our fixed rate business loan product only utilises a single rate and as the current product is set up this would not change. A new product would be created if we ever chose to change this aspect of our business loans.
SME Loan Segment Our Base Rate Business Loans provide additional flexibility to our business customers however our Fixed Rate Business Loans will be restricted to clients with sufficient collateral to cover the loan.
 

BUSINESS CREDIT CARDS

Exception Description
Eligibility Financial Holdings It is necessary for a customer to hold a current account with Lloyds Banking Group before we will issue a business credit card. Customers reviewing data may also therefore be interested in viewing Lloyds Banking Group business current accounts on offer.
Eligibility MinMax Business Credit Cards are split by turnover however there are no functional differences to these products by design. Similarities are not an error and should be presented as directed.