Getting Started

Faites votre premier appel API en moins de 5 minutes. Aucune installation requise.

1. Créer un compte 2. Obtenir une clé API 3. Premier appel 4. Vérifier le statut 5. Configurer les webhooks

Étape 1 — Créer un compte

Créez un compte sur EnvoiFacile. Votre compte vous donne accès au dashboard marchand où vous pouvez gérer vos clés API.

Étape 2 — Obtenir votre clé API

Depuis votre dashboard, utilisez la commande artisan (administrateur) ou l'interface pour générer une clé :

bash Génération de clé (admin)

php artisan merchant:generate-key \
  --user=1 \
  --name="Mon Application" \
  --env=live \
  --scopes=payin,payout

La clé est affichée une seule fois. Copiez-la immédiatement et stockez-la dans vos variables d'environnement.

Ne partagez jamais votre clé API

Votre clé API donne accès à votre compte. Ne la committez jamais dans votre code source. Utilisez des variables d'environnement.

Étape 3 — Premier appel API

Initiez un payin (collecte de fonds) avec curl :

bash POST /api/v1/merchant/payin

curl -X POST https://envoifacile.com/api/v1/merchant/payin \
  -H "X-API-KEY: ef_live_VOTRE_CLE_ICI" \
  -H "Idempotency-Key: commande_001" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 10000,
    "currency": "XOF",
    "method": "orange",
    "country": "CI",
    "phone": "+2250701234567",
    "reference": "commande_001"
  }'

json Réponse 200 OK

{
  "success": true,
  "status": "initiated",
  "transaction_id": "PAY_XYZABC123456_1719100000",
  "provider": "jeko",
  "provider_ref": "d22c81f3-ee04-4ec5-8bd2-cd8af5dabcfc",
  "requires_action": true,
  "action_url": "https://pay.jeko.africa/payment/d22c81f3-...",
  "message": "Redirect to payment page required."
}

requires_action = true

Quand requires_action est true, redirigez votre utilisateur vers action_url pour qu'il confirme le paiement dans son application Mobile Money.

Étape 4 — Vérifier le statut

bash GET /api/v1/merchant/status/{trx_id}

curl https://envoifacile.com/api/v1/merchant/status/PAY_XYZABC123456_1719100000 \
  -H "X-API-KEY: ef_live_VOTRE_CLE_ICI"

Étape 5 — Configurer vos webhooks

Pour recevoir les confirmations de paiement en temps réel, configurez une URL webhook sur votre compte. Consultez la documentation Webhooks pour les détails.

Vous êtes prêt !

Continuez avec la documentation d'authentification ou explorez la référence Payin API.