Virements (Payouts)

Les virements permettent d'envoyer des fonds vers des numéros mobile money.

POST /payouts

Initie un virement sortant.

Corps de la requête

Champ	Type	Requis	Description
amount	number	✅	Montant en unité de devise
currency	string	—	XOF par défaut
operator	string	✅	Slug de l'opérateur
merchantRef	string	✅	Référence interne marchand
recipientPhone	string	✅	Numéro du destinataire
recipientName	string	—	Nom du destinataire
notifyUrl	string	—	URL webhook de notification
description	string	—	Motif du virement
metadata	object	—	Données libres

Exemple

POST /api/v1/payouts
Authorization: Bearer mbp_live_xxxx
Content-Type: application/json

{
  "amount": 25000,
  "currency": "XOF",
  "operator": "mtn-momo-cm",
  "merchantRef": "PAYOUT-2024-001",
  "recipientPhone": "670000000",
  "recipientName": "Marie Martin",
  "notifyUrl": "https://votresite.com/webhooks"
}

Réponse

{
  "reference": "PAO-20240615-ABCD",
  "status": "pending",
  "amount": 25000,
  "currency": "XOF"
}

GET /payouts/:reference

Récupère le statut d'un virement.

GET /payouts

Liste les virements du marchand.

Paramètres de query

Paramètre	Type	Description
page	number	Numéro de page (défaut: 1)
limit	number	Résultats par page (max: 100)
status	string	Filtrer par statut