m2pfintech
API LibraryVpa Management

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).

POST
/upi/v1/wrapper/profile/checkIfVpaAvailable

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

vpaId*string

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"
}