---
page_title: Is Vpa Available
product: UPI TPAP SDK
platform: React Native
page_source: https://juspay.io/in/docs/upi-tpap-sdk/react-native/headless-process-payloads/is-vpa-available
llms_txt: https://juspay.io/in/docs/llms.txt
product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt
---


## Is Vpa Available



The merchant can call this API to check whether a vpa is available.


###   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: upiVpaAvailability
      - Tags: String, Mandatory
    - **CustomerVpa**:
      - Description: Vpa to be checked
      - Tags: String, Mandatory
    - **UdfParameters**:
      - Description: Stringified JSON for udf parameters
      - Tags: JSON 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 to be performed in the SDK.
      - Value: upiVpaAvailability
      - Tags: String, Mandatory
    - **Status**:
      - Description: If upiVpaAvailability call was success or failure
      - Value: SUCCESS/FAILURE
      - Tags: String, Mandatory
    - **Available**:
      - Description: Whether the vpa is available or not
      - Value: Possible values: true/false
      - Tags: String, Mandatory
    - **VpaSuggestions**:
      - Description: Suggestions of available VPAs
      - Tags: Array of String, Mandatory
    - **OtherInfo**:
      - Description: As passed in request
      - Tags: String, Optional
    - **UdfParameters**:
      - Description: Stringified JSON for udf parameters
      - Tags: JSON 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
{"success":false,"message":"Failed to fetch snippet"}
```

#### Kotlin Code Snippet:

```kotlin
{"success":false,"message":"Failed to fetch snippet"}
```


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

#### Request Code Snippet:

```request
{"success":false,"message":"Failed to fetch snippet"}
```

### Response snippets:

#### Response:
```plaintext
{"success":false,"message":"Failed to fetch snippet"}
```



---

## Complete Code Reference

The following code files are referenced in the steps above:

### InappHeadless.txt

```
{"success":false,"message":"Failed to fetch snippet"}
```


---

## See Also

- [Get Accounts](https://juspay.io/in/docs/upi-tpap-sdk/react-native/headless-process-payloads/get-accounts)
- [Link Account to Vpa](https://juspay.io/in/docs/upi-tpap-sdk/react-native/headless-process-payloads/link-account-to-vpa)