BILLS PAYMENT
Get Billers
Retrieve the list of billers available for a given category. Use the returned slug as the network, provider, or disco value in later calls.
GET /v1/bills/billers
Use this endpoint to
- Discover which billers you can transact with, per category
- Get the
slugneeded for data plans, cable plans, and purchase calls - Check whether a biller skips customer validation
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
category |
string | Yes | One of airtime, data, cable, electricity |
Code Samples
const response = await fetch(
"https://sandbox.hitchpay.ng/v1/bills/billers?category=data",
{
method: "GET",
headers: {
Authorization: "Bearer YOUR_ACCESS_TOKEN"
}
}
);
const data = await response.json();
console.log(data);<?php
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => "https://sandbox.hitchpay.ng/v1/bills/billers?category=data",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer YOUR_ACCESS_TOKEN"
]
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;import requests
url = "https://sandbox.hitchpay.ng/v1/bills/billers"
params = {"category": "data"}
headers = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"}
response = requests.get(url, params=params, headers=headers)
print(response.json())Response
{
"status": "success",
"message": "Billers retrieved",
"data": [
{
"name": "MTN NIGERIA",
"slug": "MTN_NIGERIA",
"biller_id": "…",
"skip_validation": true
}
]
}Fields
| Field | Type | Description |
|---|---|---|
name |
string | Human-readable biller name |
slug |
string | Identifier to use as network / provider / disco in downstream calls |
biller_id |
string | Internal biller identifier |
skip_validation |
boolean | Whether this biller skips customer verification |
Errors
| Code | Meaning |
|---|---|
INVALID_REQUEST |
category missing or not one of the accepted values |
UNAUTHORIZED |
Business not found or inactive |
Questions? Email [email protected]. Also on GitBook.