Appearance
Les trois canaux
Epayment expose trois canaux d'intégration distincts. Ils sont complémentaires : un ministère peut utiliser le checkout API sans ERP ; une régie peut connecter l'ERP pour le portail citoyen sans API ministry dédiée.
1. Ministry checkout + webhooks
Acteur : backend du SI ministériel (ou eGouv avec clé plateforme).
Implémentation intégrateur :
POST /checkout/sessions(montant,order_id, optionnelmode,service_code)- Endpoint webhook HTTPS + vérification HMAC
- En embed :
POST /checkout/sessions/verify-completion
Fourni par Epayment : checkout hosted ou embed, orchestration connecteurs (MM, carte, agence), payment_ref agence, journal des événements.
Le backend SI ne pilote pas la collecte (pas de push téléphone avec sk_). Voir Mobile money - Audience.
| Mode | Réponse clé | UX citoyen |
|---|---|---|
hosted (défaut) | checkout_url | Redirect HTTP vers checkout |
embedded | client_secret, embed_checkout_url | Overlay SDK + iframe |
2. ERP REST (régie)
Acteur : SI métier de la régie (Trésor, ERP fiscal, etc.).
Exposé par la régie : endpoints REST documentés (health, dues, disbursements, payment confirmations).
Rôle Epayment : tirage des créances pour le portail citoyen, chargement des lots de paiement en masse, envoi des confirmations après encaissement.
| Opération | Méthode | Usage |
|---|---|---|
| Health | GET /health | Vérification connectivité |
| Créances | GET /dues?subject_ref= | Portail citoyen |
| Disbursement | GET /disbursements?batch_ref= | Paiements en masse |
| Confirmation | POST /payment-confirmations | Imputation après encaissement |
3. eGouv plateforme
Acteur : portail transverse eGouv / e-Citizen.
Spécificités permanentes :
- Clé API plateforme (
sk_scope platform) tenant_idobligatoire sur chaquePOST /checkout/sessions- Origines embed sur config globale (admin
/egouv), pas par application ministry - Webhooks checkout en fan-out dual : application intégrateur de la régie ciblée (souvent
0001) et endpoints eGouv (admin Intégration eGouv)
| Aspect | Règle |
|---|---|
| Auth | Authorization: Bearer sk_... (scope platform) |
tenant_id | Obligatoire ; sans lui : 400 checkout.tenant_required |
| Origines embed | Config globale admin → Intégration eGouv |
| Notification synchrone | verify-completion recommandé après embed |
Tableau comparatif
| Ministry | ERP | eGouv | |
|---|---|---|---|
| Direction principale | Ministry → Epayment | Bidirectionnel | Ministry → Epayment |
| Auth | sk_ application ou plateforme | Credentials ERP côté régie | sk_ plateforme |
| UX citoyen | Hosted redirect ou SDK embed | Portail citoyen Epayment | SDK embed sur portail |
| Notification métier | Webhook + verify-completion | POST payment-confirmation | verify-completion + webhooks eGouv + régie |
tenant_id | Optionnel (application) | N/A (config régie) | Obligatoire |
| ERP requis | Non | Oui (exposé par régie) | Oui (régie cible) |
Sélection du canal
Pour une matrice de décision détaillée (profil, besoin fonctionnel, mode checkout), voir le Guide de choix d'intégration.