Check VPA Availability
Checks whether a desired VPA (UPI ID) is available for creation. Call this API before attempting to create a VPA to verify the requested UPI ID is not already in use. Validates VPA format, handle support, restricted words, and NPCI registry. Returns TRUE if available, FALSE otherwise. For 10-digit numeric VPAs, the system validates the number matches the users registered mobile number (without country code).
Request Body
application/json
Device and SIM information required for UPI API authentication and tracking
Channel or institution code
Sequence number for request tracking
VPA (UPI ID) in username@handle format. Username can be alphanumeric with dots and underscores. Handle must be a supported handle configured by M2P.
Response Body
application/json
curl -X POST "https://sandbox-upi-api.m2pfintech.com/upi/v1/wrapper/profile/checkIfVpaAvailable" \ -H "Content-Type: application/json" \ -d '{ "deviceInfo": { "deviceId": "z8x7c6v5-b4n3-2109-mklj-ih9876543210", "simId": "8991101200001234567", "deviceType": "MOB", "os": "Android", "telecom": "Vi", "geoCode": "11.0168,76.9558", "appId": "v2.7", "ipAddress": "203.124.45.67", "location": "Coimbatore", "mobile": "919123456789" }, "channelCode": "AXIS0009876", "seqNo": "801", "vpaId": "amit.patel@indie" }'{
"status": "SUCCESS",
"exception": null,
"seqNo": "801",
"callbackRef": null,
"message": "Vpa amit.patel@indie is valid",
"pagination": null,
"result": "TRUE"
}Validate Device POST
Validates whether the device is registered and bound in the M2P UPI platform. This API checks if the device ID and mobile number combination is valid and SIM binding is complete. Use this API on app launch to verify device registration status.
Create VPA POST
Creates a new VPA (UPI ID) for the user. Call checkIfVpaAvailable first to verify the VPA is available. Registers the VPA with NPCI and associates it with the users profile. The VPA consists of a username and a handle separated by @ (e.g. amit.patel@indie). The handle must be a supported handle configured by M2P for your channel. Users can have multiple VPAs up to a configured maximum.
