Pre-Debit Notification API

The Pre-Debit Notification API allows the merchants to send a pre-debit notification to the customer regarding an upcoming payment which will be deducted from the customer’s account as part of the registration. There is a mandate to send this notification to the customer at least 48 hours before the actual debit, that is, 48 hours before calling the Recurring API.

❗️

Reminder

  • Unless the Pre-Debit notification interface is implemented, the Recurring API will not work, and you will not be able to charge the customer for the given billing cycle.
  • Pre-Debit notification is necessary only for Cards and UPI and works for only these two payment modes

Environment

Reference information for request parameters

ParameterReference
keyFor more information on how to generate the Key and Salt, refer to any of the following:

- Production: Generate Merchant Key and Salt
- Test: Generate Test Merchant Key and Salt
hashHash logic for this API is:
sha512(key|command|var1|salt)
sha512

var1 JSON fields description

For var1 JSON fields description, refer to Additional Info. for Recurring Payment APIs.

Response parameters

For more information on response parameters, refer to Additional Info. for Recurring Payment APIs.

Request parameters

Use the following sample values while trying out the API:

Example values:

  • var1:
    • authPayuId: 10731087875.
      requestId: 23123abut12123osd14.
      debitDate: 2020-03-20.
      invoiceDisplayNumber: 10731087875.
      amount: 100.
      action: retreive.
Language
Click Try It! to start a request and see the response here!