Passer au contenu principal
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 Envoyer de l’argent sur le compte mobile money, orange money ou fapshi d’un utilisateur via un service activé pour les retraits.
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).
phoneConditionnelchaîneNuméro de téléphone du bénéficiaire (ex. : 67XXXXXXX). Requis lorsque medium n’est pas spécifié ou n’est pas "fapshi".
mediumNonchaîne"mobile money", "orange money", ou "fapshi". Détecté automatiquement si omis (nécessite phone). Lorsqu’il est défini sur "fapshi", email est requis à la place de phone.
nameNonchaîneNom du bénéficiaire.
emailConditionnelchaîneEmail du bénéficiaire. Requis lorsque medium est "fapshi". Facultatif pour recevoir le reçu de confirmation du retrait lorsque medium n’est pas "fapshi".
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.

​
Champs Requis

  • Lorsque medium n’est pas spécifié : amount et phone sont requis.
  • Lorsque medium est "fapshi" : amount et email sont requis.

​
Tests en Environnement Sandbox

Lors des tests de retraits avec medium défini sur "fapshi" dans l’environnement sandbox :
  • Emails qui retournent toujours des transactions réussies : test.success@fapshi.com et messi.champion@fapshi.com
  • Emails qui retournent toujours des transactions échouées : test.failed@fapshi.com et penaldo.test@fapshi.com
  • Autres emails : Le statut de la transaction sera déterminé de manière stochastique (aléatoire)

Authorizations

​
apiuser
string
header
required
​
apikey
string
header
required

Body

application/json
​
amount
integer
required

Montant à envoyer (minimum 100 XAF).

Required range: x >= 100
​
phone
string

Numéro de téléphone du destinataire. Requis lorsque medium n'est pas spécifié ou n'est pas "fapshi". Non requis lorsque medium est "fapshi".

​
medium
enum<string>

Moyen de paiement (facultatif). Détecté automatiquement si omis (nécessite phone). Lorsqu'il est défini sur "fapshi", email est requis à la place de phone.

Options disponibles:
mobile money,
orange money,
fapshi
​
name
string

Nom du destinataire (facultatif).

​
email
string<email>

Email du destinataire. Requis lorsque medium est "fapshi". Facultatif pour le reçu de paiement lorsque medium n'est pas "fapshi".

​
userId
string

Identifiant utilisateur pour le suivi du paiement (facultatif).

​
externalId
string

Identifiant de transaction/commande pour la réconciliation (facultatif).

​
message
string

Motif du paiement (facultatif).

Response

Accepté

​
message
string

Message de succès

​
transId
string

Identifiant de la transaction pour le paiement.

​
dateInitiated
string<date>

Date à laquelle le paiement a été initié.