Consulter une facture
Bills & Top-ups
Bill Inquiry
Retrieve bill or meter information before payment
POST
Consulter une facture
Bill Inquiry
Retrieves bill information (amount due) or meter details before a bill payment / top-up.This step is optional but recommended: it lets you display the bill (or meter status) to your user before paying. The payment endpoint performs an internal inquiry anyway.
Endpoint
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer YOUR_API_KEY |
| Content-Type | string | Yes | application/json |
Request Body
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceCode | string | Yes | Biller code (see table below) |
| reference_client | string | Yes | Meter number / police / customer reference to look up |
Available billing services
| serviceCode | Biller | Type | Amount |
|---|---|---|---|
SENEAU_SN_BILL | SenEau | Water bill (postpaid) | Fixed |
SENELEC_SN_BILL | Senelec | Postpaid electricity bill | Fixed |
WOYOFAL_SN_BILL | Woyofal | Prepaid electricity top-up | Customer-chosen |
Response
Successful Response
For Woyofal (prepaid top-up),
bills[0] represents the meter: montant is 0 (the customer chooses the amount at payment), and meterStatus / address / nom describe the meter.bills[] fields
| Field | Type | Description |
|---|---|---|
| referenceClient | string | Meter number |
| referenceFacture | string | Bill reference (SenEau/Senelec) or session token (Woyofal) |
| nom | string | Account holder name (if available) |
| montant | number | Bill amount (0 for customer-chosen top-ups) |
| frais | number | Provider fee (informational) |
| total | number | montant + frais |
| dateEcheance | string | Due date (postpaid bills) |
| paid | boolean | true if the bill is already settled |
| address | string | Meter address (Woyofal) |
| meterStatus | string | Meter status (Woyofal) |
Error Response
Error Codes
| HTTP Code | Description |
|---|---|
| 400 | Invalid parameters / bill not found |
| 401 | Invalid API key |
| 403 | API under maintenance |
Request Example
Authorizations
Entrez votre clé API comme: Bearer <API_KEY>
Body
application/json
Référence à consulter