# Lire un paiement

`GET https://api.payiz.app/v1/payments/{id}`

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

Un paiement, avec ce qu’il a déjà rendu.

## Ce qu'on reçoit

`200` · un objet `payment`

| Champ | Type | Requis | Ce que c'est |
| --- | --- | --- | --- |
| `client_secret` | texte | — | Le secret du client, rendu une seule fois à la création : il ouvre le suivi de ce paiement-là depuis le navigateur, sans clé secrète. |
| `object` | « payment » | — | Le genre de l’objet rendu : il ne change jamais. |
| `id` | texte | — | Un identifiant préfixé « pay_ », par exemple pay_01j9x3kq7m4tzv8qhw2n. |
| `amount` | entier | — | Ce qui est demandé au payeur. |
| `currency` | texte | — | Le code ISO 4217, en majuscules. |
| `status` | « requires_payment » · « processing » · « succeeded » · « expired » · « canceled » · « partially_refunded » · « refunded » | — | Où en est le paiement. |
| `description` | texte ou null | — | Ce que le payeur lit sur sa page. |
| `reference` | texte ou null | — | Votre propre référence, telle que vous l’avez posée. |
| `metadata` | objet | — | Ce que vous y avez rangé ; jamais lu par Payiz. |
| `fees_paid_by` | « merchant » · « customer » | — | Qui porte la commission : le marchand, ou le payeur en plus du montant. |
| `amount_paid` | entier ou null | — | Ce que le payeur a réellement versé, frais compris. |
| `fee` | entier ou null | — | La commission de Payiz. |
| `net` | entier ou null | — | Ce qui revient au marchand, commission prise. |
| `amount_refunded` | entier | — | Ce qui a déjà été rendu sur ce paiement. |
| `payment_url` | texte | — | La page à partager avec le payeur. |
| `return_url` | texte ou null | — | Où renvoyer le payeur une fois qu’il a payé. |
| `expires_at` | entier ou null | — | Des secondes depuis 1970, ou null. |
| `paid_at` | entier ou null | — | Des secondes depuis 1970, ou null. |
| `available_at` | entier ou null | — | Quand l’argent devient retirable. Null tant qu’il attend. |
| `latest_attempt` | objet ou null | — | La dernière demande envoyée au téléphone du payeur, ou null. |
| `created` | entier ou null | — | Des secondes depuis 1970, ou null. |
| `livemode` | vrai ou faux | — | Faux en mode test : aucun argent ne circule. |

## La demande

```bash
curl https://api.payiz.app/v1/payments/pay_01j9x3kq7m4tzv8qhw2n \
  -H "Authorization: Bearer sk_test_…"
```

## La réponse

```json
{
  "client_secret": "pcs_01j9x3kq7m4tzv8qhw2n_k3f8",
  "object": "payment",
  "id": "pay_01j9x3kq7m4tzv8qhw2n",
  "amount": 10000,
  "currency": "XOF",
  "status": "requires_payment",
  "description": "Commande 42",
  "reference": "cmd-42",
  "metadata": {},
  "fees_paid_by": "merchant",
  "amount_paid": null,
  "fee": null,
  "net": null,
  "amount_refunded": 0,
  "payment_url": "https://pay.payiz.app/pay_01j9x3kq7m4tzv8qhw2n",
  "return_url": "https://boutique.bj/merci",
  "expires_at": 1790089092,
  "paid_at": null,
  "available_at": null,
  "latest_attempt": null,
  "created": 1790002692,
  "livemode": false
}
```