# Lire un lien

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

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

Un lien, avec ce qu’il a encaissé.

## Ce qu'on reçoit

`200` · un objet `payment_link`

| Champ | Type | Requis | Ce que c'est |
| --- | --- | --- | --- |
| `object` | « payment_link » | — | Le genre de l’objet rendu : il ne change jamais. |
| `id` | texte | — | Un identifiant préfixé « lnk_ », par exemple lnk_01j9x3kq7m4tzv8qhw2n. |
| `url` | texte | — | L’adresse à partager, et son QR code. |
| `title` | texte | — | Le titre que le payeur lit en haut de la page. |
| `description` | texte ou null | — | Ce que le payeur lit sous le titre. |
| `type` | « fixed » · « open » | — | « open » : le payeur choisit le montant. |
| `amount` | entier ou null | — | Le prix, quand il est fixe. |
| `min_amount` | entier ou null | — | Le plancher, quand le payeur choisit son montant. |
| `max_amount` | entier ou null | — | Le plafond, quand le payeur choisit son montant. |
| `currency` | texte | — | Le code ISO 4217, en majuscules. |
| `reusable` | vrai ou faux | — | Faux : le lien se ferme au premier paiement réussi. |
| `fees_paid_by` | « merchant » · « customer » | — | Qui porte la commission sur les paiements de ce lien. |
| `collect` | liste de « name » · « email » · « address » | — | Ce qu’on demande au payeur, l’e-mail toujours compris. |
| `active` | vrai ou faux | — | Faux : le lien est fermé, sa page ne prend plus rien. |
| `payments_count` | entier | — | Combien de paiements réussis ce lien a portés. |
| `amount_collected` | entier | — | Ce que ce lien a encaissé en tout. |
| `expires_at` | entier ou null | — | Des secondes depuis 1970, 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/payment_links/lnk_01j9xc4qv2n8ywd3hs6m \
  -H "Authorization: Bearer sk_test_…"
```

## La réponse

```json
{
  "object": "payment_link",
  "id": "lnk_01j9xc4qv2n8ywd3hs6m",
  "url": "https://pay.payiz.app/l/robe-wax-brodee",
  "title": "Robe wax brodée",
  "description": "Taille unique, livraison sous 48 h.",
  "type": "fixed",
  "amount": 12500,
  "min_amount": null,
  "max_amount": null,
  "currency": "XOF",
  "reusable": true,
  "fees_paid_by": "merchant",
  "collect": [
    "email",
    "name"
  ],
  "active": true,
  "payments_count": 2,
  "amount_collected": 25000,
  "expires_at": null,
  "created": 1789998092,
  "livemode": false
}
```