Payouts

Envoyez des fonds vers des wallets mobile money ou des comptes bancaires.

Ikawaari expose actuellement à la fois une famille de routes publiques pour les payouts et des routes de gestion des payouts à portée marchande.

Objet Payout

{
  "id": "po_abc123",
  "object": "payout",
  "amount": 50000,
  "currency": "xof",
  "status": "paid",
  "destination": {
    "type": "mobile_money",
    "mobile_money": {
      "phone": "+2250700000000",
      "operator": "orange_ci"
    }
  },
  "description": "Supplier payment",
  "created": 1708300800
}

Famille de routes publique

Méthode	Endpoint	Description
POST	/payouts	Créer un payout
GET	/payouts/{id}	Récupérer un payout

Créer un payout

POST /payouts

Paramètre	Type	Requis	Description
amount	integer	✅	Montant dans la plus petite unité monétaire
currency	string	✅	Code devise ISO à trois lettres
destination	object	✅	Détails de destination
description	string		Description
metadata	object		Métadonnées clé-valeur

Routes de gestion des payouts côté marchand

Les routes opérationnelles marchandes sont disponibles sous :

• GET /api/v1/merchant/payouts
• GET /api/v1/merchant/payouts/{id}
• POST /api/v1/merchant/payouts
• GET /api/v1/merchant/settings/payouts
• PATCH /api/v1/merchant/settings/payouts
• POST /api/v1/merchant/settings/payouts/destinations
• DELETE /api/v1/merchant/payout-destinations/{id}

Des chemins marchands compatibles hérités peuvent aussi être disponibles sous api/merchant/*.

Note d’intégration

La documentation ne doit pas, à ce stade, annoncer l’annulation de payouts ou la liste publique des payouts sauf si ces endpoints publics sont explicitement implémentés sur le contrôleur exposé.