Paiements
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/payments |
Lister les encaissements |
POST |
/v1/payments |
Créer un encaissement |
GET |
/v1/payments/{id} |
Consulter une opération |
GET /v1/payments
Lister les encaissements
Lecture servie par le modèle de lecture, sur un réplica : aucun rapport ne peut ralentir un paiement.
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— OK401— Clé API manquante ou rejetée403— La clé ne porte pas le scope requis, ou le compte n'est pas actif429— Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After
POST /v1/payments
Créer un encaissement
Crée une opération d'encaissement et retourne de quoi faire payer le client — une URL de paiement, un lien profond ou un QR selon le rail. asset_id et platform_id sont des identifiants, pas des symboles : GET /v1/assets et GET /v1/corridors donnent ceux que le compte peut utiliser. Omettre rail laisse le routage choisir ; le nommer force un rail et échoue plutôt que de basculer.
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— Opération créée401— Clé API manquante ou rejetée403— La clé ne porte pas le scope requis, ou le compte n'est pas actif409— Clé d'idempotence rejouée avec une charge utile différente422— Requête recevable mais refusée : champ manquant, corridor fermé, solde insuffisant429— Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After
GET /v1/payments/{id}
Consulter une opération
Lecture locale : rien n'est demandé au rail. Les coordonnées du payeur sont masquées, parce que le modèle de lecture ne détient jamais les brutes.
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— OK401— Clé API manquante ou rejetée403— La clé ne porte pas le scope requis, ou le compte n'est pas actif404— Inconnue, ou appartenant à un autre compte429— Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After