API Reference
Start typing to search…

Get UPI Mandate Status API

API Command: upi_mandate_status

The Get Mandate Status API enables you to understand the current state of the mandate at any time. After integrating this API, it helps you identify the customers who paused the mandate outside your eco-system by directly connecting with the issuer (This case is only applicable for UPI). In such cases, you can call Get Mandate Status API before initiating the charge API.

HTTP Method: POST

Request parameters

Variable

Description

Example

key mandatory

varchar This parameter is the unique merchant key provided by PayU for your merchant account.

Your Test Key

command
mandatory

varchar For initiating a recurring transaction, the value of the parameter will be passed as “upi_mandate_status”

upi_mandate_status

var1
mandatory

JSON This parameter is in JSON format where:

  • authPayuId(mandatory): The value of mihpayid is returned in the payment response of the Registration transaction when the transaction is successfully completed.
    As described earlier, the merchant needs to map this value against the customer profile at his end so that correct authPayuid will be passed in the request.
  • requestId(mandatory): Unique request value generated at merchant’s end to distinguish independent request call.

{ "authPayuId": "10731087875", "requestId": "1892432asds15g6" }

hash
mandatory

varchar 512 SHA hash strings generated by encrypting request parameters so that any tampering can be avoided.
hash = sha512(key|command|var1|SALT)

command

Sample response

  • Success scenario
{
  "status": "active",
  "action": "check_mandate_status",
  "authpayuid": 21219398804,
  "amount": "5036",
  "mandateStartDate": "2024-10-09",
  "mandateEndDate": "2049-10-09"
}
  • Failure scenario
{
  "status": 0,
  "message": "Consent is Not Mandated",
  "action": "check_mandate_status"
}

Response parameters

Parameter NameDescription
statusStatus defines acknowledgment from PayU. Possible values are:
actionAlways returned as “MANDATE_STATUS” to highlight the type of action.
authpayuidValue of registration transaction ID sent in the request echoed back.
amountThe billing amount echoed back.
mandateStartDateMandate start date echoed back.
mandateEndDateMandate end date echoed back.

🚧

Disclaimer:

Since the RBI guideline’s deadline is 31st March 2021 to implement all the changes regarding compliance, there might be slight changes in the merchant integrations. PayU has tried to envisage all changes in advance and updated our integration document accordingly.