Skip to main content
GET
Rechercher des Transactions

Endpoint

GET /search Recherchez des transactions selon des critères.

Paramètres de requête

Les valeurs invalides des paramètres de requête sont ignorées.

Autorisations

apiuser
string
header
requis
apikey
string
header
requis

Paramètres de requête

status
enum<string>

Filtrer par statut de transaction.

Options disponibles:
created,
successful,
failed,
expired
medium
enum<string>

Filtrer par moyen de paiement.

Options disponibles:
mobile money,
orange money
start
string<date>

Date de début (AAAA-MM-JJ).

end
string<date>

Date de fin (AAAA-MM-JJ).

amt
integer

Montant exact à filtrer.

limit
integer
défaut:10

Nombre maximum de résultats.

Plage requise: 1 <= x <= 100
sort
enum<string>
défaut:desc

Ordre de tri.

Options disponibles:
asc,
desc

Réponse

Liste filtrée des transactions

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é