---
page_source: https://docs.juspay.io/upi-inapp/android/headless-process-payloads/blocked-vpa-list
page_title: Blocked Vpa List
---


## 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
    - **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. 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
{
  "service": "in.juspay.hyperapi",
  "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f",
  "payload": {
    "signaturePayload": "<signature Payload>",
    "signature": "<signature>",
    "merchantKeyId": "1234",
    "limit": 100,
    "offset": 0,
    "action": "upiBlockedVpaList"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "XXXXXXXX",
  "timestamp": "1641533238616"
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "service": "in.juspay.hyperapi",
  "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f",
  "payload": {
    "signaturePayload": "<signature Payload>",
    "signature": "<signature>",
    "merchantKeyId": "1234",
    "limit": 100,
    "offset": 0,
    "action": "upiBlockedVpaList"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "XXXXXXXX",
  "timestamp": "1641533238616"
}
```


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

#### Request Code Snippet:

```request
{
  "service": "in.juspay.hyperapi",
  "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f",
  "payload": {
    "signaturePayload": "<signature Payload>",
    "signature": "<signature>",
    "merchantKeyId": "1234",
    "limit": 100,
    "offset": 0,
    "action": "upiBlockedVpaList"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "XXXXXXXX",
  "timestamp": "1641533238616"
}
```

### Response snippets:

#### Response:
```plaintext
{
  "service": "in.juspay.hyperapi",
  "requestId": "621e5bc9-a06a-4593-a16a-1be7d01d1cac",
  "payload": {
    "status": "SUCCESS",
    "merchantChannelId": "stock",
    "merchantCustomerId": "8002019282",
    "blockedVpas": [
      {
        "payeeVpa": "abc@xyz",
        "name": "ABC",
        "blockedAt": "2022-01-21T09:23:56+05:30"
      },
      {
        ….
      }
    ],
    "action": "upiBlockedVpaList"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}
```