Skip to main content
POST
Demander un retrait
En live, il faut que votre vérification d’identité soit approuvée. En sandbox, le retrait part tout de suite depuis votre solde de test, vers un numéro Mobile Money de test.
La demande n’est pas exécutée tout de suite : elle est d’abord validée, puis envoyée à l’opérateur. Suivez-la avec les webhooks payout.*. Voir Demander un retrait.

Authorizations

Authorization
string
header
required

Votre clé API. Utilisez une clé sandbox (mp_sandbox_…) pour essayer : aucun argent réel ne bouge.

Headers

Idempotency-Key
string
required

Obligatoire ici. Une clé unique par opération : la rejouer pendant 24 heures renvoie la même réponse sans rien créer de plus. Voir Idempotence.

Maximum string length: 255

Body

application/json
amount
integer
required

Montant débité de votre solde, en unités mineures

Required range: x >= 1
currency
string
required

Devise du solde source. Code devise ISO 4217 de 3 lettres, par exemple XAF.

Required string length: 3
destination_id
string<uuid>

Compte de retrait enregistré dans votre tableau de bord. Remplace destination.

destination
object

Obligatoire sans destination_id.

metadata
object

Vos données libres (jusqu'à 50 clés, valeurs de 500 caractères au plus), renvoyées dans les réponses et les webhooks. Par exemple votre numéro de commande.

Response

Retrait demandé

data
object