Jèko
Guide de démarrage

Gestion des magasins

Le magasin, unité de rattachement de toutes les opérations financières

Les magasins

Un magasin (store) représente un point de vente ou un canal de distribution. Toute opération financière est rattachée à un magasin : c'est l'unité de base de l'API.

Concept de magasin

Une entreprise peut posséder plusieurs magasins. Chaque magasin peut représenter :

  • Un emplacement physique (boutique, restaurant, etc.)
  • Une boutique en ligne
  • Un canal de vente spécifique
  • Toute autre entité commerciale distincte

Rôle dans les opérations financières

  • Pay-in (paiements entrants) : les paiements reçus sont crédités sur le compte du magasin
  • Pay-out (transferts sortants) : les transferts sont débités du compte du magasin

Chaque paiement et chaque transfert doit donc porter un storeId.

Comptes des magasins

Chaque magasin possède un compte unifié qui peut gérer à la fois les opérations de pay-in et de pay-out :

  • Pay-in : Le compte est crédité automatiquement lors des paiements réussis (paiements en magasin via Jèko Box, liens de paiement, paiements en ligne)
  • Pay-out : Le compte est débité automatiquement lors des transferts réussis vers des bénéficiaires

Pour reverser, le compte doit être provisionné au préalable. Ce que vous encaissez y suffit : les fonds collectés sont directement disponibles.

Gestion des magasins

Caractéristiques d'un magasin

Chaque magasin dispose de :

  • Sa propre configuration et paramètres
  • Son historique de transactions indépendant
  • Son compte unifié (gérant à la fois pay-in et pay-out)
  • Son identifiant unique (storeId)

Utilisation des magasins dans l'API

Les identifiants de magasin (storeId) sont obligatoires pour :

  • Créer des demandes de paiement (payment_requests)
  • Générer des liens de paiement (payment_links)
  • Effectuer des transferts (transfers)
  • Consulter les soldes et l'historique des transactions

Opérations sur les magasins

Récupérer la liste des magasins

Avant d'effectuer toute opération financière, vous devez récupérer la liste des magasins disponibles pour votre entreprise :

curl -X GET "https://api.jeko.africa/partner_api/stores" \
  -H "X-API-KEY: your_api_key_here" \
  -H "X-API-KEY-ID: your_api_key_id_here"

Réponse : Liste de tous les magasins avec leurs identifiants, noms et configurations.

Consulter le solde d'un magasin

Pour vérifier le solde disponible d'un magasin spécifique :

curl -X GET "https://api.jeko.africa/partner_api/stores/{storeId}/balance" \
  -H "X-API-KEY: your_api_key_here" \
  -H "X-API-KEY-ID: your_api_key_id_here"

Note : Le solde retourné représente la somme des soldes disponibles de tous les portefeuilles associés au magasin.

Bonnes pratiques

  1. Récupérer les magasins au démarrage : Listez les magasins disponibles dès l'initialisation de votre intégration
  2. Valider les storeId : Vérifiez que le storeId utilisé existe avant de créer des transactions
  3. Gérer plusieurs magasins : Si votre entreprise a plusieurs magasins, assurez-vous de sélectionner le bon magasin pour chaque transaction
  4. Surveiller les soldes : Consultez régulièrement les soldes des magasins pour garantir la disponibilité des fonds nécessaires pour les transferts

On this page