neo-pays

Liens de paiement

Page générée depuis la spécification OpenAPI que la passerelle sert (GET /v1/openapi.json). Ne la modifiez pas à la main : elle est réécrite à chaque build.

Méthode Chemin Description
GET /v1/payment-links Lister les liens de paiement
POST /v1/payment-links Créer un lien de paiement
GET /v1/payment-links/{id} Consulter un lien de paiement
PATCH /v1/payment-links/{id} Activer ou désactiver un lien

GET /v1/payment-links

Lister les liens de paiement

Vos liens, actifs et désactivés.

Paramètres

Nom Emplacement Requis Description
page query non Page, à partir de 1.
per_page query non Taille de page, 100 au maximum.

Réponses

  • 200 — OK
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

POST /v1/payment-links

Créer un lien de paiement

Un lien réutilisable ou à usage unique, avec expiration et nombre d'usages. Le payeur choisit son moyen de paiement sur une page que nous hébergeons : aucune donnée de paiement ne transite par vos serveurs. Omettre amount_minor crée un lien ouvert, dont le payeur fixe le montant.

Paramètres

Nom Emplacement Requis Description
Idempotency-Key header non Clé d'idempotence propre à CETTE opération. Rejouer la même clé avec la même charge utile retourne l'originale ; la rejouer avec une charge utile différente est refusé (409).

Réponses

  • 201 — Lien créé
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 409 — Clé d'idempotence rejouée avec une charge utile différente
  • 422 — Requête recevable mais refusée : champ manquant, corridor fermé, solde insuffisant
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

GET /v1/payment-links/{id}

Consulter un lien de paiement

Le lien et son compteur d'utilisations.

Paramètres

Nom Emplacement Requis Description
id path oui Identifiant interne, référence de l'opération, ou votre propre client_ref.

Réponses

  • 200 — OK
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

PATCH /v1/payment-links/{id}

Activer ou désactiver un lien

Désactiver un lien l'arrête immédiatement pour les paiements à venir ; les paiements déjà aboutis ne sont pas touchés.

Paramètres

Nom Emplacement Requis Description
id path oui Identifiant interne, référence de l'opération, ou votre propre client_ref.

Réponses

  • 200 — OK
  • 401 — Clé API manquante ou rejetée
  • 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
  • 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After