Skip to main content

List Deposits

Retrieve paginated transaction history for reconciliation, reporting, and auditing.

Endpoint​

GET /api/v2/deposit/list

Query Parameters​

ParameterTypeRequiredDescription
pageintegerNoPage number (default: 1)
limitintegerNoItems per page (default: 20, max: 100)
statusstringNoFilter by status: pending, completed, failed, expired
gatewayNamestringNoFilter by gateway (e.g., wave-senegal)
startDatestringNoISO 8601 date (e.g., 2025-01-01T00:00:00Z)
endDatestringNoISO 8601 date (e.g., 2025-12-31T23:59:59Z)

Sandbox Example​

curl -X GET "https://sandbox.awdpay.com/test/api/v2/deposit/list?page=1&limit=10&status=completed" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"

Response​

{
  "data": [
    {
      "reference": "DEP_TEST_1763646304918_1D05265E",
      "status": "completed",
      "amount": 10000.0,
      "currency": "XOF",
      "fees": 104.0,
      "gatewayName": "wave-senegal",
      "customerEmail": "customer@example.com",
      "customerPhone": "+221701234567",
      "customerName": "Awa Diop",
      "createdAt": "2025-11-20T14:45:04",
      "completedAt": "2025-11-20T14:47:32",
      "metadata": {
        "order_id": "ORDER_123"
      }
    },
    {
      "reference": "DEP_TEST_1763640000000_2B03456F",
      "status": "completed",
      "amount": 25000.0,
      "currency": "XOF",
      "fees": 130.0,
      "gatewayName": "orange-money-sn",
      "customerEmail": "client2@example.com",
      "customerPhone": "+221709876543",
      "customerName": "Moussa Kane",
      "createdAt": "2025-11-20T12:20:00",
      "completedAt": "2025-11-20T12:22:15",
      "metadata": {
        "order_id": "ORDER_124"
      }
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 5,
    "totalItems": 87,
    "itemsPerPage": 10
  }
}

Use Cases​

  • Reconciliation: sync AWDPay records with your accounting system
  • Financial reporting: generate monthly/quarterly revenue reports
  • Customer support: search transactions by phone number or email
  • Dispute resolution: audit transaction history with full metadata

Example: Filter by Date Range​

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

Example: Filter by Gateway​

curl -X GET "https://sandbox.awdpay.com/test/api/v2/deposit/list?gatewayName=wave-senegal&limit=50" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"
Performance

For large datasets, use date range filters and pagination to reduce response times.

Next Steps​