Skip to main content
POST
/
payment
/
payout
Initiate a payout
curl --request POST \
  --url https://api.cartevo.co/api/v1/payment/payout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operator": "mtn",
  "country": "CM",
  "phone_number": "237670000000",
  "amount": 1000,
  "currency": "XAF",
  "notify_url": "https://example.com/webhook/payout"
}
'
{
  "success": true,
  "message": "Payout initiated successfully",
  "data": {
    "transaction_id": "550e8400-e29b-41d4-a716-446655440000",
    "external_id": "PAYOUT-1234567890-abc12345",
    "status": "PENDING",
    "amount": 1000,
    "currency": "XAF",
    "operator": "mtn",
    "country": "CM",
    "phone_number": "237670000000",
    "initiated_at": "2025-01-08T12:00:00.000Z",
    "error_message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
operator
enum<string>
required
Available options:
mtn,
orange,
moov,
airtel,
mpesa,
afrimoney,
vodacom,
wave,
wligdicash,
expresso,
free,
tmoney,
celtiis,
coris
Example:

"mtn"

​
country
string
required
Example:

"CM"

​
phone_number
string
required
Example:

"237670000000"

​
amount
number
required
Required range: x >= 1
Example:

1000

​
currency
string
required
Example:

"XAF"

​
notify_url
string
Example:

"https://example.com/webhook/payout"

Response

Payout initiated successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Payout initiated successfully"

​
data
object