Widget API - UK Documentation (UK Merchants)

This page provides instructions on pulling widget data from widget API endpoint for merchants who want to build a custom widget front-end instead of using existing Humm solution.

Compliance Content

Each widget must display obligatory compliance text that cannot be removed or changed by merchants.
The text is placed in the original widget above and below the 'Apply' button - see example below:

The text above the 'Apply' button :

"Late Payment Fee – £7 charged on the day after the payment due date if account is not up to date more info"

The text below the 'Apply' button :

"humm is a trading style of Humm Group Limited which is authorised and regulated by the Financial Conduct Authority. Financial Services Registration Number 954478. humm offers both regulated and unregulated products. Our interest free plans which are repayable within 12 months and in no more than 12 instalments are not regulated by the Financial Conduct Authority. Registered office: 3rd Floor, 2-4 Wellington Street, Belfast. Company Number: NI675430. Data Protection Register Number: ZB029507
© Copyright Humm Group Limited"

Endpoint

Widget API endpoint for requesting instalment calculation and repayments breakdown figures:

https://hhq130ei45.execute-api.eu-west-1.amazonaws.com/prod/widgets/{merchant_id}/{amount}

Parameters

{merchant_id} : identifier for rate sets

{amount} : total price amount to request loan for

Response Format:

JSON object

Example request URL:

https://hhq130ei45.execute-api.eu-west-1.amazonaws.com/prod/widgets/1uydn49dn39/600

Example Response:

{
   "uniqueApplyLink": "https://hummuk.app.link/sfahfa98",
   "data":[
      {
         "merchantName":"John Doe Furniture",
         "term":6,
         "frequency":"Monthly",
         "interestRate":0,
         "interest":false,
         "interestHoliday":0,
         "intFreePeriod":6,
         "intPeriod":0,
         "offerDesc":"Pay in 6",
         "rateMin":500.01,
         "rateMax":1000,
         "apr":0,
         "amt":100,
         "intAmt":100,
         "acctKeepingFee":0,
         "applicationFee":0,
         "totalFees":0,
         "intFreeAmt":100,
         "totAmtPayable":600,
         "totalInterest":0,
         "upfront":100
      },
      {
         "merchantName":"John Doe Furniture",
         "term":12,
         "frequency":"Monthly",
         "interestRate":0,
         "interest":false,
         "interestHoliday":0,
         "intFreePeriod":12,
         "intPeriod":0,
         "offerDesc":"Pay in 12",
         "rateMin":500.01,
         "rateMax":1000,
         "apr":0,
         "amt":50,
         "intAmt":50,
         "acctKeepingFee":0,
         "applicationFee":0,
         "totalFees":0,
         "intFreeAmt":50,
         "totAmtPayable":600,
         "totalInterest":0,
         "upfront":50
      }
   ],
   "count":2
}

Where: