Paiements
Récupérer la liste des paiements
Cet endpoint permet de récupérer la liste des paiements sur une période donnée
La recherche est effectuée par défaut sur la période depuis le début du mois courant et pour paiements effectués ou en cours Filtres appliqués pour une recherche :
- La période de recherche : elle est composée d'une date de début (startDate) et une date de fin (endDate).
- Le/les statut(s) des paiements : le filtre statues, indique le ou les statut(s) des paiements à retourner. Par défaut, seuls paiements au status en cours (PENDING) ou effectués (SUCCESS) sont retournés.
Règles applicables :
- Période de recherche : si une des dates (startDate et endDate) de recherche n'est pas fournie ou la date fin est antérieure à la date de début alors une erreur 404 est retournée. Si aucune date n'est fournie, alors la période allant du début du mois courant jusqu'à la date de la demande est appliquée.
- Le/les statut(s) de paiements, une recherche peut se faire avec un ou plusieurs status séparés par une virgule. À titre d'exemple pour retourner uniquement les paiement effectués (SUCCESS) et échoués (FAILED) la valeur du paramètre sera : SUCCESS,FAILED. Si le paramètre statuses n'est pas fourni ou est vide, alors seuls les paiements aux statuts en cours (PENDING) et effectués (SUCCESS) sont retournés. La liste des statuts est la suivante : CREATED, PENDING, SUCCESS, CANCELLED et FAILED
⚠️Une liste de 100 éléments (paiements) est retournée à la fois, sous forme de pagination. Vous pouvez dans le cas où il y a plus de 100 éléments vous appuyez sur la/les page(s) suivante(s)
🔒 Sécurité : Cet appel nécessite :
- Un en-tête Authorization : Bearer <jwt_token>
- Un en-tête X-API-KEY : clientId:signature
La signature HMAC-SHA256 est calculée de la façon suivante :
signature = HMAC_SHA256(clientId, clientSecret)
X-API-KEY = clientId:signature
Exemple :
X-API-KEY: djomy-merchant-001:ab56b4d92b40713acc5af89985d4b786
get/v1/payments
Request
- Base URL: https://sandbox-api.djomy.africa
- URL: https://sandbox-api.djomy.africa/v1/payments
- Auth: API key in header X-API-KEY and HTTP bearer
Query parameters
statusesstring
startDatestring date
Date de début (optionnelle)
endDatestring date
Date de fin (optionnelle)
Response
Statut de la transaction récupéré avec succès
Changes
No recorded changes to this operation across all 1 revision of this API.