m2pfintech
API LibraryMandates

Fetch Mandates

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.

POST
/upi/v1/wrapper/transaction/mandate/fetchmandate

Query Parameters

offset?integer

Number of records per page

Default5
pageNo?integer

Page number (0-indexed)

Default0

Request Body

application/json

deviceInfo*

Device and SIM information required for UPI API authentication and tracking

channelCode*string

Channel or institution code assigned by M2P during onboarding

seqNo*string

Sequence number for request tracking

Response Body

application/json

curl -X POST "https://sandbox-upi-api.m2pfintech.com/upi/v1/wrapper/transaction/mandate/fetchmandate" \  -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": "702"  }'

{
  "status": "SUCCESS",
  "exception": null,
  "seqNo": "702",
  "result": [
    {
      "umn": "UMN20260301ABCD1234",
      "mandateStatus": "ACTIVE",
      "amount": "499.00",
      "amountRule": "EXACT",
      "recurrencePattern": "MONTHLY",
      "validityStart": "2026-04-01",
      "validityEnd": "2027-03-31",
      "payerVpa": "amit.patel@indie",
      "payeeVpa": "subscription@merchant",
      "payeeName": "Streaming Service",
      "remarks": "Monthly subscription",
      "createdDate": "2026-03-01T10:00:00Z"
    },
    {
      "umn": "UMN20260215EFGH5678",
      "mandateStatus": "PAUSED",
      "amount": "200.00",
      "amountRule": "MAX",
      "recurrencePattern": "WEEKLY",
      "validityStart": "2026-02-15",
      "validityEnd": "2026-08-15",
      "payerVpa": "amit.patel@indie",
      "payeeVpa": "utility@merchant",
      "payeeName": "Utility Service"
    }
  ]
}

Create Mandate POST

Creates a new UPI AutoPay mandate for recurring payments. A mandate authorizes periodic debits from the payers account based on defined rules (amount, frequency, validity). Supports EXACT (fixed amount), MAX (up to maximum) amount rules. Mandate types include RECURRING (periodic) and ONETIME (single future-dated payment). The payer must authenticate with UPI PIN while creating the mandate. The mandate is registered with NPCI upon successful creation.

Mandate Action (Pause, Unpause, Revoke, Update) POST

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.