Catalogue des événements Webhook
Cette page répertorie les événements de webhook que MeSomb peut envoyer à votre application.
Chaque événement utilise la même enveloppe de webhook et inclut un instantané de la ressource concernée dans data.object.
Catégories d’événements
Les événements webhook MeSomb sont regroupés par domaine métier :
| Catégorie | Description |
|---|---|
| Événements de transaction de paiement | Événements liés aux transactions standard de collecte de paiement. |
| Événements de session de paiement | Événements liés aux sessions de paiement hébergées. |
| Événements de paiement sécurisé | Événements liés aux transactions de type séquestre ou aux paiements sécurisés. |
| Événements de litige | Événements liés aux litiges et aux preuves. |
| Événements de remboursement | Événements liés aux remboursements. |
| Événements de versement | Événements liés aux transferts ou aux paiements vers les commerçants. |
Événements de transaction de paiement
Les événements de transaction de paiement sont envoyés lorsque le statut d’une transaction de paiement standard change.
Type d’événement : payment.transaction.success
Sent when a payment transaction has been successfully completed.
Typical use cases:
- mark an order as paid;
- unlock access to a service;
- trigger fulfillment;
- issue a receipt;
- update accounting or reconciliation records.
Type d’événement : payment.transaction.failed
Sent when a payment transaction has failed.
Typical use cases:
- mark an order payment attempt as failed;
- allow the customer to retry payment;
- notify the merchant that payment was not completed.
Schéma d’objet
Voici le schéma du champ data.object dans le corps de l’événement webhook :
- Nom
amount- Type
- float
- Obligatoire
- obligatoire
- Description
Montant de la transaction
- Nom
country- Type
- enum
- Obligatoire
- obligatoire
- Description
- Nom
currency- Type
- string
- Obligatoire
- obligatoire
- Description
Devise de la transaction
- Nom
fees- Type
- double
- Obligatoire
- obligatoire
- Description
Frais de la transaction
- Nom
service- Type
- enum
- Obligatoire
- obligatoire
- Description
Service de paiement de la transaction
MTN- MTNORANGE- ORANGEAIRTEL- AIRTEL
- Nom
status- Type
- enum
- Obligatoire
- obligatoire
- Description
Statut de la transaction
SUCCESS- SUCCESSFAILED- FAILEDPENDING- PENDINGREFUNDED- REFUNDED
- Nom
trxamount- Type
- float
- Obligatoire
- obligatoire
- Description
Montant de la transaction après déduction des frais
- Nom
ts- Type
- date-time
- Obligatoire
- obligatoire
- Description
Date et heure de la transaction
- Nom
type- Type
- enum
- Obligatoire
- obligatoire
- Description
- Nom
b_party- Type
- string | nullable
- Description
Destinataire ou expéditeur de la transaction
- Nom
customer- Type
- object | nullable
- Description
Informations sur le client effectuant la transaction
- Nom
customer > address- Parent
- dans
customer - Type
- string
- Obligatoire
- obligatoire
- Description
Adresse du client
- Nom
customer > id- Parent
- dans
customer - Type
- integer
- Obligatoire
- obligatoire
- Description
- Nom
customer > country- Parent
- dans
customer - Type
- string | nullable
- Description
Pays de résidence du client
- Nom
customer > email- Parent
- dans
customer - Type
- email | nullable
- Description
Adresse e-mail du client
- Nom
customer > first_name- Parent
- dans
customer - Type
- string | nullable
- Description
Prénom du client
- Nom
customer > last_name- Parent
- dans
customer - Type
- string | nullable
- Description
Nom de famille du client
- Nom
customer > phone- Parent
- dans
customer - Type
- string | nullable
- Description
Téléphone de contact du client
- Nom
customer > region- Parent
- dans
customer - Type
- string | nullable
- Description
Région de résidence du client
- Nom
customer > town- Parent
- dans
customer - Type
- string | nullable
- Description
Ville de résidence du client
- Nom
direction- Type
- enum
- Description
- Nom
fin_trx_id- Type
- string | nullable
- Description
Identifiant de transaction de l’opérateur
- Nom
location- Type
- object | nullable
- Description
Lieu où la transaction a été effectuée.
- Nom
location > country- Parent
- dans
location - Type
- string | nullable
- Description
Pays où la transaction a été effectuée
- Nom
location > region- Parent
- dans
location - Type
- string | nullable
- Description
Région où la transaction a été effectuée
- Nom
location > town- Parent
- dans
location - Type
- string
- Description
Ville où la transaction a été effectuée
- Nom
message- Type
- string | nullable
- Description
Informations client à transmettre au client
- Nom
name- Type
- string | nullable
- Description
Libellé de la transaction, transmis dans le paramètre reference de la requête
- Nom
pk- Type
- uuid
- Description
- Nom
reference- Type
- string
- Description
Référence de la transaction dans votre système : valeur trxId transmise dans la requête
Événements de session de paiement
Les événements de session de paiement sont envoyés lorsqu’une session de paiement hébergée change d’état.
Une session de paiement représente le flux de paiement visible par le client. Elle peut créer ou référencer une ou plusieurs transactions de paiement.
Type d’événement : checkout.session.completed
Sent when a checkout session is successfully completed.
Typical use cases:
- mark the customer checkout flow as completed;
- update the order as paid if
payment_statusispaid; - link the checkout session to the payment transaction.
Type d’événement : checkout.session.expired
Sent when a checkout session expires before successful payment.
Typical use cases:
- mark checkout as expired;
- release reserved stock;
- allow the customer to create a new checkout session.
Type d’événement : checkout.session.canceled
Sent when a checkout session is cancelled.
Typical use cases:
- mark checkout as cancelled;
- redirect customer to retry flow;
- keep the order unpaid.
Type d’événement : checkout.session.created
Sent when a checkout session is created.
Typical use cases:
- store the checkout session ID;
- redirect the customer to the checkout URL;
- show checkout as pending.
Schéma d’objet
Voici le schéma du champ data.object dans le corps de l’événement webhook :
- Nom
amount- Type
- double
- Obligatoire
- obligatoire
- Description
Montant en unités monétaires mineures, par exemple en centimes
- Nom
attempt_count- Type
- integer
- Obligatoire
- obligatoire
- Description
- Nom
cancel_url- Type
- uri
- Obligatoire
- obligatoire
- Description
- Nom
created_at- Type
- date-time
- Obligatoire
- obligatoire
- Description
- Nom
expires_at- Type
- date-time
- Obligatoire
- obligatoire
- Description
- Nom
failure_code- Type
- string | nullable
- Obligatoire
- obligatoire
- Description
- Nom
failure_message- Type
- string | nullable
- Obligatoire
- obligatoire
- Description
- Nom
id- Type
- string
- Obligatoire
- obligatoire
- Description
- Nom
object- Type
- string
- Obligatoire
- obligatoire
- Description
- Nom
status- Type
- enum
- Obligatoire
- obligatoire
- Description
- Nom
success_url- Type
- uri
- Obligatoire
- obligatoire
- Description
- Nom
updated_at- Type
- date-time
- Obligatoire
- obligatoire
- Description
- Nom
url- Type
- string
- Obligatoire
- obligatoire
- Description
- Nom
allowed_payment_methods- Type
- undefined
- Description
Liste des moyens de paiement autorisés
- Nom
amount_total- Type
- double | nullable
- Description
Montant en unités monétaires mineures, par exemple en centimes
- Nom
branding_settings- Type
- object | nullable
- Description
Paramètres d’identité visuelle de cette session
- Nom
branding_settings > background_color- Parent
- dans
branding_settings - Type
- string
- Description
Une couleur hexadécimale commençant par
#représentant la couleur d’arrière-plan
- Nom
branding_settings > border_style- Parent
- dans
branding_settings - Type
- enum
- Description
Le style de bordure du widget.
pill- pillrectangular- rectangularrounded- rounded
- Nom
branding_settings > button_color- Parent
- dans
branding_settings - Type
- string
- Description
Une couleur hexadécimale commençant par
#représentant la couleur du bouton du widget de paiement
- Nom
branding_settings > display_name- Parent
- dans
branding_settings - Type
- string
- Description
Une chaîne remplaçant le nom de l’entreprise affiché en haut de la page de paiement. Votre nom habituel reste affiché dans les conditions, les reçus et les autres emplacements.
- Nom
branding_settings > font_family- Parent
- dans
branding_settings - Type
- enum
- Description
La police de la session de paiement, choisie parmi les [polices prises en charge]
be_vietnam_pro- be_vietnam_probitter- bitterchakra_petch- chakra_petchdefault- defaulthahmlet- hahmletinconsolata- inconsolatainter- interlato- latolora- loram_plus_1_code- m_plus_1_codemontserrat- montserratnoto_sans- noto_sansnoto_sans_jp- noto_sans_jpnoto_serif- noto_serifnunito- nunitoopen_sans- open_sanspridi- pridipt_sans- pt_sanspt_serif- pt_serifraleway- ralewayroboto- robotoroboto_slab- roboto_slabsource_sans_pro- source_sans_protitillium_web- titillium_webubuntu_mono- ubuntu_monozen_maru_gothic- zen_maru_gothic
- Nom
client_reference_id- Type
- string | nullable
- Description
Une référence unique pour la session de paiement, par exemple un identifiant de client ou de panier, permettant le rapprochement avec vos systèmes internes.
- Nom
currency- Type
- string
- Description
- Nom
customer- Type
- undefined
- Description
- Nom
description- Type
- string | nullable
- Description
- Nom
escrow_mode- Type
- enum
- Description
- Nom
line_items- Type
- array
- Description
Éléments de ligne de produit facultatifs à afficher lors du paiement
- Nom
line_items > adjustable- Parent
- dans
line_items - Type
- boolean
- Description
Si la valeur est
true, la quantité de cette ligne d’article pourra être ajustée.
- Nom
line_items > currency- Parent
- dans
line_items - Type
- string
- Valeur par défaut
- Valeur par défaut :XAF
- Description
Devise de la transaction : devise locale du pays ou devise étrangère
- Nom
line_items > limit_max- Parent
- dans
line_items - Type
- integer
- Description
Quantité maximale autorisée pour cette ligne d’article.
- Nom
line_items > limit_min- Parent
- dans
line_items - Type
- integer
- Description
Quantité minimale autorisée pour cette ligne d’article.
- Nom
line_items > product- Parent
- dans
line_items - Type
- string
- Description
Identifiant d’un produit existant à ajouter à cette session
- Nom
line_items > product_data- Parent
- dans
line_items - Type
- object | nullable
- Description
Données utilisées pour créer un nouveau [produit]
- Nom
line_items > product_data > name- Parent
- dans
line_items.product_data - Type
- string
- Obligatoire
- obligatoire
- Description
Nom du produit acheté.
- Nom
line_items > product_data > description- Parent
- dans
line_items.product_data - Type
- string | nullable
- Description
Description de ce produit.
- Nom
line_items > product_data > images- Parent
- dans
line_items.product_data - Type
- array
- Description
Liste contenant jusqu’à huit URL d’images pour ce produit.
- Nom
line_items > product_data > metadata- Parent
- dans
line_items.product_data - Type
- object
- Description
Métadonnées associées à ce produit.
- Nom
line_items > product_data > unit_label- Parent
- dans
line_items.product_data - Type
- string | nullable
- Description
Libellé représentant l’unité de ce produit.
- Nom
line_items > quantity- Parent
- dans
line_items - Type
- integer
- Valeur par défaut
- Valeur par défaut :1
- Description
- Nom
line_items > unit_amount- Parent
- dans
line_items - Type
- double
- Description
- Nom
metadata- Type
- undefined
- Description
Événements de paiement sécurisé
Les événements de paiement sécurisé sont utilisés pour des flux de paiement de type séquestre, dans lesquels les fonds peuvent être retenus jusqu’à la confirmation de livraison, la libération, la résolution du litige ou le remboursement.
Type d’événement : securepay.transaction.created
Sent when a secure payment transaction is created.
Typical use cases:
- create a secure payment record in your system;
- show the buyer and seller that secure payment has started.
Type d’événement : securepay.transaction.cancelled
Sent when a secure payment is cancelled before completion.
Typical use cases:
- close pending secure payment flow;
- release internal reservations;
- prevent further delivery or settlement steps.
Type d’événement : securepay.transaction.expired
Sent when a checkout session expires before successful payment.
Typical use cases:
- mark checkout as expired;
- release reserved stock;
- allow the customer to create a new checkout session.
Type d’événement : securepay.transaction.funded
Sent when the buyer has paid and the secure payment is funded.
Typical use cases:
- notify the seller to prepare or deliver the item;
- mark the order as funded but not yet released;
- prevent premature settlement to the seller.
Type d’événement : securepay.transaction.awaiting_release
Sent when a secure pay transaction is awaiting release.
Typical use cases:
- notify the seller to prepare or deliver the item;
- mark the order as funded but not yet released;
- prevent premature settlement to the seller.
Type d’événement : securepay.transaction.released
Sent when secure payment funds are released to the seller.
Typical use cases:
- mark the order as completed;
- update seller settlement balance;
- notify seller that funds have been released;
- close the secure payment lifecycle.
Type d’événement : securepay.transaction.refunded
Sent when a secure payment is refunded to the buyer.
Typical use cases:
- mark secure payment as refunded;
- close related dispute if applicable;
- update buyer and seller records;
- prevent fulfillment or settlement.
Type d’événement : securepay.transaction.disputed
Sent when a dispute is created.
Typical use cases:
- open a support case;
- notify operations team;
- pause release of funds;
- request evidence from parties.
Type d’événement : securepay.transaction.fulfillment_updated
Sent when a secure pay transaction fulfillment is updated by the seller.
Typical use cases:
- update fulfillment status in your system;
- track shipping or delivery progress;
- trigger notifications or follow-up actions based on fulfillment updates.
- update secure payment status.
Schéma d’objet
Voici le schéma du champ data.object dans le corps de l’événement webhook :
- Nom
amount- Type
- float
- Obligatoire
- obligatoire
- Description
Montant de la transaction
- Nom
country- Type
- string
- Obligatoire
- obligatoire
- Description
CM- CMNE- NE
- Nom
currency- Type
- string
- Obligatoire
- obligatoire
- Description
Devise de la transaction
- Nom
fees- Type
- double
- Obligatoire
- obligatoire
- Description
Frais de la transaction
- Nom
service- Type
- string
- Obligatoire
- obligatoire
- Description
Service de paiement de la transaction
MTN- MTNORANGE- ORANGEAIRTEL- AIRTEL
- Nom
status- Type
- string
- Obligatoire
- obligatoire
- Description
Statut de la transaction
SUCCESS- SUCCESSFAILED- FAILEDPENDING- PENDINGREFUNDED- REFUNDED
- Nom
trxamount- Type
- float
- Obligatoire
- obligatoire
- Description
Montant de la transaction après déduction des frais
- Nom
ts- Type
- date-time
- Obligatoire
- obligatoire
- Description
Date et heure de la transaction
- Nom
type- Type
- string
- Obligatoire
- obligatoire
- Description
COLLECT- EncaissementREFILL- ApprovisionnementPAYMENT- PaiementDEPOSIT- Dépôt
- Nom
b_party- Type
- string | nullable
- Description
Destinataire ou expéditeur de la transaction
- Nom
customer- Type
- object | nullable
- Description
Informations sur le client effectuant la transaction
- Nom
customer > address- Parent
- dans
customer - Type
- string
- Obligatoire
- obligatoire
- Description
Adresse du client
- Nom
customer > id- Parent
- dans
customer - Type
- integer
- Obligatoire
- obligatoire
- Description
- Nom
customer > country- Parent
- dans
customer - Type
- string | nullable
- Description
Pays de résidence du client
- Nom
customer > email- Parent
- dans
customer - Type
- email | nullable
- Description
Adresse e-mail du client
- Nom
customer > first_name- Parent
- dans
customer - Type
- string | nullable
- Description
Prénom du client
- Nom
customer > last_name- Parent
- dans
customer - Type
- string | nullable
- Description
Nom de famille du client
- Nom
customer > phone- Parent
- dans
customer - Type
- string | nullable
- Description
Téléphone de contact du client
- Nom
customer > region- Parent
- dans
customer - Type
- string | nullable
- Description
Région de résidence du client
- Nom
customer > town- Parent
- dans
customer - Type
- string | nullable
- Description
Ville de résidence du client
- Nom
direction- Type
- integer
- Description
-1- Débit1- Crédit
- Nom
fin_trx_id- Type
- string | nullable
- Description
Identifiant de transaction de l’opérateur
- Nom
location- Type
- object | nullable
- Description
Lieu où la transaction a été effectuée.
- Nom
location > country- Parent
- dans
location - Type
- string | nullable
- Description
Pays où la transaction a été effectuée
- Nom
location > region- Parent
- dans
location - Type
- string | nullable
- Description
Région où la transaction a été effectuée
- Nom
location > town- Parent
- dans
location - Type
- string
- Description
Ville où la transaction a été effectuée
- Nom
message- Type
- string | nullable
- Description
Informations client à transmettre au client
- Nom
name- Type
- string | nullable
- Description
Libellé de la transaction, transmis dans le paramètre reference de la requête
- Nom
pk- Type
- uuid
- Description
- Nom
reference- Type
- string
- Description
Référence de la transaction dans votre système : valeur trxId transmise dans la requête
Événements de contestation de paiement sécurisé
Les événements de litige sont utiles lorsque les paiements sécurisés impliquent un désaccord entre l’acheteur et le vendeur ou un examen par le support.
Type d’événement : securepay.dispute.evidence_added
Sent when new evidence is added to a dispute.
Typical use cases:
- update support case activity;
- notify the other party;
- trigger internal review.
Evidence will be referenced by ID or secure URL, not embedded directly in the webhook payload.
Type d’événement : securepay.dispute.message_added
Sent when new message is added to a dispute.
Typical use cases:
- update support case activity;
- notify the other party;
- trigger internal review.
Message will be referenced by ID or secure URL, not embedded directly in the webhook payload.
Type d’événement : securepay.dispute.under_review
Sent when a secure pay transaction dispute is under review by the payment provider.
Tipical use cases:
- notify the merchant that the dispute is being reviewed;
- pause any pending actions related to the dispute;
- prepare for potential dispute resolution outcomes.
Type d’événement : securepay.dispute.resolved
Sent when a dispute has been resolved.
Typical use cases:
- close support case;
- release funds;
- refund buyer;
- update secure payment status.
Schéma d’objet
Voici le schéma du champ data.object dans le corps de l’événement webhook :
- Nom
created_at- Type
- date-time
- Obligatoire
- obligatoire
- Description
- Nom
id- Type
- integer
- Obligatoire
- obligatoire
- Description
- Nom
message- Type
- string
- Obligatoire
- obligatoire
- Description
- Nom
metadata- Type
- undefined
- Obligatoire
- obligatoire
- Description
- Nom
nbr_decisions- Type
- integer
- Obligatoire
- obligatoire
- Description
- Nom
nbr_evidences- Type
- integer
- Obligatoire
- obligatoire
- Description
- Nom
nbr_messages- Type
- integer
- Obligatoire
- obligatoire
- Description
- Nom
opened_by_id- Type
- string
- Obligatoire
- obligatoire
- Description
- Nom
opened_by_type- Type
- string
- Obligatoire
- obligatoire
- Description
merchant- Utilisateur marchandbuyer- Acheteursystem- Systèmeadmin- Administrateurapi- APIprovider_webhook- Webhook de l’opérateur
- Nom
reason- Type
- string
- Obligatoire
- obligatoire
- Description
ITEM_NOT_RECEIVED- Article non reçuITEM_NOT_AS_DESCRIBED- Article non conforme à la descriptionITEM_DAMAGED- Article endommagéDUPLICATE_CHARGE- Double prélèvementFRAUDULENT_CHARGE- Prélèvement frauduleuxUNAUTHORIZED- Non autoriséOTHER- Autre
- Nom
resolution- Type
- string
- Obligatoire
- obligatoire
- Description
release_to_merchant- Libération au marchandrefund_to_payer- Remboursement au payeurpartial_release_partial_refund- Libération ou remboursement partielcancel_dispute- Annuler le litige
- Nom
resolved_at- Type
- date-time | nullable
- Obligatoire
- obligatoire
- Description
- Nom
resolved_by- Type
- string
- Obligatoire
- obligatoire
- Description
- Nom
status- Type
- string
- Obligatoire
- obligatoire
- Description
no_dispute- Aucun litigedispute_opened- Litige ouvertunder_review- En cours d’examenresolved_release- Résolu : libérationresolved_refund- Résolu : remboursementresolved_partial- Résolu : règlement partiel
- Nom
transaction- Type
- string
- Obligatoire
- obligatoire
- Description
- Nom
updated_at- Type
- date-time
- Obligatoire
- obligatoire
- Description
