Demandes de retrait

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/payout-requests	Lister vos demandes de retrait
POST	/v1/payout-requests	Demander un retrait
GET	/v1/payout-requests/{id}	Consulter une demande de retrait

GET /v1/payout-requests

Lister vos demandes de retrait

Vos demandes et leur état, de requested à la décision.

Paramètres

Nom	Emplacement	Requis	Description
page	query	non
per_page	query	non

Réponses

• 200 — OK
• 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/payout-requests

Demander un retrait

Demande le retrait de VOTRE solde vers votre compte.

⚠️ C'EST UNE DEMANDE, PAS UN VERSEMENT. Aucun argent ne bouge et rien n'est réservé : l'opération s'ouvre au statut requested et une personne la décide dans le tableau de bord. C'est la séparation maker-checker, la clé API étant le demandeur et un propriétaire du compte le décideur. Il n'existe délibérément aucune annulation — une demande en attente ne retient rien, donc elle se rejette côté décideur plutôt qu'elle ne se retire.

ⓘ Le contrôle de solde fait ici est INDICATIF. Vous voyez un solde agrégé ; les fonds vivent dans des poches par (plateforme, pays) et le décideur choisit laquelle débiter. Le contrôle qui fait foi est l'interdiction de découvert du grand livre, au moment du règlement.

⚠️ La tarification est FERMÉE PAR DÉFAUT : sans grille de frais de retrait configurée pour cet actif, la demande est refusée (409). Un retrait gratuit est une ligne à zéro saisie exprès, jamais une absence.

Paramètres

Nom	Emplacement	Requis	Description
Idempotency-Key	header	non	Clé d'idempotence propre à CETTE opération.

Corps de la requête

Champ	Type	Requis	Description
asset_id	integer	oui
amount_minor	string	oui	Montant BRUT en unités mineures ; les frais en sont déduits, ils ne s'y ajoutent pas.
description	string	non	Votre note, lue par la personne qui décide.
destination	object	non	Où vous voulez les fonds. Champ libre : une personne le lit, aucun rail ne l'analyse.
destination.phone	string	non
destination.iban	string	non
destination.bank	string	non

Réponses

• 200 — Rejeu idempotent — la demande existait déjà
• 201 — Demande enregistrée
• 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 — Aucune grille de frais de retrait configurée pour cet actif (Error)
• 422 — Montant inférieur aux frais, ou solde disponible insuffisant (Error)
• 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After (Error)

GET /v1/payout-requests/{id}

Consulter une demande de retrait

ⓘ Une opération qui n'est pas un retrait répond 404 sur ce chemin, même si elle vous appartient : sans ce contrôle, un identifiant confondu rendrait un statut appartenant à un autre cycle de vie.

Paramètres

Nom	Emplacement	Requis	Description
id	path	oui	L'identifiant ou la référence de la demande.

Réponses

• 200 — OK (object)
• 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)
• 404 — Aucune demande de retrait de cet identifiant (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.

Error

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