POST
/
payout
Effectuer un Paiement Sortant
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

Envoyez de l’argent sur le compte mobile money ou bancaire d’un utilisateur via un service de retrait.

Une fois les retraits activés pour un service, ce service ne peut plus collecter de paiements. Utilisez des services distincts pour la collecte et les retraits.

​
Paramètres

NomRequisTypeDescription
amountOuientierMontant à envoyer (minimum 100 XAF).
phoneOuichaîneNuméro de téléphone du bénéficiaire (ex. : 67XXXXXXX).
mediumNonchaîne"mobile money" ou "orange money". Détecté automatiquement si omis.
nameNonchaîneNom du bénéficiaire.
emailNonchaîneEmail du bénéficiaire pour recevoir le reçu de confirmation du retrait.
userIdNonchaîneID utilisateur de votre système pour le suivi des retraits (1-100 caractères; autorisés : a-z, A-Z, 0-9, -, _).
externalIdNonchaîneID de transaction/commande pour la réconciliation (1-100 caractères; autorisés : a-z, A-Z, 0-9, -, _).
messageNonchaîneDescription ou motif du retrait.

Authorizations

​
apiuser
string
header
required
​
apikey
string
header
required

Body

application/json

Response

200
application/json

Accepté

The response is of type object.