POST
/
payout
Make a Payout
curl --request POST \
  --url https://sandbox.fapshi.com/payout \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'apiuser: <api-key>' \
  --data '{
  "amount": 101,
  "phone": "<string>",
  "medium": "mobile money",
  "name": "<string>",
  "email": "jsmith@example.com",
  "userId": "<string>",
  "externalId": "<string>",
  "message": "<string>"
}'
{
  "message": "<string>",
  "transId": "<string>",
  "dateInitiated": "2023-12-25"
}

​
Endpoint

POST /payout

Send money to a user’s mobile money account or bank via a payout service.

After enabling payouts for a service, that service can no longer collect payments. Use separate services for collections and payouts.

​
Parameters

NameRequiredTypeDescription
amountYesintegerAmount to send (minimum 100 XAF).
phoneYesstringRecipient phone number (e.g., 67XXXXXXX).
mediumNostring"mobile money" or "orange money". Auto-detected if omitted.
nameNostringRecipient’s name.
emailNostringRecipient’s email for payout confirmation receipt.
userIdNostringYour system’s user ID for payout tracking (1-100 chars; allowed: a-z, A-Z, 0-9, -, _).
externalIdNostringTransaction/order ID for reconciliation (1-100 chars; allowed: a-z, A-Z, 0-9, -, _).
messageNostringDescription or reason for payout.

Authorizations

​
apiuser
string
header
required
​
apikey
string
header
required

Body

application/json

Response

200
application/json

Accepted

The response is of type object.