My App
Magasins

Obtenir le solde du magasin

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.

GET
/partner_api/stores/{storeId}/balance

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.

Authorization

X-API-KEY<token>

Clé API pour les requêtes de l'API Partenaire

In: header

Path Parameters

storeId*string

Identifiant du magasin

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/partner_api/stores/59ae202a-f583-4a15-970f-9e99bd1e0baa/balance"
{
  "amount": 1500000,
  "currency": "XOF"
}
{
  "id": "unauthorized",
  "message": "Unauthorized",
  "extras": "Détails supplémentaires de l'erreur"
}
{
  "id": "forbidden_action",
  "message": "Action interdite",
  "extras": "Détails supplémentaires de l'erreur"
}
{
  "id": "store_not_found",
  "message": "Store not found",
  "extras": "Store not found"
}
{
  "id": "internal_error",
  "message": "Une erreur inattendue s'est produite",
  "extras": "Détails supplémentaires de l'erreur"
}

Lister les magasins GET

Retourne la liste des magasins pour l'entreprise authentifiée. **Pourquoi les magasins sont importants :** - Chez Jeko, les entreprises peuvent avoir plusieurs magasins (emplacements physiques, boutiques en ligne, etc.) - Toutes les opérations de paiement (demandes de paiement, liens de paiement) doivent être associées à un magasin spécifique - Chaque magasin a sa propre configuration, paramètres et historique de transactions - Les IDs de magasin sont requis pour créer des demandes de paiement et des liens de paiement **Cas d'usage :** - Obtenir les magasins disponibles avant de créer des opérations de paiement - Afficher les options de magasin dans l'interface de votre application - Valider les IDs de magasin avant d'effectuer des appels API de paiement **Authentification :** Nécessite les en-têtes de clé API.

Lister les transactions du magasin GET

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.