Check UPI Number Request
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.
Request Body
application/json
Device and SIM information required for UPI API authentication and tracking
Channel or institution code assigned by M2P during onboarding
Sequence number for request tracking
Response Body
application/json
curl -X POST "https://sandbox-upi-api.m2pfintech.com/upi/v1/wrapper/profile/checkUpiNumberReq" \ -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": "910" }'{
"status": "SUCCESS",
"exception": null,
"seqNo": "910",
"callbackRef": "upi-num-check-uuid-123",
"result": null
}Check Profile Availability POST
Checks whether a user profile exists in the M2P UPI platform for the given device and mobile number. Use this API on app launch to determine if the user needs to go through onboarding or can directly access their existing profile.
Check UPI Number Response POST
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.