Skip to main content
POST
Send Pre-Debit Notification

Authorizations

X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

X-Merchant-ID
string
header
required

Merchant Identifier - The unique ID for the merchant account. This is required for PSP (Payment Service Provider) merchants who manage multiple merchant accounts. You can find merchant IDs in the Merchant Management section of the dashboard.

Headers

X-API-Version
enum<string>
default:3.0.0

Optional. Send 3.0.0. It is not a credential. The response's X-API-Version header echoes the value you sent, or your account's default version if you send none.

Available options:
3.0.0

Path Parameters

subscription_id
string
required

The subscription's ID, e.g. SUB7989707770.

Body

application/json

The upcoming debit's date, amount and invoice display number.

debit_date
string<date>
required

The day you will trigger the charge (YYYY-MM-DD). Must be after today (IST).

amount
number

Up to 12 digits with 2 decimals, minimum 0.01, at most the subscription's billing_amount. Defaults to billing_amount. The charge on debit_date cannot exceed it.

Required range: x >= 0.01
invoice_display_number
string

Required on PayU, card and UPI: Trigger Recurring Payment must repeat it. Optional on EximPe; if you leave it out, one is assigned and returned. Use a new value for each charge, and send the same value to Trigger Recurring Payment.

Maximum string length: 255

Response

Pre-debit notification sent

success
boolean
required
message
string
required
data
object
required