# Lister les retraits

`GET https://api.payiz.app/v1/payouts`

Demande une clé secrète qui porte le geste « Retraits · lire ».

Filtrable par statut.

## Ce qu'on met dans l'adresse

| Champ | Type | Requis | Ce que c'est |
| --- | --- | --- | --- |
| `status` | « pending » · « in_review » · « processing » · « paid » · « failed » · « refused » · « canceled » | — | Ne rendre que les retraits dans cet état. |
| `limit` | entier | — | De 1 à 100. Par défaut 20. |
| `starting_after` | texte | — | L’identifiant de la dernière ligne lue : la page suivante commence après. |

## Ce qu'on reçoit

`200` · une liste d’objets `payout`

| Champ | Type | Requis | Ce que c'est |
| --- | --- | --- | --- |
| `object` | « list » | — | Le genre de l’objet rendu : il ne change jamais. |
| `data` | liste d’objets payout | — | Les retraits de la page, du plus récent au plus ancien. |
| `has_more` | vrai ou faux | — | Vrai : il en reste. Rappelez avec starting_after sur la dernière ligne lue. |
| `url` | texte | — | L’adresse qui a servi, sans les filtres. |

## La demande

```bash
curl -G https://api.payiz.app/v1/payouts \
  -H "Authorization: Bearer sk_test_…" \
  -d status=paid
```

## La réponse

```json
{
  "object": "list",
  "url": "/v1/payouts",
  "has_more": false,
  "data": [
    {
      "object": "payout",
      "id": "ret_01j9xe9np6w7rzc5mb4d",
      "amount": 50000,
      "currency": "XOF",
      "status": "processing",
      "fee": 500,
      "amount_debited": 50500,
      "recipient": {
        "id": "ben_01j9xd7mk4s2pvb8ya3c",
        "name": "Adjoa Mensah",
        "phone": "+229 01 •• •• 34 00",
        "operator": "mtn",
        "country": "BEN"
      },
      "failure_message": null,
      "paid_at": null,
      "created": 1790009892,
      "livemode": false
    }
  ]
}
```
