Analyzing the nature of the notification

The vads_url_check_src field allows to differentiate the notifications based on their triggering event:

  • token creation (with or without subscription to a recurring payment),
  • installment payment,
  • new notification sent by the merchant via the Merchant Back Office.

It specifies the applied notification rule:

Table 1. Values associated with the vads_url_check_src field
Value Applied rule
PAY

The PAY value is sent in the following cases:

  • registration request for a mandate or a token (REGISTER)
  • registration request for a mandate or a token when subscribing to a recurring payment (REGISTER_SUBSCRIBE)
  • immediate payment (or first installment payment of a recurring payment)
  • payment abandoned or canceled by the buyer

    only if the merchant has configured the rule Instant Payment Notification URL on cancellation

BO

Execution of the notification via the Merchant Back Office (right-click a transaction > Execute the IPN URL).

Check whether the vads_recurrence_number field is present:
  • if yes, the notification concerns the result of a recurring payment (retry of a REC type notification),
  • if not, the notification concerns a notification at the end of payment.
BATCH

The BATCH value is sent in case of an update of a transaction status after its synchronization on the acquirer side.

This is the case of payments with redirection to the acquirer.

Only if the merchant has configured the rule Instant Payment Notification URL on batch change.

BATCH_AUTO

The BATCH_AUTO value is sent in the following cases:

  • payment deferred for more than 7 days
  • installments of a recurring payment (except the first one)

    only if the merchant has configured the rule Instant Payment Notification URL on batch authorization

The notification is sent with the authorization request for payments with "Waiting for authorization" status.

REC

The REC value is sent only for recurring payments if the merchant has configured the Instant Payment Notification URL when creating recurring payments rule.

MERCH_BO

The MERCH_BO value is sent:

  • during operation made via the Merchant Back Office (refund, cancellation, modification, validation, duplication, creation and/or update of token), only if the merchant has configured the following notification rule: Instant Payment Notification URL on an operation coming from the Back Office
RETRY

Automatic retry of the IPN.

Check whether the vads_recurrence_number field is present:
  • if yes, the notification concerns the result of a recurring payment (retry of a REC type notification),
  • if not, the notification concerns a notification at the end of payment.

After checking its value, the script can process differently depending on the nature of the notification.

For example:

If vads_url_check_src is set to PAY or BATCH_AUTO, the script will update the order status, etc.

If vads_url_check_src is set to REC the script will retrieve the recurring payment reference and will increment the number of the expired installment payments in case the payment has been accepted, etc.

In the context of a recurring payment (coming from REGISTER_SUBSCRIBE), the payment gateway notifies the creditor (merchant) every time it creates a transaction.