Bill Query
base_url: http://sandbox.etranzactng.com/SBP
Description: This endpoint confirms the validity of customer’s details
- Sample Request
- Sample Response
Request Parameters
| Parameter | Description |
|---|---|
| clientRef | This is the unique transaction id generated per transaction by client and should be between 10 and 25 digits |
| billId | This is the corresponding Biller ID (First ID returned in the service-type endpoint) |
| customerId | This holds the biller ID example smartcard number, meter number etc |
POST /bill-query
curl `${base_url}/bill-query`
-H "Content-type: application/json"
-X POST
-d '{
"clientRef": "291-459-4067",
"billId": 18,
"customerId": "04175299546"
}'
Bill-query response parameters (Result Payload)
| Parameter | Description |
|---|---|
| clientRef | This is the unique client generated transaction ID from request |
| paymentRef | This is the eTz client generated transaction ID in response to request. NB: The value of this parameter is required in the billQueryRef field of Bill Payment request payload in order to perform a successful transaction |
| customerId | This holds the biller ID example smartcard number, meter number etc. |
| terminalId | Client Identification Number |
| mobile | Customer’s phone number in 234 prefix format |
| billId | This is the corresponding Biller ID |
| billName | Biller Name |
| billerCode | Biller Alias |
| customerName | This contains customer’s details, the pipe (|) symbol is used as the delimiter (separator) between the Customer’s details |
| status | Status of query |
| error | Error code |
| errorMessage | Error description |
| plans | This contains the available biller plans |
POST /bill-query
{
"status": true,
"message": "Bill Query performed.",
"result": {
"clientRef": "291-459-4067",
"paymentRef": "09FG221222221356544JE874V",
"customerId": "04175299546",
"terminalId": "7000000001",
"mobile": null,
"billId": 23,
"billName": "PHCN Abuja PrePaid",
"billerCode": "phcnabj",
"customerName": "NAME:ALHAJI MOH'DABDULKARIM |DISTRICT:ABJ|ADDRESS:PLOT 46, AREA 1, SEC 1 CRESCENT, GARKI GARKI IV, A7/88 ABUJA Und St. Garki 4|MERCHANT:0123456789ARREARS:23720.6",
"status": "SUCCESS",
"error": null,
"errorMessage": null,
"plans": null
}
}