---
page_source: https://docs.juspay.io/upi-inapp/flutter/headless-process-payloads/is-vpa-available
page_title: Is Vpa Available
---


## 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: Passed by merchant
      - 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 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
  - 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
{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiVpaAvailability",
    "customerVpa": "something@handle"
  }
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiVpaAvailability",
    "customerVpa": "something@handle"
  }
}
```


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

#### Request Code Snippet:

```request
{
  "requestId": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiVpaAvailability",
    "customerVpa": "something@handle"
  }
}
```

### Response snippets:

#### Response:
```plaintext
{
  "requestId": "<request id passed>",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiVpaAvailability",
    "status": "SUCCESS" / "FAILURE",
    "available": "true" / "false",
    "vpaSuggestions": [],
    "otherInfo": "{}"
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}
```