Appearance
API checkout ministry
Référence d'intégration pour les backends SI métier (ex. portail MinJust) : création de sessions de paiement, réception des webhooks signés, filets de reprise.
Objectif
Le SI métier crée une session via POST /checkout/sessions. Le citoyen paie sur le checkout Epayment (mobile money, carte ou agence). Le SI reçoit une notification fiable à la confirmation (checkout.completed ou verify-completion en embed).
| Responsabilité SI | Délégué à Epayment |
|---|---|
POST /checkout/sessions | Collecte numéro / carte / choix d'offre |
Redirect checkout_url ou montage SDK embed | Orchestration de la collecte (push MM, redirect carte) |
Vérification webhooks HMAC et/ou verify-completion | Appels directs PSP |
| Déblocage dossier sur confirmation serveur idempotente | Calcul du montant dû |
Le SI n'appelle pas les routes checkout citoyen (offers, collecte / attempts) avec sk_. Voir Mobile money - Audience.
Parcours recommandé
- Mise en service - clés, webhooks, recette
- Clés API - scopes application, tenant, plateforme
- Catalogue services -
service_code, mapping ERP - Référence API - endpoints et champs
- Checkout hébergé - redirect (défaut)
- Checkout embarqué - SDK iframe
- Idempotence - clés et retries
- Paiement agence -
payment_ref - Mobile money - webhooks MM, sandbox, pas de direct push
- Paiement par carte - multi-devise, comportement refus/timeout
- Webhooks - événements et payloads
- Sécurité webhooks - HMAC et rotation
- Polling et filets - GET, verify-completion
Un partenaire déjà branché sur apiKey, init-checkout ou partners/payments suit Cash-in déprécié, pas ce parcours.
Base API
http
https://paymentdev-api.akieni.tech/api/v1
Authorization: Bearer sk_test_...
Content-Type: application/jsonModes checkout
| Mode | Réponse clé | UX citoyen |
|---|---|---|
hosted (défaut) | checkout_url | Redirect HTTP |
embedded | client_secret, embed_checkout_url | Overlay SDK + iframe |
Clés API (aperçu)
| Scope | tenant_id requis | Usage |
|---|---|---|
application | Non | Intégration par application métier |
tenant | Non | Clé régie, application intégrateur par défaut |
platform | Oui | eGouv, e-Citizen - voir eGouv |
Détail : Clés API.