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."


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



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


Example Response:

    "merchantName":"Some merchant",
    "offerDesc":"24 Months (0% Interest for 12 Months)",
    "merchantName":"Some merchant",
    "offerDesc":"36 Months (0% Interest for 18 Months)",


merchantNameMerchants namestring
offerDescOffer's namestring
totAmtPayableThe final amount to be repaid (already includes total fees)number
intFreeAmtInterest-free instalment amountnumber
intFreePeriodInterest-free number of repaymentsnumber
intAmtinstalment amount including interestnumber
intPeriodinterest-bearing number of repaymentsnumber
amtignore (not used)n/a
termNumber of total repaymentsnumber
frequencyTime frequency between repaymentsnumber
upfrontAmount to pay upfront. If zero but applicationFee is not zero, then upfront should amount to applicationFeenumber
interestIs interest applicable?boolean
acctKeepingFeeFee for keeping account for each term unit (i.e. per month)number
applicationFeeOnce-off application feenumber
totAmtDivByTermtotal amount devided by termnumber
aprannual percentage ratenumber
interestPayabletotal interest to pay figurenumber
interestRateinterest percentage ratenumber
totFeeAmttotal sum of all feesnumber