Passer au contenu principal
POST
/
initiate-pay
Générer un Lien de Paiement
curl --request POST \
  --url https://sandbox.fapshi.com/initiate-pay \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'apiuser: <api-key>' \
  --data '
{
  "amount": 101,
  "email": "jsmith@example.com",
  "redirectUrl": "<string>",
  "userId": "<string>",
  "externalId": "<string>",
  "message": "<string>"
}
'
{
  "message": "<string>",
  "link": "<string>",
  "transId": "<string>",
  "dateInitiated": "2023-12-25"
}

Documentation Index

Fetch the complete documentation index at: https://docs.fapshi.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint

POST /initiate-pay Générez un lien de paiement où les utilisateurs pourront compléter leur paiement sur une page de paiement préconstruite par Fapshi.

​
Paramètres

NomObligatoireTypeDescription
amountOuientierMontant à payer (minimum 100 XAF).
emailNonchaîneSi renseigné, l’utilisateur n’aura pas à fournir son email lors du paiement.
redirectUrlNonchaîneURL vers laquelle l’utilisateur sera redirigé après le paiement.
userIdNonchaîneID utilisateur interne (1-100 caractères ; a-z, A-Z, 0-9, -, _).
externalIdNonchaîneID de transaction/commande pour réconciliation (1-100 caractères ; a-z, A-Z, 0-9, -, _).
messageNonchaîneRaison du paiement.

​
Réponse

  • 200 OK avec un corps JSON contenant :
    • message : message de succès
    • link : URL où l’utilisateur doit effectuer le paiement
    • transId : ID de la transaction pour suivre le statut du paiement
    • dateInitiated : date de début du paiement
  • En cas d’erreur, retournera un code 4XX avec un message expliquant l’échec.
Les liens de paiement expirent au bout de 24 heures et ne peuvent plus être utilisés après cette période.

Autorisations

​
apiuser
string
header
requis
​
apikey
string
header
requis

Corps

application/json
​
amount
integer
requis

Montant à payer (minimum 100 XAF).

Plage requise: x >= 100
​
email
string<email>

Email de l'utilisateur facultatif à ignorer lors du paiement.

​
redirectUrl
string<uri>

URL de redirection après le paiement.

​
userId
string

Identifiant interne de l'utilisateur (1-100 caractères ; a-z, A-Z, 0-9, -, _).

Pattern: ^[a-zA-Z0-9\-_]{1,100}$
​
externalId
string

Identifiant de transaction/commande pour la réconciliation (1-100 caractères ; a-z, A-Z, 0-9, -, _).

Pattern: ^[a-zA-Z0-9\-_]{1,100}$
​
message
string

Motif du paiement.

Réponse

Lien de paiement généré avec succès

​
message
string

Message de succès

​
link
string<uri>

URL pour rediriger l'utilisateur afin de compléter le paiement.

​
transId
string

Identifiant de la transaction pour le paiement.

​
dateInitiated
string<date>

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