neo-pays

Versements

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/payouts Lister les versements
POST /v1/payouts Effectuer un versement
GET /v1/payouts/{id} Consulter un versement

GET /v1/payouts

Lister les versements

Même pagination que les encaissements.

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/payouts

Effectuer un versement

Envoi vers un porte-monnaie mobile ou un compte bancaire. Scope can_payout requis, et le compte doit être activé pour le mode réel.

⚠️ Un versement RÉSERVE les fonds à la création : un solde insuffisant est refusé sur le champ, il n'existe aucun découvert.

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 — Versement 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/payouts/{id}

Consulter un versement

La même vue masquée que GET /v1/payments/{id}, avec le même contrôle de propriété.

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