Widget API - IE / Ireland Documentation (Irish Merchants)
This page provides instructions on pulling widget data from the widget API endpoint for merchants who want to build a custom widget front-end instead of using an existing Humm solution.
Widget API endpoint for requesting instalment calculation and repayments breakdown figures:
https://urkwvzhzpc.execute-api.eu-west-1.amazonaws.com/prod/widget/{id}/{amount}/{term}
Parameters
{merchant_id} : identifier for rate sets
{amount}: total price amount to request a loan for
{term} : the number of instalments in a loan plan. If 0 (zero) requests all possible plans are returned for a given amount
Response Format:
JSON object
Example request URL:
https://urkwvzhzpc.execute-api.eu-west-1.amazonaws.com/prod/widget/0010Y00000cjxZZqQAId/4289/0
Example Response:
[
{
"merchantName":"Some merchant",
"offerDesc":"24 Months (0% Interest for 12 Months)",
"totAmtPayable":4554.76,
"intFreeAmt":178.7,
"intFreePeriod":12,
"intAmt":190.53,
"intPeriod":12,
"amt":189.78,
"term":24,
"frequency":"Monthly",
"upfront":0,
"interest":true,
"acctKeepingFee":3.5,
"applicationFee":40,
"totAmtDivByTerm":47.84,
"apr":15.31,
"interestPayable":156.27,
"interestRate":6.99,
"totFeeAmt":166
},
{
"merchantName":"Some merchant",
"offerDesc":"36 Months (0% Interest for 18 Months)",
"totAmtPayable":4664.02,
"intFreeAmt":119.13,
"intFreePeriod":18,
"intAmt":130.76,
"intPeriod":18,
"amt":129.55,
"term":36,
"frequency":"Monthly",
"upfront":0,
"interest":true,
"acctKeepingFee":3.5,
"applicationFee":40,
"totAmtDivByTerm":47.84,
"apr":15.31,
"interestPayable":156.27,
"interestRate":6.99,
"totFeeAmt":166
}
]
Where:
Field | Description | Type |
---|---|---|
merchantName | Merchants name | string |
offerDesc | Offer's name | string |
totAmtPayable | The final amount to be repaid (already includes total fees) | number |
intFreeAmt | Interest-free instalment amount | number |
intFreePeriod | Interest-free number of repayments | number |
intAmt | instalment amount including interest | number |
intPeriod | interest-bearing number of repayments | number |
amt | ignore (not used) | n/a |
term | Number of total repayments | number |
frequency | Time frequency between repayments | number |
upfront | Amount to pay upfront. If zero but applicationFee is not zero, then upfront should amount to applicationFee | number |
interest | Is interest applicable? | boolean |
acctKeepingFee | Fee for keeping account for each term unit (i.e. per month) | number |
applicationFee | Once-off application fee | number |
totAmtDivByTerm | total amount devided by term | number |
apr | annual percentage rate | number |
interestPayable | total interest to pay figure | number |
interestRate | interest percentage rate | number |
totFeeAmt | total sum of all fees | number |
Updated 4 months ago