Aller au contenu principal

Liste des Dépôts

Récupérez l'historique paginé des transactions pour le rapprochement, les rapports et l'audit.

Endpoint​

GET /api/v2/deposit/list

Paramètres de Requête​

ParamètreTypeRequisDescription
pageintegerNonNuméro de page (par défaut : 1)
limitintegerNonÉléments par page (par défaut : 20, max : 100)
statusstringNonFiltrer par statut : pending, completed, failed, expired
gatewayNamestringNonFiltrer par passerelle (ex. wave-senegal)
startDatestringNonDate ISO 8601 (ex. 2025-01-01T00:00:00Z)
endDatestringNonDate ISO 8601 (ex. 2025-12-31T23:59:59Z)

Exemple Sandbox​

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

Réponse​

{
  "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
  }
}

Cas d'Usage​

  • Rapprochement : synchroniser les enregistrements AWDPay avec votre système comptable
  • Rapports financiers : générer des rapports de revenus mensuels/trimestriels
  • Support client : rechercher des transactions par numéro de téléphone ou email
  • Résolution de litiges : auditer l'historique des transactions avec métadonnées complètes

Exemple : Filtrer par Plage de Dates​

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"

Exemple : Filtrer par Passerelle​

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

Pour de grands ensembles de données, utilisez les filtres de plage de dates et la pagination pour réduire les temps de réponse.

Prochaines Étapes​