Skip to main content
POST
/
payouts
Initiate PayOut
curl --request POST \
  --url https://getmipay.com/api/v1/payouts \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'operation: <operation>' \
  --header 'service: <service>' \
  --data '{
  "amount": 5000,
  "currency": "XAF",
  "wallet": "237690000000",
  "description": "Refund for Order #456",
  "customer_name": "Jane Smith"
}'
{
  "success": true,
  "message": "Payout initiated successfully",
  "data": {
    "transaction_reference": "MPAYOUT_XYZ789GHI123",
    "soleaspay_reference": "MLS690d472dd7ee7C",
    "amount": 5000,
    "currency": "XAF",
    "status": "pending"
  }
}

Authorizations

​
X-API-KEY
string
header
required

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 length: 255
Example:

"Refund for Order #456"

​
customer_name
string
required
Maximum length: 255
Example:

"Jane Smith"

Response

Payout initiated successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Payout initiated successfully"

​
data
object