# Notification

# Success

The merchant backend can be notified of the purchase completion if the optional parameter paymentNotificationUrl is provided when the purchase is created.

This webhook is a POST and its body is a JSON which fields depend on the payment mode (see back mode, transfer mode).

# Error

The merchant backend can be notified of an error occurring after the payment screen if the optional parameter errorNotificationUrl is provided when the purchase is created.

  • The notification is sent if the purchase state becomes one of BI_CANCELLED, BI_KO, BI_SCORING_KO, CARD_FILTER_KO, CONNECTOR_KO, PRIMARY_KO, SCORING_KO, TMX_SCORING_KO, VCP_KO, WORLDCHECK_FILTER_KO.
  • The notification is a POST request on errorNotificationUrl.

This webhook is a POST and its body is a JSON with the following fields:

{
   "reference" : "purchase_reference",
   "state" : "PRIMARY_KO",
   "uid" : "pur_6c48d42b-f29b-4f84-bee8-3cb2b964b600",
}

If there is a secret in the configuration of your merchant, it will be used to sign the notification body with jwt. In this case, only the signature is sent.

{
    "signature" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZlcmVuY2UiOiJwdXJjaGFzZV9yZWZlcmVuY2UiLCJwdXJjaGFzZV9zdGF0ZSI6IlBSSU1BUllfS08iLCJwdXJjaGFzZV91aWQiOiJwdXJfNmM0OGQ0MmItZjI5Yi00Zjg0LWJlZTgtM2NiMmI5NjRiNjAwIn0.375q0I_1Z8ZExa6aFwOvHdFvx4HTfpE-lbcHYlQ2nGs"
}