---
page_source: https://docs.juspay.io/upi-inapp/flutter/headless-process-payloads/check-upi-number-availability
page_title: Check UPI Number Availability
---


## 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 Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-12345-abcd-12345
  - Tags: String, Mandatory
- **Service**:
  - Description: Value: in.juspay.hyperapi
  - Tags: String, Mandatory
- **Payload**:
  - Description: Parameters required to call Hyper SDK API
  - Value:
    - **Action**:
      - Description: Operation to be performed in the SDK.
      - Value: upiCheckUpiNumberAvailability
      - Tags: String, Mandatory
    - **UpiRequestId**:
      - Description: Unique identifier (uuid) for the request sent to NPCI
      - Tags: String, Mandatory
    - **Command**:
      - Description: CHECK :- used to check availability of upiNumber. PORT :- used to fetch existingVpa when CHECK returns gatewayResponseCode : "MM18"
      - Value: Possible values: CHECK / PORT
      - Tags: String, Mandatory
    - **UpiNumber**:
      - Description: 10 digit mobile number or 8-9 digit random number
      - Value: Example: 987654321
      - Tags: String, Mandatory
    - **Vpa**:
      - Description: Customer vpa
      - Value: Example: abc@xyz
      - Tags: String, Mandatory
    - **UdfParameters**:
      - Description: Stringified json for udf parameters
      - Tags: String, Optional
  - Tags: JSON, Mandatory


## Response Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-12345-abcd-12345
  - Tags: String
- **Service**:
  - Description: Value: in.juspay.hyperapi
  - Tags: String
- **Payload**:
  - Description: Response Parameters
  - Value:
    - **Action**:
      - Description: Operation performed in the SDK.
      - Value: Value: upiCheckUpiNumberAvailability
      - Tags: String, Mandatory
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS, FAILURE
      - Tags: String, Mandatory
    - **ResponseCode**:
      - Description: SUCCESS if the call succeeded. Otherwise shows the error code.
      - Tags: String, Mandatory
    - **ResponseMessage**:
      - Description: SUCCESS if the call succeeded. Otherwise shows verbose error.
      - Tags: String, Mandatory
    - **GatewayStatus**:
      - Description: UpiNumber Status :- ACTIVE | INACTIVE | DEREGISTER | PENDING | NEW | FAILED
      - Tags: String, Mandatory
    - **GatewayResponseStatus**:
      - Description: Response status returned by gateway
      - Tags: String, Mandatory
    - **GatewayResponseMessage**:
      - Description: Verbose response message returned by gateway for the transaction.
      - Tags: String, Mandatory
    - **GatewayResponseCode**:
      - Description: Response code returned by gateway for the transaction
      - Tags: String, Mandatory
    - **GatewayTransactionId**:
      - Description: UPI request id returned by gateway for the transaction.
      - Tags: String, Mandatory
    - **CustomerMobileNumber**:
      - Description: Customer mobile number
      - Tags: String, Mandatory
    - **UpiNumber**:
      - Description: Unique upi number
      - Tags: String, Mandatory
    - **MerchantCustomerId**:
      - Description: Customer Id
      - Tags: String, Mandatory
    - **GatewayTimestamp**:
      - Description: Timestamp when the request was processed
      - Tags: String, Mandatory
    - **ExistingVpa**:
      - Description: Vpa to which upiNumber is currently linked. Only returned when command is "PORT" and upiNumber is linked to some other customerId
      - Tags: String, Optional
    - **OtherInfo**:
      - Description: As passed in request
      - Tags: String, Optional
  - Tags: JSON
- **Error**:
  - Description: Possible values :- true/false
  - Tags: Boolean
- **ErrorMessage**:
  - Description: Error Message
  - Tags: String
- **ErrorCode**:
  - Description: Error Code
  - Tags: String
- **Event**:
  - Description: Value: process_result
  - Tags: String





#### Code Snippets: -

#### Java Code Snippet:

```java
{
  "service": "in.juspay.hyperapi",
  "requestId": "26d8efaf-b2ff-4a46-a4a0-973124ac2a3b",
  "payload": {
    "action": "upiCheckUpiNumberAvailability",
    "upiRequestId": "AXB123456838498793",
    "upiNumber": "987654321",
    "command": "CHECK",
    "vpa": "abc@xyz",
  }
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "service": "in.juspay.hyperapi",
  "requestId": "26d8efaf-b2ff-4a46-a4a0-973124ac2a3b",
  "payload": {
    "action": "upiCheckUpiNumberAvailability",
    "upiRequestId": "AXB123456838498793",
    "upiNumber": "987654321",
    "command": "CHECK",
    "vpa": "abc@xyz",
  }
}
```


## Sample Code Snippets:
### Request snippets:

#### Request Code Snippet:

```request
{
  "service": "in.juspay.hyperapi",
  "requestId": "26d8efaf-b2ff-4a46-a4a0-973124ac2a3b",
  "payload": {
    "action": "upiCheckUpiNumberAvailability",
    "upiRequestId": "AXB123456838498793",
    "upiNumber": "987654321",
    "command": "CHECK",
    "vpa": "abc@xyz",
  }
}
```

### Response snippets:

#### Response:
```plaintext
{
  "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiCheckUpiNumberAvailability",
    "status": "SUCCESS" ,
    "responseMessage" : "SUCCESS",
    "responseCode" : "SUCCESS",
    "otherInfo" : "{}",
    "gatewayStatus" :"NEW",
    "gatewayResponseStatus" :  "SUCCESS",
    "gatewayResponseMessage" :  "Your CHECK call was successful",
    "gatewayResponseCode" : "00",
    "gatewayTransactionId" : "ABCD123456789",
    "customerMobileNumber" : "7654321098",
    "upiNumber" : "987654321",
    "merchantCustomerId" : "12345678909286",
    "gatewayTimestamp" : "2021-12-21T11:19:48+05:30"
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": ""
}
```