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.

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 :

"Warning: if you do not meet the repayments on your loan, your account will go into arrears. This may affect your credit rating, which may limit your ability to access credit, a hire-purchase agreement, a consumer-hire agreement or a BNPL agreement in the future."

The text below the 'Apply' button :

"Flexifi Europe Limited, trading as humm is regulated by the Central Bank of Ireland. Flexifi Europe Limited is registered in Ireland. Registered number: 600124. Registered office: Level 4, No. 5 Custom House Plaza, Harbourmaster Place, Dublin 1."

Endpoint

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: