Skip to content

Index des payloads ​

Correspondance entre identifiants métier et exemples JSON du contrat public.

Checkout ministry ​

IdentifiantOù il apparaîtPayload / page
session_idRéponse create session, webhooks, verify-completionWebhooks completed
order_idCreate session, webhooks, GET listCas d'usage casier hosted
notice_idWebhooks, quittanceWebhooks
payment_refRéponse create, agencePaiement agence
client_secretRéponse embed, SDKCheckout embarqué
completion_tokenSDK onComplete, verify-completionCheckout embarqué
next_action (carte)Interne checkout citoyen (pas contrat SI)Paiement par carte
tenant_idWebhooks, clé plateformeIdentifiants
application_idWebhooks, corrélation appIdentifiants
metadataCreate session, webhooksClés string ≤ 64, valeurs ≤ 500 car.
service_codeCreate session, webhooksCatalogue services
x-epayment-event-idHeader livraison webhookWebhooks

Cash-in déprécié ​

Identifiants du contrat historique (oat_, externalNumber, numéro T…, webhook non signé) : Cash-in déprécié.

Webhooks ministry ​

Exemples de corps JSON par événement : Webhooks (checkout.completed, checkout.failed, checkout.cancelled, checkout.expired).

ERP REST ​

IdentifiantDirectionPayload / page
subject_refERP ↔ EpaymentGET dues, confirmation payment.subject_ref
erp_due_refERP ↔ EpaymentLigne créance ; clé confirmation
revenue_line_codeERP → EpaymentMapping catalogue régie
batch_refERP ↔ EpaymentGET disbursements, import batch
line_refERP ↔ EpaymentLigne disbursement
beneficiary_refERP → EpaymentBénéficiaire payout
notice_refEpayment → ERPAlias affichage payment_ref
transaction_idEpayment → ERPUUID transaction plateforme

Exemples de réponses et corps : contrat REST.

Montants checkout citoyen ​

Champ APISignificationPage
amount (create ministry)Montant dûFrais de service
amount_due_minorMontant dû (offers, receipt)Frais de service
service_fee_minorFrais service connecteurFrais de service
total_minorTotal citoyen (due + fee)Frais de service

Plateforme d'orchestration de paiement DPI. Les fonds ne transitent pas par Epayment.