---
page_source: https://docs.juspay.io/upi-inapp/flutter/headless-process-payloads/valid-vpa
page_title: Valid VPA
---


## Valid VPA



The merchant can call this API to check whether a vpa is valid or not.


###   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: upiValidVpa
      - Tags: String, Mandatory
    - **CustomerVpa**:
      - Description: Vpa to be checked. In case of UPI Mapper Number, the format expected to be shared is upinumber@mapper.npci, eg: 12&&89@mapper.npci
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Tags: String, Mandatory
    - **SignaturePayload**:
      - Description: Signature payload is a stringified JSON of the details mentioned in the below table.
      - Value:
        - **Merchant_id**:
          - Description: Unique identifier associated with an account created by juspay. Ex: stock
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Tags: String, Mandatory
      - Tags: String, Mandatory
    - **Signature**:
      - Description: Signature generated for the signaturePayload
      - 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 to be performed in the SDK.
      - Value: upiValidVpa
      - Tags: String, Mandatory
    - **Status**:
      - Description: Whether request was successful
      - Value: SUCCESS / FAILURE
      - Tags: String, Mandatory
    - **ResponseCode**:
      - Description: Response code
      - Value: Example: SUCCESS
      - Tags: String, Mandatory
    - **ResponseMessage**:
      - Description: Response message for code
      - Value: Example: SUCCESS
      - Tags: String, Mandatory
    - **MerchantId**:
      - Description: Unique id for the merchant as passed in request
      - Tags: String, Mandatory
    - **MerchantChannelId**:
      - Description: Unique id for the merchant channel as passed in request
      - Tags: String, Mandatory
    - **IsCustomerVpaValid**:
      - Description: Is customer VPA valid?
      - Value: Possible Values: true/false
      - Tags: String, Mandatory
    - **CustomerVpa**:
      - Description: Customer VPA
      - Value: Example: abc@xyz
      - Tags: String, Mandatory
    - **CustomerName**:
      - Description: Name of the customer
      - Value: Example: ABC
      - Tags: String, Mandatory
    - **IsMerchant**:
      - Description: If the VPA is of merchant?
      - Value: Possible Values: true/false
      - Tags: String, Mandatory
    - **Mcc**:
      - Description: Merchant Client Code
      - Tags: String, Optional
    - **IsMerchantVerified**:
      - Description: If the VPA is of verified merchant?
      - Value: Possible Values: true/false
      - Tags: String, Optional
    - **IsMandateSupported**:
      - Description: Is mandate supported on this VPA?
      - Value: Possible Values: true/false
      - Tags: String, Optional
    - **OtherInfo**:
      - Description: Other Additional information
      - 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": "93571360-f4bf-406e-9cae-75a21aaf1370",
  "payload": {
    "action": "upiValidVpa",
    "customerVpa": "abc@xyz",
    "signature": "YLDtkS...3og==\n",
    "signaturePayload": "<signaturePayload>",
    "merchantKeyId": "5317",
  }
}

"signaturePayload": {
  "merchant_id": "XXXXXXXX",
  "customer_id": "XXXXXXXX",
  "timestamp": "1639167811935"
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "service": "in.juspay.hyperapi",
  "requestId": "93571360-f4bf-406e-9cae-75a21aaf1370",
  "payload": {
    "action": "upiValidVpa",
    "customerVpa": "abc@xyz",
    "signature": "YLDtkS...3og==\n",
    "signaturePayload": "<signaturePayload>",
    "merchantKeyId": "5317",
  }
}

"signaturePayload": {
  "merchant_id": "XXXXXXXX",
  "customer_id": "XXXXXXXX",
  "timestamp": "1639167811935"
}
```


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

#### Request Code Snippet:

```request
{
  "service": "in.juspay.hyperapi",
  "requestId": "93571360-f4bf-406e-9cae-75a21aaf1370",
  "payload": {
    "action": "upiValidVpa",
    "customerVpa": "abc@xyz",
    "signature": "YLDtkS...3og==\n",
    "signaturePayload": "<signaturePayload>",
    "merchantKeyId": "5317",
  }
}

"signaturePayload": {
  "merchant_id": "XXXXXXXX",
  "customer_id": "XXXXXXXX",
  "timestamp": "1639167811935"
}
```

### Response snippets:

#### Response:
```plaintext
{
  "service": "in.juspay.hyperapi",
  "requestId": "93571360-f4bf-406e-9cae-75a21aaf1370",
  "payload": {
    "action": "upiValidVpa",
    "status": "SUCCESS",
    "responseMessage": "SUCCESS",
    "responseCode": "SUCCESS",
    "merchantId": "stock",
    "merchantChannelId": "stockAPP",
    "isCustomerVpaValid": true,
    "customerVpa": "abc@xyz",
    "customerName": "ABC"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}
```