Liste des Retraits

Récupérer une liste paginée de vos retraits avec filtres optionnels.

Endpoint

GET /api/withdraws/list

Paramètres de requête

Paramètre	Type	Défaut	Description
page	Integer	0	Numéro de page (commence à 0)
size	Integer	20	Éléments par page (max : 100)
status	String	—	Filtrer par statut (pending, success, failed...)

Exemples de requête

Récupérer tous les retraits

curl -X GET "https://app.awdpay.com/api/withdraws/list?page=0&size=20" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"

Filtrer par statut

curl -X GET "https://app.awdpay.com/api/withdraws/list?page=0&size=20&status=success" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"

Pagination (page 2)

curl -X GET "https://app.awdpay.com/api/withdraws/list?page=1&size=20" \
  -H "Authorization: Bearer $AWDPAY_TOKEN"

Réponse

{
  "content": [
    {
      "reference": "WTD1704067200000ABC123",
      "status": "success",
      "amount": 5000.00,
      "currency": "XOF",
      "beneficiaryName": "Amadou Diallo",
      "beneficiaryPhone": "+221770123456",
      "country": "SN",
      "gatewayName": "wave-senegal",
      "createdAt": "2025-01-15T10:30:00Z",
      "processedAt": "2025-01-15T10:30:45Z"
    },
    {
      "reference": "WTD1704063600000XYZ789",
      "status": "pending",
      "amount": 2500.00,
      "currency": "XOF",
      "beneficiaryName": "Fatou Sall",
      "beneficiaryPhone": "+221770987654",
      "country": "SN",
      "gatewayName": "orange-money-sn",
      "createdAt": "2025-01-15T09:00:00Z",
      "processedAt": null
    }
  ],
  "pageable": {
    "pageNumber": 0,
    "pageSize": 20,
    "offset": 0
  },
  "totalElements": 124,
  "totalPages": 7,
  "last": false,
  "first": true,
  "numberOfElements": 20,
  "size": 20,
  "number": 0,
  "empty": false
}

Champs de réponse

Contenu principal

Champ	Type	Description
content	Array	Liste des retraits sur cette page
totalElements	Integer	Nombre total de retraits correspondant aux filtres
totalPages	Integer	Nombre total de pages
size	Integer	Éléments par page
number	Integer	Numéro de page actuelle
first	Boolean	Est-ce la première page ?
last	Boolean	Est-ce la dernière page ?
empty	Boolean	La liste est-elle vide ?

Objet retrait

Champ	Type	Description
reference	String	Référence unique du retrait
status	String	Statut actuel
amount	Double	Montant du retrait
currency	String	Code devise
beneficiaryName	String	Nom du bénéficiaire
beneficiaryPhone	String	Numéro de téléphone
country	String	Code pays
gatewayName	String	Passerelle utilisée
createdAt	DateTime	Date de création
processedAt	DateTime	Date de traitement (si complété)

Filtrage par statut

Statut	Description
pending	En attente de traitement
processing	En cours de traitement
success	Complété avec succès
failed	Échoué
expired	Expiré
cancelled	Annulé

Exemple de pagination

async function fetchAllWithdrawals() {
  let page = 0;
  let allWithdrawals = [];
  let hasMore = true;

  while (hasMore) {
    const response = await fetch(
      `https://app.awdpay.com/api/withdraws/list?page=${page}&size=100`,
      { headers: { 'Authorization': `Bearer ${token}` } }
    );
    
    const data = await response.json();
    allWithdrawals = allWithdrawals.concat(data.content);
    
    hasMore = !data.last;
    page++;
  }

  return allWithdrawals;
}

---

Prochaine étape

➡️ Statistiques — Accéder aux métriques agrégées