Skip to main content

Deposit Statistics

Access aggregated metrics for business intelligence, dashboards, and performance monitoring.

Endpoint​

GET /api/v2/deposit/statistics

Query Parameters​

ParameterTypeRequiredDescription
startDatestringNoISO 8601 date (default: 30 days ago)
endDatestringNoISO 8601 date (default: now)
groupBystringNoGroup results by: day, week, month, gateway, status

Sandbox Example​

curl -X GET "https://sandbox.awdpay.com/test/api/v2/deposit/statistics?startDate=2025-11-01T00:00:00Z&endDate=2025-11-30T23:59:59Z&groupBy=gateway" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"

Response​

{
  "period": {
    "startDate": "2025-11-01T00:00:00Z",
    "endDate": "2025-11-30T23:59:59Z"
  },
  "summary": {
    "totalTransactions": 1247,
    "totalVolume": 62350000.0,
    "totalFees": 1299840.0,
    "currency": "XOF",
    "successRate": 96.5,
    "averageAmount": 50000.0
  },
  "byGateway": [
    {
      "gatewayName": "wave-senegal",
      "transactions": 478,
      "volume": 23900000.0,
      "fees": 502160.0,
      "successRate": 98.1
    },
    {
      "gatewayName": "orange-money-sn",
      "transactions": 352,
      "volume": 17600000.0,
      "fees": 370240.0,
      "successRate": 95.7
    },
    {
      "gatewayName": "free-money-sn",
      "transactions": 287,
      "volume": 14350000.0,
      "fees": 302080.0,
      "successRate": 94.8
    },
    {
      "gatewayName": "mtn-momo-ci",
      "transactions": 130,
      "volume": 6500000.0,
      "fees": 136760.0,
      "successRate": 97.2
    }
  ],
  "byStatus": {
    "completed": 1203,
    "failed": 28,
    "pending": 12,
    "expired": 4
  },
  "trends": [
    {
      "date": "2025-11-01",
      "transactions": 38,
      "volume": 1900000.0,
      "successRate": 97.4
    },
    {
      "date": "2025-11-02",
      "transactions": 42,
      "volume": 2100000.0,
      "successRate": 95.2
    }
    // ... more daily data
  ]
}

Metrics Explained​

  • totalVolume: sum of all amount values (excluding fees)
  • totalFees: sum of all processing fees
  • successRate: percentage of completed transactions
  • averageAmount: mean transaction value

Use Cases​

  • Business dashboards: visualize revenue trends over time
  • Gateway performance: compare success rates across providers
  • Financial planning: forecast monthly revenue based on historical data
  • Cost analysis: track fee expenses per gateway
curl -X GET "https://sandbox.awdpay.com/test/api/v2/deposit/statistics?groupBy=day&startDate=2025-11-01T00:00:00Z&endDate=2025-11-30T23:59:59Z" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"

Example: Status Breakdown​

curl -X GET "https://sandbox.awdpay.com/test/api/v2/deposit/statistics?groupBy=status" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"
Dashboard Integration

Use the trends array to populate charts in your admin panel or BI tools like Metabase, Tableau, or Power BI.

Next Steps​