Passer au contenu principal
GET
/
payment-status
/
{transId}
Obtenir le Statut d'une Transaction de Paiement
curl --request GET \
  --url https://sandbox.fapshi.com/payment-status/{transId} \
  --header 'apikey: <api-key>' \
  --header 'apiuser: <api-key>'
{
  "transId": "<string>",
  "serviceName": "<string>",
  "amount": 123,
  "revenue": 123,
  "payerName": "<string>",
  "email": "jsmith@example.com",
  "redirectUrl": "<string>",
  "externalId": "<string>",
  "userId": "<string>",
  "webhook": "<string>",
  "reason": "<string>",
  "financialTransId": "<string>",
  "dateInitiated": "2023-12-25",
  "dateConfirmed": "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

GET /payment-status/:transId Vérifiez le statut d’un paiement via son identifiant de transaction.

​
Valeurs du statut

StatutSignification
CREATEDPaiement pas encore tenté.
PENDINGL’utilisateur est en cours de paiement.
SUCCESSFULPaiement complété avec succès.
FAILEDPaiement échoué.
EXPIREDCela signifie que 24 heures se sont écoulées depuis la génération du lien de paiement sans qu’aucune tentative de paiement réussie n’ait été effectuée, OU que le lien a été expiré manuellement pour empêcher le paiement.
Aucun paiement ne peut être effectué une fois le statut SUCCESSFUL ou EXPIRED.
Pour un identifiant de transaction donné, vous pouvez effectuer au maximum 6 requêtes par minute. Au-delà de cette limite, l’API renvoie une réponse 429.Il est généralement préférable de s’appuyer sur les notifications webhook pour savoir quand le statut d’un paiement change, plutôt que d’interroger cet endpoint en boucle.

Autorisations

​
apiuser
string
header
requis
​
apikey
string
header
requis

Paramètres de chemin

​
transId
string
requis

Identifiant de la transaction du paiement.

Réponse

Statut du paiement récupéré avec succès

​
transId
string

Identifiant de la transaction du paiement.

​
status
enum<string>

Statut de la transaction

Options disponibles:
CREATED,
PENDING,
SUCCESSFUL,
FAILED,
EXPIRED
​
medium
enum<string>

Méthode de paiement

Options disponibles:
mobile money,
orange money
​
serviceName
string

Nom du service utilisé

​
transType
enum<string>

Type de transaction

Options disponibles:
Collection,
Payout
​
amount
integer

Montant de la transaction

​
revenue
integer

Montant reçu après déduction des frais Fapshi

​
payerName
string

Nom du client

​
email
string<email>

Email du client

​
redirectUrl
string<uri>

URL de redirection après le paiement

​
externalId
string

Identifiant de la transaction sur votre application

​
userId
string

Identifiant du client sur votre application

​
webhook
string<uri>

Le webhook que vous avez défini pour votre service

​
reason
string

Apparaît généralement lorsqu'un retrait via fapshi échoue.

​
financialTransId
string

Identifiant de la transaction avec l'opérateur de paiement

​
dateInitiated
string<date>

Date à laquelle le paiement a été initié

​
dateConfirmed
string<date>

Date à laquelle le paiement a été effectué