Skip to main content
POST
Create a payout

Authorizations

Authorization
string
header
required

Scoped Bearer token from POST /merchant/api/auth.

Body

application/json
amount
number<float>
required
Example:

25000

payment_method
enum<string>
required

Destination method for payouts (BankTransfer not yet supported).

Available options:
OrangeMoney,
Wave,
Sama,
Moov,
BankTransfer
destination_phone
string

Required unless destination_account is given.

destination_account
string

Bank account (not yet supported).

reference
string
scheduled_at
string<date-time>

Future date to schedule the payout.

Response

Payout created (pending, scheduled, or completed).

success
boolean
Example:

true

message
string
request_id
string<uuid>
data
object