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 (PaymentLinkList)
• 401 — Clé API manquante ou rejetée (Error)
• 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif (Error)
• 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After (Error)

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).

Corps de la requête

Champ	Type	Requis	Description
title	string	oui	Ce que le payeur voit en tête de page.
description	string	non
amount_minor	string	non	Montant en UNITÉS MINEURES, en chaîne de caractères. Jamais un nombre à virgule flottante : les deux perdent des centimes. Le nombre de décimales de l'actif est donné par GET /v1/assets.
asset_id	integer	oui
is_reusable	boolean	non	Un lien réutilisable accepte plusieurs paiements.
max_uses	integer	non	Plafond d'utilisations pour un lien réutilisable.
allowed_platform_ids	integer[]	non	Restreint les moyens de paiement proposés.
expires_in_seconds	integer	non

Réponses

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

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 (PaymentLink)
• 401 — Clé API manquante ou rejetée (Error)
• 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif (Error)
• 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After (Error)

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.

Corps de la requête

Champ	Type	Requis	Description
is_active	boolean	oui

Réponses

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

Schémas

Les formes renvoyées par les opérations ci-dessus.

PaymentLinkList

Champ	Type	Description
data	PaymentLink[]
data[].id	string
data[].url	string
data[].title	string
data[].amount_minor	string
data[].asset_id	integer
data[].is_active	boolean
data[].is_reusable	boolean
data[].max_uses	integer
data[].uses	integer
page	integer
per_page	integer

Error

Champ	Type	Description
error	object
error.code	string
error.message	string

PaymentLink

Champ	Type	Description
id	string
url	string
title	string
amount_minor	string
asset_id	integer
is_active	boolean
is_reusable	boolean
max_uses	integer
uses	integer