Passer au contenu principal
POST
/
direct-pay
Initier une Demande de Paiement Direct
curl --request POST \
  --url https://sandbox.fapshi.com/direct-pay \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'apiuser: <api-key>' \
  --data '
{
  "amount": 101,
  "phone": "<string>",
  "medium": "mobile money",
  "name": "<string>",
  "email": "[email protected]",
  "userId": "<string>",
  "externalId": "<string>",
  "message": "<string>"
}
'
{
  "message": "<string>",
  "transId": "<string>",
  "dateInitiated": "2023-12-25"
}

​
Endpoint

POST /direct-pay Envoyez une demande de paiement directement sur le mobile d’un utilisateur. Vous êtes responsable de la création de votre propre formulaire de paiement et de la vérification du statut du paiement.
Les transactions de paiement direct ne peuvent et ne s’expirent pas. Par conséquent, leur état final est soit SUCCESSFUL soit FAILED.
Le paiement direct est désactivé par défaut dans l’environnement Live. Suivez les étapes du guide Activer le paiement direct sur votre API Fapshi en mode Live pour activer le paiement direct en mode live.
Manipulez ce point de terminaison avec précaution ; toute mauvaise utilisation peut entraîner la suspension de votre compte.

​
Paramètres

NomObligatoireTypeDescription
amountOuientierMontant à payer (minimum 100 XAF).
phoneOuichaîneNuméro de téléphone pour la demande de paiement (exemple : 67XXXXXXX).
mediumNonchaîne"mobile money" ou "orange money". À omettre pour détection automatique.
nameNonchaîneNom du payeur.
emailNonchaîneEmail du payeur pour recevoir le reçu.
userIdNonchaîneID utilisateur dans votre système (1–100 caractères; a–z, A–Z, 0–9, -, _ autorisés).
externalIdNonchaîneID de transaction ou commande pour rapprochement (1–100 caractères; mêmes règles).
messageNonchaîneMotif du paiement.

​
Réponse

  • 200 OK avec un corps JSON contenant :
    • message : message de succès
    • transId : ID de la transaction pour suivre le paiement
    • dateInitiated : date de l’initiation du paiement
  • En cas d’erreur, un code 4XX avec un message d’échec est retourné.

Authorizations

​
apiuser
string
header
required
​
apikey
string
header
required

Body

application/json
​
amount
integer
required

Montant à payer (minimum 100 XAF).

Plage requise: x >= 100
​
phone
string
required

Numéro de téléphone où la demande de paiement est envoyée.

​
medium
enum<string>

Moyen de paiement (facultatif).

Options disponibles:
mobile money,
orange money
​
name
string

Nom du payeur (facultatif).

​
email
string<email>

Email du payeur pour les reçus (facultatif).

​
userId
string

Identifiant interne de l'utilisateur (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é.