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


## Blocked Vpa List



The merchant can call this API to get a list of blocked vpas.


###   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: upiBlockedVpaList
      - Tags: String, Mandatory
    - **Offset**:
      - Description: Offset of vpas to be returned
      - Value: eg. 0
      - Tags: Int, Mandatory
    - **Limit**:
      - Description: Limit of vpas to be returned
      - Value: eg. 100
      - Tags: Int, 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, 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. Should be upiBlockedVpaList for this call.
      - Value: upiBlockedVpaList
      - 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
    - **MerchantCustomerId**:
      - Description: Merchant generated unique profile id for customer as passed in the request
      - Tags: String, Mandatory
    - **BlockedVpas**:
      - Description: Array of blocked vpas
      - Value:
        - **PayeeVpa**:
          - Description: Blocked payee VPA
          - Tags: String, Mandatory
        - **Name**:
          - Description: Name of the user
          - Tags: String, Mandatory
        - **BlockedAt**:
          - Description: Time when VPA was blocked
          - Tags: String, Mandatory
      - Tags: Array of JSON, Mandatory
  - 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:

### InappHeadless2.txt

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


---

## See Also

- [Delete Vpa](https://juspay.io/in/docs/upi-tpap-sdk/react-native/headless-process-payloads/delete-vpa)
- [Delete Account](https://juspay.io/in/docs/upi-tpap-sdk/react-native/headless-process-payloads/delete-account)
