m2pfintech
API LibraryProfile Management

Check UPI Number Response

Fetches the result of a previously initiated UPI Number check request. Pass the callbackRef from checkUpiNumberReq to get the availability status of the UPI Number.

POST
/upi/v1/wrapper/profile/checkUpiNumberRes

Request Body

application/json

deviceInfo*

Device and SIM information required for UPI API authentication and tracking

channelCode*string

Channel or institution code

seqNo*string

Sequence number for request tracking

callbackRef*string

Callback reference ID received from the initiating async API call

Response Body

application/json

curl -X POST "https://sandbox-upi-api.m2pfintech.com/upi/v1/wrapper/profile/checkUpiNumberRes" \  -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": "911",    "callbackRef": "upi-num-check-uuid-123"  }'
{
  "status": "SUCCESS",
  "exception": null,
  "seqNo": "911",
  "result": {
    "upiNumber": "919876501234",
    "available": true
  }
}

Check UPI Number Request POST

Initiates a check to verify whether a UPI Number (4-digit numeric identifier) is available or already assigned. UPI Number is an alternative to VPA for receiving payments. This is an asynchronous API - use checkUpiNumberRes with the callbackRef to get the result.

Create UPI Number Request POST

Initiates the creation of a UPI Number for the user. UPI Number is a numeric identifier linked to the users VPA. Call checkUpiNumberReq first to verify availability. This is an asynchronous API - use createUpiNumberRes with the callbackRef to get the result.