Skip to main content

API Reference

L’API SahelPay est une API REST qui utilise JSON pour les requêtes et réponses.

Base URL

Le mode est déterminé par la clé (sk_test_... ou sk_live_...). Une clé ne voit que les objets de son mode et de son application : une clé de test ne lit pas un paiement live, et inversement (404). Pour le simulateur SahelPay sans appel opérateur, ajoutez metadata.sahelpay_mock: true à la création du paiement ; metadata.sandbox: true appelle l’environnement de test de l’opérateur.

Authentification

Toutes les requêtes marchandes incluent votre clé secrète :
Une clé live n’est acceptée qu’avec un accès production ouvert, sur demande, après validation et contrat distinct (voir Authentification).

Format des réponses

Succès

Erreur

Voir Codes d’erreur.

Codes HTTP

Rate limiting

Limite par défaut : 100 requêtes par minute. Certaines routes sont plus strictes, notamment POST /v1/payments (10 par minute), POST /v1/payments/{id}/reconcile (10 par minute) et POST /v1/webhooks/test (5 par minute). Au-delà : 429 RATE_LIMIT_EXCEEDED.

Idempotence

X-Idempotency-Key (128 caractères maximum) est obligatoire sur POST /v1/payments. La même clé rejouée avec la même demande renvoie le même résultat ; avec une demande différente, la requête est refusée (409).

Endpoints disponibles

Paiements

Liens de paiement

Paiement sécurisé (séquestre)

Fonction activée par marchand, sur demande. Voir Paiement sécurisé.

Remboursements et reçus

Les retraits se demandent depuis le dashboard. POST /v1/payouts (transfert automatique) est refusé : les transferts automatiques Orange Money ne sont pas disponibles.

Abonnements clients

Programme Partenaires SPAY

Customer Portal

Webhooks

Voir Livraisons.

Utilitaires

Le flux OPR n’est pas disponible en production.