Skip to main content
POST
Initier un payout
Whitelist IP obligatoire pour une clé API. Si aucune IP n’est whitelistée pour votre marchand, cet appel échoue avec 403 ip_not_whitelisted, quelle que soit la validité de votre clé. Ajoutez l’IP de votre serveur depuis votre tableau de bord ou l’API de gestion du marchand avant votre premier appel. Ce prérequis ne s’applique pas à un appel authentifié via le dashboard (JWT).
Contrairement à l’encaissement, le mismatch entre currency et country est ici rejeté (422 currency_country_mismatch), sans conversion automatique.

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).

Body

application/json
amount
string<decimal>
required
Example:

"10000.00"

currency
string
required
Required string length: 3
Example:

"XAF"

country
string
required
Required string length: 2
Example:

"CM"

customer
object
required
method
string
required

Code réseau du bénéficiaire

Example:

"mtn_cm"

recipient
object
required
merchant
string<uuid>

UUID du marchand visé. Ignoré pour une clé API (toujours vous-même).

description
string
Example:

"Remboursement commande #778"

metadata
object
fee_charge_mode
enum<string> | null

ADD_ON : les frais s'ajoutent au montant débité au client. DEDUCTED : les frais sont déduits du montant net reversé au marchand. Défaut : configuration du marchand.

Available options:
ADD_ON,
DEDUCTED
preferred_gateway
string

Response

Payout initialisé