Lister les transactions du magasin
Retourne une liste paginée de transactions dans une plage de dates. Peut être filtrée par magasin. **Informations sur les transactions :** - Inclut les types de transactions : paiements et virements - Les transactions sont ordonnées par date de création (plus récentes en premier) - Chaque transaction inclut le montant, les frais, le statut et les informations de la contrepartie **Plage de dates :** - Par défaut : 7 derniers jours si startDate et endDate ne sont pas fournis - Plage de dates maximale : 90 jours - La date de fin doit être postérieure ou égale à la date de début - Format de date : YYYY-MM-DD **Pagination :** - Page par défaut : 1 - Limite par défaut : 100 transactions par page - Limite maximale par page : 100 transactions - Utilisez le paramètre page pour naviguer dans les résultats **Cas d'usage :** - Générer des rapports de transactions pour la comptabilité - Réconcilier les paiements et virements - Afficher l'historique des transactions dans votre application - Exporter les données de transaction pour analyse **Authentification :** Nécessite les en-têtes de clé API.
Retourne une liste paginée de transactions dans une plage de dates. Peut être filtrée par magasin.
Informations sur les transactions :
- Inclut les types de transactions : paiements et virements
- Les transactions sont ordonnées par date de création (plus récentes en premier)
- Chaque transaction inclut le montant, les frais, le statut et les informations de la contrepartie
Plage de dates :
- Par défaut : 7 derniers jours si startDate et endDate ne sont pas fournis
- Plage de dates maximale : 90 jours
- La date de fin doit être postérieure ou égale à la date de début
- Format de date : YYYY-MM-DD
Pagination :
- Page par défaut : 1
- Limite par défaut : 100 transactions par page
- Limite maximale par page : 100 transactions
- Utilisez le paramètre page pour naviguer dans les résultats
Cas d'usage :
- Générer des rapports de transactions pour la comptabilité
- Réconcilier les paiements et virements
- Afficher l'historique des transactions dans votre application
- Exporter les données de transaction pour analyse
Authentification : Nécessite les en-têtes de clé API.
Clé API pour les requêtes de l'API Partenaire
In: header
Query Parameters
Identifiant du magasin
uuidNuméro de page (commence à 1)
1 <= valueNombre de transactions par page (max 100)
1 <= value <= 100Date de début pour filtrer les transactions (YYYY-MM-DD). Par défaut, 7 jours en arrière si non fournie.
dateDate de fin pour filtrer les transactions (YYYY-MM-DD, max 90 jours depuis startDate). Par défaut, aujourd'hui si non fournie.
dateResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/partner_api/transactions"{
"total": 150,
"perPage": 20,
"currentPage": 1,
"data": [
{
"id": "txn_1234567890",
"type": "payment",
"status": "success",
"amount": {
"amount": 10000,
"currency": "XOF"
},
"fees": {
"amount": 10000,
"currency": "XOF"
},
"currency": "XOF",
"paymentMethod": "wave",
"counterpartLabel": "John Doe",
"counterpartIdentifier": "+2250701234567",
"description": "Payment for order #12345",
"reference": "REF-2025-001",
"createdAt": "2025-01-15T14:30:25.000Z"
}
]
}{
"id": "unauthorized",
"message": "Unauthorized",
"extras": "Détails supplémentaires de l'erreur"
}{
"id": "validation_error",
"message": "Échec de la validation",
"extras": {
"errors": [
{
"field": "paymentDetails.data.paymentMethod",
"rule": "in",
"message": "The paymentDetails.data.paymentMethod must be one of the following: orange, wave, mtn, moov, djamo"
},
{
"field": "paymentDetails.data.deviceId",
"rule": "required",
"message": "The paymentDetails.data.deviceId field is required when paymentDetails.type is soundbox"
}
]
}
}{
"id": "internal_error",
"message": "Une erreur inattendue s'est produite",
"extras": "Détails supplémentaires de l'erreur"
}Obtenir le solde du magasin GET
Retourne le solde disponible total pour un magasin spécifique. Le solde représente la somme des soldes disponibles de tous les portefeuilles associés au magasin. **Informations sur le solde :** - Retourne le solde disponible total sur tous les portefeuilles pour le magasin - Solde disponible = solde total - solde bloqué - Le solde est retourné dans la devise du magasin - Le montant est en centimes (plus petite unité monétaire) **Cas d'usage :** - Vérifier le solde du magasin avant de créer des virements - Afficher les informations de solde dans les tableaux de bord - Surveiller le statut financier du magasin - Valider les fonds suffisants pour les opérations **Authentification :** Nécessite les en-têtes de clé API.
Créer un virement POST
Crée un nouveau virement depuis le portefeuille d'un magasin vers un contact bénéficiaire. **Flux de virement :** 1. Spécifiez le magasin depuis lequel transférer les fonds 2. Spécifiez le contact (bénéficiaire) qui recevra les fonds 3. Spécifiez le montant en centimes 4. Le système déduit automatiquement les frais et traite le virement **Méthodes de virement prises en charge :** - **Mobile Money** : Wave, Orange Money, MTN Mobile Money, Moov Money, DJAMO - **Compte bancaire** : Virements bancaires via RIB **Cas d'usage :** - Paiements de salaires - Paiements aux fournisseurs - Demandes de retrait d'espèces des clients - Virements entre entreprises **Notes importantes :** - Le magasin doit appartenir à l'entreprise authentifiée - Le contact doit appartenir à l'entreprise authentifiée - Un solde suffisant doit être disponible dans le portefeuille du magasin - Les frais de virement sont automatiquement calculés et déduits - Si vous envoyez un champ `reference`, utilisez une valeur unique par tentative de transfert ; une valeur déjà utilisée renvoie `409 Conflict` - La `reference` est renvoyée dans les réponses de l’API Partenaire et dans les payloads webhook de transaction lorsqu’elle a été fournie à la création