Introduction

Introduction

Bienvenue sur la documentation de l'API Novasend Marchand

Objectifs

L’API Marchand permet aux partenaires d’intégrer des fonctionnalités de paiement et de transfert dans leurs applications ou systèmes internes.

Elle offre notamment les capacités suivantes :

  • Déclencher des paiements clients nécessitant confirmation.
  • Effectuer des transferts internes (wallet) ou externes (Mobile Money).
  • Interroger l’état d’une transaction à tout moment.
  • Recevoir des notifications en temps réel (Webhook, email, SMS).
  • Remboursement de transaction

Vue Globale

L’API repose sur une architecture modulaire cloud-native conforme aux standards de paiement sécurisés.

Les interactions principales suivent ce schéma :

  1. Paiement , Transfert ou Refund : appel d’un endpoint sécurisé (/v1/payin, /v1/payout, /v1/payin/{reference}/refund).
  2. Mise à jour : synchronisation des statuts après confirmation ou rejet.
  3. Supervision : suivi via le Portail Marchand (console web).
  4. Notification : envoi automatique d’un webhook ou d’une alerte SMS/email.

Sécurité & Conformité

ÉlémentDétail
AuthentificationBasic Authentication
Sécurité RéseauIP whitelisting, TLS 1.3, anti-DDoS
Sécurité ApplicativeAES-256, contrôles d’intégrité (en cours d’intégration)
JournalisationLogs centralisés avec horodatage ms, audit trail
Conformité RéglementairePCI-DSS, RGPD, KYC/AML
VersioningPréfixage /v1/, rétrocompatibilité assurée

Gestion de l’Idempotence

Pour les opérations critiques (POST /v1/payin/sessions, POST /v1/payout, POST /v1/payin/{reference}/refund), chaque requête doit inclure :

KeyDescriptionObligatoire
X-Idempotency-KeyUUID pour garantir l’unicité de la requête✅
  • Généré par le marchand (ex. UUID v4).
  • Associé à une transaction unique par marchand.
  • Si la requête est rejouée avec la même clé : la même réponse sera renvoyée, aucune recréation.

Disponibilité

GET /health
  • Auth : Non
  • Payload : Aucun
  • Description : Vérifie la disponibilité du service.
Paiement (Payin)