Statistiques de Retrait

Obtenez des métriques agrégées sur vos disbursements pour suivre vos performances.

Endpoint

GET /api/withdraws/statistics

Paramètres de requête

Paramètre	Type	Requis	Description
startDate	String	❌	Date de début (format : yyyy-MM-dd)
endDate	String	❌	Date de fin (format : yyyy-MM-dd)

Période par défaut

Si aucune date n'est spécifiée, les statistiques couvrent tous les retraits de votre compte.

Exemples de requête

Statistiques globales

curl -X GET "https://app.awdpay.com/api/withdraws/statistics" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"

Statistiques du mois en cours

curl -X GET "https://app.awdpay.com/api/withdraws/statistics?startDate=2025-01-01&endDate=2025-01-31" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"

7 derniers jours

curl -X GET "https://app.awdpay.com/api/withdraws/statistics?startDate=2025-01-08&endDate=2025-01-15" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"

Réponse

{
  "totalWithdrawals": 248,
  "successfulWithdrawals": 231,
  "failedWithdrawals": 12,
  "pendingWithdrawals": 5,
  "totalAmount": 12450000.00,
  "successAmount": 11800000.00,
  "failedAmount": 450000.00,
  "pendingAmount": 200000.00,
  "totalFees": 187500.00,
  "currency": "XOF",
  "successRate": 93.15,
  "averageAmount": 50201.61,
  "largestWithdrawal": 500000.00,
  "smallestWithdrawal": 1000.00,
  "byGateway": [
    {
      "gatewayName": "wave-senegal",
      "count": 145,
      "totalAmount": 7250000.00,
      "successCount": 142,
      "failedCount": 3
    },
    {
      "gatewayName": "orange-money-sn",
      "count": 103,
      "totalAmount": 5200000.00,
      "successCount": 89,
      "failedCount": 9
    }
  ],
  "byCountry": [
    {
      "country": "SN",
      "count": 210,
      "totalAmount": 10500000.00
    },
    {
      "country": "CI",
      "count": 38,
      "totalAmount": 1950000.00
    }
  ]
}

Champs de réponse

Métriques globales

Champ	Type	Description
totalWithdrawals	Integer	Nombre total de retraits
successfulWithdrawals	Integer	Nombre de retraits réussis
failedWithdrawals	Integer	Nombre de retraits échoués
pendingWithdrawals	Integer	Nombre de retraits en attente
totalAmount	Double	Montant total de tous les retraits
successAmount	Double	Montant total des retraits réussis
failedAmount	Double	Montant total des retraits échoués
pendingAmount	Double	Montant total des retraits en attente
totalFees	Double	Total des frais facturés
currency	String	Devise principale
successRate	Double	Taux de succès (%)
averageAmount	Double	Montant moyen de retrait
largestWithdrawal	Double	Plus grand retrait
smallestWithdrawal	Double	Plus petit retrait

Répartition par passerelle

Champ	Type	Description
gatewayName	String	Nom de la passerelle
count	Integer	Nombre de retraits
totalAmount	Double	Montant total
successCount	Integer	Nombre de retraits réussis
failedCount	Integer	Nombre de retraits échoués

Répartition par pays

Champ	Type	Description
country	String	Code pays
count	Integer	Nombre de retraits
totalAmount	Double	Montant total

Exemple d'utilisation

async function getMonthlyReport(year, month) {
  const startDate = `${year}-${month.toString().padStart(2, '0')}-01`;
  const lastDay = new Date(year, month, 0).getDate();
  const endDate = `${year}-${month.toString().padStart(2, '0')}-${lastDay}`;

  const response = await fetch(
    `https://app.awdpay.com/api/withdraws/statistics?startDate=${startDate}&endDate=${endDate}`,
    { headers: { 'Authorization': `Bearer ${token}` } }
  );

  const stats = await response.json();

  console.log(`Rapport du mois ${month}/${year}`);
  console.log(`Total : ${stats.totalWithdrawals} retraits`);
  console.log(`Taux de succès : ${stats.successRate.toFixed(2)}%`);
  console.log(`Montant total : ${stats.totalAmount.toLocaleString()} ${stats.currency}`);
  console.log(`Frais totaux : ${stats.totalFees.toLocaleString()} ${stats.currency}`);

  return stats;
}

---

Prochaine étape

➡️ Webhooks — Recevoir des notifications en temps réel