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.

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

https://we3ccmtf88.execute-api.eu-west-2.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://we3ccmtf88.execute-api.eu-west-2.amazonaws.com/prod/widgets/1uydn49dn39/600

Example Response:

{
   "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:

FieldDescription
merchantNameMerchants name
offerDescOffer's name
totAmtPayableThe final amount to be repaid (already includes total fees)
interestHolidaysubset interest free repayments of total repayments
intFreeAmtInterest-free instalment amount
intFreePeriodInterest-free number of repayments
intAmtinstalment amount including interest
intPeriodinterest-bearing number of repayments
amtignore (not used)
rateMinminimum amount for this offer
rateMaxmaximum amount for this offer
aprannual percentage rate
termNumber of total repayments
frequencyTime frequency between repayments
upfrontAmount to pay upfront. If zero but applicationFee is not zero, then upfront should amount to applicationFee
interestIs interest applicable?
interestRateinterest rate
acctKeepingFeeFee for keeping account for each term unit (i.e. per month)
applicationFeeOnce-off application fee
totalFeestotal sum of fees
totalInteresttotal interest
countnumber of offers available for given amount