HUhub2
Bill Payments

Look up a bill

Changed on

Retrieves the bill a customer reference points to at a biller, and checks the amount to pay against it.

post/bill-payments/lookup

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: ApiKey, MerchantId, Environment

Headers

ApiKeystring required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantIdstring required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment'live' | 'sandbox' required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Request body

billerIdstring required

Identifier of the biller to look up

referencestring required

Customer reference for the bill, validated against the biller reference_rule

amountnumber

Amount to simulate fees for, when the biller allows partial payment. Defaults to the full bill amount.

Example request

{
  "billerId": "22222222-2222-2222-2222-222222222222",
  "reference": "ref-accepted",
  "amount": 30000
}

Response

referencestring required
amountnumber required

Bill amount, excluding fees

niirpayFeesnumber required

NIIRPAY fees for this bill

hub2Marginnumber required

HUB2 margin on top of NIIRPAY fees, capped by max_applicable_fees. Always 0 until HUB2C-3097 ships.

totalAmountnumber required

Total amount due: bill + NIIRPAY fees + HUB2 margin

currencynumber required

ISO 4217 numeric currency code

Example response

{
  "reference": "ref-accepted",
  "amount": 50000,
  "niirpayFees": 500,
  "totalAmount": 50500,
  "currency": 952,
  "invoices": [
    {
      "reference": "ref-accepted",
      "amount": 50000,
      "invoice_display_order": 1,
      "invoice_payment_order": 1
    }
  ]
}

Changes