Bill Payments
post/bill-payments

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

referencestring required

Customer reference for the bill

amountnumber required

Amount to pay, must equal the bill totalAmount (bill + fees + margin) from the lookup response, in the biller currency minor unit

Example request

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

Response

idstring required
status'CREATED' required
billerIdstring required
referencestring required
amountnumber required
paymentLinkUrlstring required

Hosted payment link URL, expires 30 minutes after creation.

Example response

{
  "id": "bp_z1urYtVFgEebtcj8fxp4v",
  "status": "CREATED",
  "billerId": "22222222-2222-2222-2222-222222222222",
  "reference": "ref-accepted",
  "amount": 50500,
  "paymentLinkUrl": "https://pay.hub2.io/payment/pl_z1urYtVFgEebtcj8fxp4v"
}

Changes