Skip to main content
POST
Initiate PayOut

Authorizations

Authorization
string
header
required

JWT bearer token returned by POST /action/auth. Send protected requests with: Authorization: Bearer . Tokens expire after 24 hours.

Headers

operation
enum<string>
required

Operation type - must be '4' for PayOut

Available options:
4
Example:

"4"

service
string
required

Service identifier for the payment method

Example:

"1"

Body

application/json

Payout details to send to customer

amount
number
required
Required range: x >= 100
Example:

5000

currency
enum<string>
default:XAF
required
Available options:
XAF,
USD,
EUR
Example:

"XAF"

wallet
string
required
Example:

"237690000000"

description
string
required
Maximum string length: 255
Example:

"Refund for Order #456"

customer_name
string
required
Maximum string length: 255
Example:

"Jane Smith"

Response

Payout initiated successfully

success
boolean
Example:

true

message
string
Example:

"Payout initiated successfully"

data
object