v1

latestOpenAPI 3.0.02026-07-24270120.1 KB

Mandate Status Check

post/tsp/pg/api/mandate/statuscheck

Request body

merchantIdstring required

Merchant account ID. Size-12

aggregatorIdstring

Aggregator ID. Required if the original transaction was initiated from Aggregator. Size-12

merchantTxnNstring required

Transaction reference number. Same as original transaction number. Size-12

secureHashstring

Hash Value. Size-64

Response

responseCodestring required

Response code indicating success/failure of the transaction status request 000 / 0000 – Success P9506 - Mandate Expired (for this responseCode merchant needs to update the mandate status as MANDATE_EXPIED at merchant side. And no need to send Notification and Execute API onwards) Any other value indicates status request failure / original transaction not found. For status of the original txn always check errorCode and errorDescription

Size-3

respDescriptionstring required

Description of failure. Ignore for Success response. Size-45

merchantIdstring required

Merchant account ID. Echo of request field

aggregatorIDstring

Merchant Aggregator ID. Echo of request field

merchantTxnNostring required

Merchant transaction reference number. Echo of request field

errorCodestring

The reason code for failure 0000 - Success U1000 - Pending Anything Else is Rejected

Size-255

errorDescriptionstring

Description for failure. Size-255

txnIDnumber

The unique reference number generated by the Payment Gateway. Only in case of Execute Mandate. Size-24

paymentDateTimenumber

Authorization date time. Only in case of Execute Mandate Format: YYYYMMDDHHMMSS

Example: 2023111912121

paymentIDnumber required

The authorization/payment ID generated by the authorization system. Only in case of Execute Mandate. Size-24

paymentSubInstTypestring

The payment sub instrument type. Only in case of Execute Mandate. Size-64

bankRRNstring required

RRN received from the bank. Size-64

requestTypestring

Type of the request. Possible values: CREATE_MANDATE PAUSE_MANDATE REVOKE_MANDATE EXECUTE_MANDATE RESUME_MANDATE NOTIFICATION_MANDATE

umnstring

Unique Mandate Number. If the mandate is created successfully, then it will be populated. Size-50

upiQRstring

QR generated for mandate creation. If the QR is created successfully, then it will be populated. Size-512

secureHashstring required

Hash Value. Size-64

mandateIdstring

Unique Mandate ID. If the mandate is created successfully, then it will be populated. Size-50

udFiedldsstring[]

Echo of request field