Skip to main content
POST
Demander un retrait
Un retrait fait sortir de l’argent réel de la plateforme — le header Idempotency-Key est requis. Sans lui, deux requêtes identiques (double-clic, retry réseau) créeraient deux retraits distincts, débitant chacun votre solde séparément. Voir Idempotence.
Nécessite une clé API avec le scope PAYOUT. La méthode de retrait ciblée doit appartenir à votre marchand et être is_verified: true — une méthode fraîchement créée ne l’est jamais, un administrateur doit la vérifier au préalable. Toutes les erreurs métier (invalid_payout_method, payout_method_not_verified, wallet_frozen, insufficient_balance) sont renvoyées en 422.

Authorizations

Authorization
string
header
required

Clé API secrète du marchand — header Authorization: Bearer sk_live_xxx (ou sk_test_xxx en environnement de test).

Headers

Idempotency-Key
string<uuid>
required

Valeur unique par tentative logique de retrait — rejouer la même clé avec le même corps renvoie la réponse d'origine.

Body

application/json
payout_method
string<uuid>
required
country
string
required

Code ISO2 du pays, ex BJ

requested_amount
string<decimal>
required

Response

Retrait créé