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:
Field | Description |
---|---|
merchantName | Merchants name |
offerDesc | Offer's name |
totAmtPayable | The final amount to be repaid (already includes total fees) |
interestHoliday | subset interest free repayments of total repayments |
intFreeAmt | Interest-free instalment amount |
intFreePeriod | Interest-free number of repayments |
intAmt | instalment amount including interest |
intPeriod | interest-bearing number of repayments |
amt | ignore (not used) |
rateMin | minimum amount for this offer |
rateMax | maximum amount for this offer |
apr | annual percentage rate |
term | Number of total repayments |
frequency | Time frequency between repayments |
upfront | Amount to pay upfront. If zero but applicationFee is not zero, then upfront should amount to applicationFee |
interest | Is interest applicable? |
interestRate | interest rate |
acctKeepingFee | Fee for keeping account for each term unit (i.e. per month) |
applicationFee | Once-off application fee |
totalFees | total sum of fees |
totalInterest | total interest |
count | number of offers available for given amount |
Updated 9 months ago