HUhub2
Bill Payments

Retrieve a biller

Changed on
get/bill-payments/billers/{billerId}

Request

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

Path parameters

billerIdstring required

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.

Response

identifierstring required
namestring required
countrystring required
categorystring required
flow'INVOICE' | 'CONTRACT' required
payment_mandatory_datastring[] required
logostring required

Example response

{
  "identifier": "22222222-2222-2222-2222-222222222222",
  "name": "SENELEC",
  "country": "SEN",
  "category": "ENERGY",
  "flow": "CONTRACT",
  "reference_rule": {
    "code": "contract_number",
    "label": "Contract Number",
    "description": "Customer contract reference",
    "regex": "^[a-zA-Z0-9_-]+$",
    "example": "ref-accepted"
  },
  "payment_mandatory_data": [
    "phone"
  ]
}

Changes