Selection of notification format

You have the possibility to choose the format of notifications. There are 2 available options:
  • The Form API format, ideal if you only use this API.
  • The REST API format, if you use only the JavaScript client, or if you have implemented both APIs (since some payment methods are not compatible with the JavaScript client, you will have to implement both APIs).

The format selection is made by specifying the URL to notify in the rule configuration.

Here is the adopted principle:

  1. The merchant defines the notification URL of the form API only if:
    • A payment is made via the payment form, the notification is made in the form API format.
    • A payment is made via the JavaScript client, the notification is not sent.
    • An operation is made via the Merchant Back Office, the notification is made in the form API format.
    • An event triggers notifications on batch change or batch authorization, the format will be that of form API.
    • During the creation of recurring payments, the notification will be sent in the form API format.
  2. The merchant defines the REST API notification URLs only if:
    • The payment is made via the payment form, the notification is made in the REST API format.
    • The payment is made via the JavaScript client, the notification is made in the REST API format.
    • An operation is made via the Merchant Back Office, the notification is made in the REST API format.
    • An event triggers notifications on batch change or batch authorization, the format will be that of REST API.
    • During the creation of recurring payments, the notification will be sent in the REST API format.
  3. The merchant specifies the form API and REST API notification URLs if:
    • The payment is made via the payment form, the notification is made in the form API format.
    • The payment is made via the JavaScript client, the notification is made in the REST API format.
    • An operation is made via the Merchant Back Office, the notification is made in the form API format.
    • An event triggers notifications on batch change or batch authorization, the format will be that of form API.
    • During the creation of recurring payments, the notification will be sent in the form API format.