Pre-Debit Notification

Before each recurring payment, you must send a pre-debit notification to the customer. This ensures they are informed and prepared for the upcoming charge, and it is required by NPCI/RBI regulations.

To send a pre-debit notification, use the /ws/customerenrollment-notify endpoint. This will trigger a notification to the customer via SMS and push notification, thereby informing them and preparing them for the payment.

info

The recurring payment can only proceed once the pre-debit notification has been successfully sent and acknowledged by the customer, represented by a response with status as "notified".

Requirements

• API credentials - Ensure you have your EBANX integration key. If not, complete the Merchant Signup Form.

Instructions

To request a pre-debit notification before a payment, follow the steps below.

1. Request the Pre-Debit Notification

   Requesting the notification is very straightforward. Use the /ws/customerenrollment-notify endpoint, with the following required fields:

   Parameter	Requirements	Description
   integration_key	Required	Your EBANX integration key.
   amount	Required	Amount for the upcoming payment.
   merchant_enrollment_code	Required	Unique enrollment code defined when subscription was registered.
   payment_execution_date	Required	Date and time for the upcoming payment. Expected format: yyyy-mm-dd hh:mm:ss.

   Check the example:

   curl -X POST \
     --location 'https://sandbox.ebanx.com/ws/customerenrollment-notify/' \
     --header 'Content-Type: application/json' \
     --data '{
       "integration_key": "{{integration_key}}",
       "amount": "1000",
       "merchant_enrollment_code": "{{unique_enrollment_code}}",
       "payment_execution_date": "2025-08-01 12:00:00"
     }'

2. Confirming the Notification is sent

   A successful request will return a JSON response like the one below.

   {
     "status": "SUCCESS",
     "notification": {
       "hash": "ac682d9c3b5a2f90150bjcbabe89b933f954e616fbd19e0dff99339f7586881f4e397ca7dd88baba9715d40f39562e8040c1898a551143574aa0f93fc07a4c6e",
       "amount": "1000",
       "status": "notified",
       "payment_execution_date": "2024-08-01 12:00:00"
     }
   }
   

   Once the status of pre-debit notification is notified in the response, confirming customer acknowledgment, the recurring payment request can be initiated, and this process repeats every cycle.

   Now, follow the steps on the Recurring Payment Request page.

   note

   A mandatory wait period exists between the pre-debit notification to the user and the initiation of the recurring payment. The wait period must be at least 24 hours before an actual charge occurs.

   Recurring payment attempts made without a prior pre-debit notification to the user, or within a wait period shorter than the required duration, will be declined.

Still need help?

We hope this article was helpful. If you still have questions, you can explore the following options:

• Merchant support: Contact our support team at integration@ebanx.com for assistance.
• Not a partner yet? Please complete the Merchant Signup Form, and our commercial team will reach out to you.