GET
/
search
Rechercher des Transactions
curl --request GET \
  --url https://sandbox.fapshi.com/search \
  --header 'apikey: <api-key>' \
  --header 'apiuser: <api-key>'
[
  {
    "transId": "<string>",
    "status": "CREATED",
    "medium": "mobile money",
    "serviceName": "<string>",
    "amount": 123,
    "revenue": 123,
    "payerName": "<string>",
    "email": "jsmith@example.com",
    "redirectUrl": "<string>",
    "externalId": "<string>",
    "userId": "<string>",
    "webhook": "<string>",
    "financialTransId": "<string>",
    "dateInitiated": "2023-12-25",
    "dateConfirmed": "2023-12-25"
  }
]

Endpoint

GET /search

Recherchez des transactions selon des critères.

Paramètres de requête

NomDescriptionValeurs acceptées
statusFiltrer les transactions par statut.created, successful, failed, expired
mediumFiltrer par moyen de paiement.mobile money, orange money
startDate de début (AAAA-MM-JJ) pour filtrer les transactions initiées.Format date
endDate de fin (AAAA-MM-JJ) pour filtrer les transactions initiées.Format date
amtMontant exact pour filtrer.Entier
limitNombre maximum de résultats (par défaut 10).1 à 100
sortOrdre de tri : asc ou desc. Par défaut, ordre descendant (le plus récent en premier).asc, desc
Les valeurs invalides des paramètres de requête sont ignorées.

Authorizations

apiuser
string
header
required
apikey
string
header
required

Query Parameters

status
enum<string>

Filtrer par statut de transaction.

Available options:
created,
successful,
failed,
expired
medium
enum<string>

Filtrer par moyen de paiement.

Available options:
mobile money,
orange money
start
string

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

end
string

Date de fin (AAAA-MM-JJ).

amt
integer

Montant exact à filtrer.

limit
integer
default:10

Nombre maximum de résultats.

Required range: 1 <= x <= 100
sort
enum<string>
default:desc

Ordre de tri.

Available options:
asc,
desc

Response

200
application/json

Liste filtrée des transactions

The response is of type object[].