v1

latestOpenAPI 3.0.02026-07-24270120.1 KB

PDN Mandate

API to send pre-debit notifications for mandates with Cards or UPI

post/pg/api/mandate/notification

Request body

merchantIdstring required

Merchant account ID

merchantTxnNostring required

Unique ref no to identify the request. Should have only alphanumeric characters. No other characters allowed.

amountstring required

Transaction amount, 9 significant and 2 decimal/precision

currencyCodestring required

Transaction Currency

notestring required

Mandatory in Case of UPI mandate only. Text added here will be displayed to payer in PSP app.

aggregatorIDstring

Merchant Aggregator ID

mandateIdstring required

Mandate id as returned in create mandate flow

executionDatestring YYYYMMDDHHMISS required

Date of execution of debit. YYYYMMDDHHMISS

secureHashstring required

Hash value

Response

Successful response

responseCodestring

Response code indicating success/failure. R1000 – Request Initiated successfully Any other value indicates failure

respDescriptionstring

Description of failure. Ignore for success response.

merchantIdstring

Merchant account ID

aggregatorIDstring

Merchant aggregator ID

merchantTxnNostring

Merchant Txn ref Number

amountstring

echo back of request

requestTypestring

NOTIFICATION_MANDATE

secureHashstring

Hash value