# Lister les paiements

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

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

Les paiements de votre espace, du plus récent au plus ancien.

## Ce qu'on met dans l'adresse

| Champ | Type | Requis | Ce que c'est |
| --- | --- | --- | --- |
| `status` | « requires_payment » · « processing » · « succeeded » · « expired » · « canceled » · « partially_refunded » · « refunded » | — | Ne rendre que les paiements dans cet état. |
| `reference` | texte | — | Votre référence, exactement. |
| `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 `payment`

| Champ | Type | Requis | Ce que c'est |
| --- | --- | --- | --- |
| `object` | « list » | — | Le genre de l’objet rendu : il ne change jamais. |
| `data` | liste d’objets payment | — | Les paiements 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/payments \
  -H "Authorization: Bearer sk_test_…" \
  -d status=succeeded \
  -d limit=2
```

## La réponse

```json
{
  "object": "list",
  "url": "/v1/payments",
  "has_more": true,
  "data": [
    {
      "object": "payment",
      "id": "pay_01j9x3kq7m4tzv8qhw2n",
      "amount": 10000,
      "currency": "XOF",
      "status": "succeeded",
      "description": "Commande 42",
      "reference": "cmd-42",
      "metadata": {},
      "fees_paid_by": "merchant",
      "amount_paid": 10000,
      "fee": 250,
      "net": 9750,
      "amount_refunded": 0,
      "payment_url": "https://pay.payiz.app/pay_01j9x3kq7m4tzv8qhw2n",
      "return_url": "https://boutique.bj/merci",
      "expires_at": 1790089092,
      "paid_at": 1790002912,
      "available_at": 1790089312,
      "latest_attempt": {
        "object": "payment_attempt",
        "id": "tnt_01j9x4a2b7c5d8e3f6g1h0jk",
        "payment": "pay_01j9x3kq7m4tzv8qhw2n",
        "status": "succeeded",
        "source": "api",
        "phone": "+229 01 •• •• 34 56",
        "country": "BEN",
        "operator": "mtn",
        "amount": 10000,
        "currency": "XOF",
        "failure_code": null,
        "payer_message": null,
        "operator_reference": "MP240927.1512.A83921",
        "created": 1790002700,
        "completed_at": 1790002912,
        "livemode": false
      },
      "created": 1790002692,
      "livemode": false
    },
    {
      "object": "payment",
      "id": "pay_01j9x1fs8h3nbwr6mt2v",
      "amount": 10000,
      "currency": "XOF",
      "status": "succeeded",
      "description": "Commande 42",
      "reference": "cmd-41",
      "metadata": {},
      "fees_paid_by": "merchant",
      "amount_paid": 10000,
      "fee": 250,
      "net": 9750,
      "amount_refunded": 0,
      "payment_url": "https://pay.payiz.app/pay_01j9x3kq7m4tzv8qhw2n",
      "return_url": "https://boutique.bj/merci",
      "expires_at": 1790089092,
      "paid_at": 1790002912,
      "available_at": 1790089312,
      "latest_attempt": {
        "object": "payment_attempt",
        "id": "tnt_01j9x4a2b7c5d8e3f6g1h0jk",
        "payment": "pay_01j9x3kq7m4tzv8qhw2n",
        "status": "succeeded",
        "source": "api",
        "phone": "+229 01 •• •• 34 56",
        "country": "BEN",
        "operator": "mtn",
        "amount": 10000,
        "currency": "XOF",
        "failure_code": null,
        "payer_message": null,
        "operator_reference": "MP240927.1512.A83921",
        "created": 1790002700,
        "completed_at": 1790002912,
        "livemode": false
      },
      "created": 1790002692,
      "livemode": false
    }
  ]
}
```