m2pfintech
API LibraryMandates

Mandate Action (Pause, Unpause, Revoke, Update)

Performs an action on an existing mandate. Supported actions are PAUSE (temporarily suspend), UNPAUSE (resume paused mandate), REVOKE (permanently cancel), and UPDATE (modify mandate details). Some actions require UPI PIN authentication. Pausing and unpausing are not allowed for DELEGATE or ONETIME mandates. Revoking a mandate cannot be undone. The action must be compatible with the current mandate state.

POST
/upi/v1/wrapper/transaction/mandate/mandateAction

Request Body

application/json

deviceInfo*

Device and SIM information required for UPI API authentication and tracking

channelCode*string
seqNo*string
umn*string

Unique Mandate Number of the mandate to act on

action*string

Action to perform on the mandate

Value in"PAUSE" | "UNPAUSE" | "REVOKE" | "UPDATE"
credBlock?string

Encrypted UPI PIN block (required for some actions)

Response Body

application/json

curl -X POST "https://sandbox-upi-api.m2pfintech.com/upi/v1/wrapper/transaction/mandate/mandateAction" \  -H "Content-Type: application/json" \  -d '{    "deviceInfo": {      "deviceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",      "simId": "8991101200003204510",      "deviceType": "MOB",      "os": "Android",      "telecom": "Airtel",      "geoCode": "13.0827,80.2707",      "appId": "v2.0",      "ipAddress": "192.168.1.50",      "location": "Mumbai",      "mobile": "919876501234"    },    "channelCode": "HDFC0001234",    "seqNo": "703",    "umn": "UMN20260301ABCD1234",    "action": "PAUSE",    "credBlock": "encrypted-upi-pin-block"  }'

{
  "status": "SUCCESS",
  "exception": null,
  "seqNo": "703",
  "message": "Mandate paused successfully",
  "result": {
    "umn": "UMN20260301ABCD1234",
    "mandateStatus": "PAUSED"
  }
}

Fetch Mandates POST

Fetches all mandates for the user. Returns a list of mandates with their current status, details, and associated parties. Supports pagination via offset and pageNo query parameters. Can filter by mandate status if needed.

Mandate Response (Get Mandate Status) POST

Fetches the result of a previously initiated mandate operation. Pass the callbackRef from createmandate or other mandate async operations. Returns the current mandate status and details.