JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Check UPI Number Availability

This will be used to check if the requested UPI Number is valid and available or not. If the number is not available and is a 10 digit Number we will return which vpa id it is linked to and whether we can port it.

Process Parameters

Request

Response

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example: abcd-12345-abcd-12345

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      action
                      *
                      

String

Mandatory

Operation to be performed in the SDK.

Example:- upiCheckUpiNumberAvailability

                      upiRequestId
                      *
                      

String

Mandatory

Unique identifier (uuid) for the request sent to NPCI

                      command
                      *
                      

String

Mandatory

CHECK :- used to check availability of upiNumber. PORT :- used to fetch existingVpa when CHECK returns gatewayResponseCode : "MM18"

Example:- Possible values: CHECK / PORT

                      upiNumber
                      *
                      

String

Mandatory

10 digit mobile number or 8-9 digit random number

Example: 987654321

                      vpa
                      *
                      

String

Mandatory

Customer vpa

Example: abc@xyz