Payouts

Send funds to mobile money wallets or bank accounts.

Ikawaari currently exposes both a public payout route family and merchant-scoped payout management routes.

The Payout object

{
  "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
}

Public route family

Method	Endpoint	Description
POST	/payouts	Create a payout
GET	/payouts/{id}	Retrieve a payout

Create a Payout

POST /payouts

Parameter	Type	Required	Description
amount	integer	✅	Amount in smallest currency unit
currency	string	✅	Three-letter ISO currency code
destination	object	✅	Destination details
description	string		Description
metadata	object		Key-value metadata

Merchant payout management routes

Merchant operational routes are available under:

• 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}

Legacy-compatible merchant paths may also be available under api/merchant/*.

Integration note

The docs should not currently advertise payout cancellation or public payout listing unless those public endpoints are explicitly implemented on the exposed controller.