Payouts

Send funds to mobile money wallets or bank accounts.

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
}

Endpoints

Method	Endpoint	Description
POST	/v1/payouts	Create a payout
GET	/v1/payouts/{id}	Retrieve a payout
POST	/v1/payouts/{id}/cancel	Cancel a payout
GET	/v1/payouts	List payouts

Create a Payout

POST /v1/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