Consulter une facture

curl --request POST \
  --url https://api-m.dexchange.sn/api/v1/billing/inquiry \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serviceCode": "SENELEC_SN_BILL",
  "reference_client": "210278816"
}
'

{
  "success": true,
  "referenceClient": "210278816",
  "bills": [
    {
      "paymentTransactionNumber": "<string>",
      "referenceClient": "000210278816",
      "referenceFacture": "8000000680",
      "nom": "FALL OUSSEYNOU",
      "prenom": "<string>",
      "montant": 104500,
      "frais": 0,
      "total": 104500,
      "dateEcheance": "2018-12-31",
      "paid": false,
      "address": "<string>",
      "meterStatus": "<string>"
    }
  ]
}

POST

api

billing

inquiry

Consulter une facture

curl --request POST \
  --url https://api-m.dexchange.sn/api/v1/billing/inquiry \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serviceCode": "SENELEC_SN_BILL",
  "reference_client": "210278816"
}
'

{
  "success": true,
  "referenceClient": "210278816",
  "bills": [
    {
      "paymentTransactionNumber": "<string>",
      "referenceClient": "000210278816",
      "referenceFacture": "8000000680",
      "nom": "FALL OUSSEYNOU",
      "prenom": "<string>",
      "montant": 104500,
      "frais": 0,
      "total": 104500,
      "dateEcheance": "2018-12-31",
      "paid": false,
      "address": "<string>",
      "meterStatus": "<string>"
    }
  ]
}

Consulter une facture

Récupère les informations d’une facture (montant dû) ou d’un compteur avant un paiement de facture / une recharge.

Cette étape est optionnelle mais recommandée : elle permet d’afficher la facture (ou le statut du compteur) à votre utilisateur avant de payer. L’endpoint de paiement refait de toute façon une consultation interne.

Endpoint

POST /api/v1/billing/inquiry

Headers

Nom	Type	Requis	Description
Authorization	string	Oui	Bearer YOUR_API_KEY
Content-Type	string	Oui	application/json

Corps de la Requête

{
  "serviceCode": string,        // Code du service de facturation
  "reference_client": string    // Numéro de compteur / référence client
}

Paramètres

Paramètre	Type	Requis	Description
serviceCode	string	Oui	Code du biller (voir tableau ci-dessous)
reference_client	string	Oui	Numéro de compteur / police / référence client à consulter

Services de facturation disponibles

serviceCode	Biller	Type	Montant
`SENEAU_SN_BILL`	SenEau	Facture eau (postpayée)	Imposé
`SENELEC_SN_BILL`	Senelec	Facture électricité postpayée	Imposé
`WOYOFAL_SN_BILL`	Woyofal	Recharge électricité prépayée	Choisi (libre)

Réponse

Réponse Réussie

{
  "success": true,
  "referenceClient": "210278816",
  "bills": [
    {
      "paymentTransactionNumber": null,
      "referenceClient": "000210278816",
      "referenceFacture": "8000000680",
      "nom": "FALL OUSSEYNOU",
      "prenom": null,
      "montant": 104500,
      "frais": 0,
      "total": 104500,
      "dateEcheance": "2018-12-31",
      "paid": false,
      "address": null,
      "meterStatus": null
    }
  ]
}

Pour Woyofal (recharge prépayée), bills[0] représente le compteur : montant vaut 0 (le client choisit le montant au paiement), et meterStatus / address / nom décrivent le compteur.

Champs de `bills[]`

Champ	Type	Description
referenceClient	string	Numéro de compteur
referenceFacture	string	Référence facture (SenEau/Senelec) ou jeton de session (Woyofal)
nom	string	Nom du titulaire (si disponible)
montant	number	Montant de la facture (0 pour les recharges à montant libre)
frais	number	Frais provider (à titre indicatif)
total	number	montant + frais
dateEcheance	string	Date d’échéance (factures postpayées)
paid	boolean	`true` si la facture est déjà réglée
address	string	Adresse du compteur (Woyofal)
meterStatus	string	Statut du compteur (Woyofal)

Réponse d’Erreur

{
  "success": false,
  "message": "No bill found",
  "bills": []
}

Codes d’Erreur

Code HTTP	Description
400	Paramètres invalides / facture introuvable
401	Clé API invalide
403	API en maintenance

Exemple de Requête

curl -X POST https://api-m.dexchange.sn/api/v1/billing/inquiry \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "serviceCode": "SENELEC_SN_BILL",
    "reference_client": "210278816"
  }'

Authorizations

Authorization

string

header

required

Entrez votre clé API comme: Bearer <API_KEY>

Body

application/json

Référence à consulter

serviceCode

enum<string>

required

Code du biller

Available options:

SENEAU_SN_BILL,

SENELEC_SN_BILL,

WOYOFAL_SN_BILL

Example:

"SENELEC_SN_BILL"

reference_client

string

required

Numéro de compteur / police / référence client

Example:

"210278816"

Response

Facture(s) trouvée(s)

success

boolean

Example:

true

referenceClient

string

Example:

"210278816"

bills

object[]

Show child attributes

Get Balance Payer une facture / Recharger

​Consulter une facture

​Endpoint

​Headers

​Corps de la Requête

​Paramètres

​Services de facturation disponibles

​Réponse

​Réponse Réussie

​Champs de bills[]

​Réponse d’Erreur

​Codes d’Erreur

​Exemple de Requête

Authorizations

Body

Response

Consulter une facture

Endpoint

Headers

Corps de la Requête

Paramètres

Services de facturation disponibles

Réponse

Réponse Réussie

Champs de `bills[]`

Réponse d’Erreur

Codes d’Erreur

Exemple de Requête