v1

latestOpenAPI 3.0.02026-07-24270120.1 KB

Execute Mandate

API to debit on existing mandates with Cards or UPI

post/pg/api/mandate/execute

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. As sent in PDN request.

currencyCodestring required

Transaction Currency

remarkstring

Remarks.

aggregatorIDstring

Merchant Aggregator ID

mandateIdstring required

Mandate id as returned in create mandate flow

purposestring

Possible value RECURRING or OT

txnIdstring

txnId as received in successful PDN call for execute

billNumberstring

billNumber as used during create api

secureHashstring required

Hash value

Response

Successful response

responseCodestring

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

responseDescriptionstring

Description of failure. Ignore for success response.

merchantIdstring

Merchant account ID

aggregatorIDstring

Merchant aggregator ID

merchantTxnNostring

Merchant Txn ref Number

redirectURIstring

Redirection URL. Will be available in case merchant is required to redirect to complete payment authorization. Either this field or showOTPCaptureP age field will be available in response.

generateOTPURIstring

generateOTP . Will be available when showOTPCaptureP age is ’Y’

verifyOTPURIstring

verifyOTPURI, Will be available when showOTPCaptureP age is ’Y’

authorizeURIstring

authorizeURL, Will be available when showOTPCaptureP age is ’Y’

showOTPCapturePagestring

Show OTP Page indicator, Y / N. Y – Merchant should display a page to ask for OTP. Please do contact integration team for OTP capture page requirements

tranCtxstring

The transaction context generated by the PG, Needs to be sent as is to the redirectURI / authorizeURI endpoint

secureHashstring

Hash value