---
page_source: https://docs.juspay.io/upi-inapp/flutter/headless-process-payloads/update-upi-number-status
page_title: Update UPI Number Status
---


## Update UPI Number Status



This is a clubbed api endpoints for change vpa, disable, delete, reactivate.


###   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: upiUpdateUpiNumberStatus
      - Tags: String, Mandatory
    - **UpiRequestId**:
      - Description: Unique identifier (uuid) for the request sent to NPCI
      - Tags: String, Mandatory
    - **Command**:
      - Description: Possible values: CHANGE_VPA, DISABLE, DELETE, REACTIVATE
      - Tags: String, Mandatory
    - **UpiNumber**:
      - Description: 10 digit mobile number or 8-9 digit random number
      - Value: Example: 987654321
      - Tags: String, Mandatory
    - **Vpa**:
      - Description: Customer vpa
      - Value: Example: abc@handle1
      - Tags: String, Mandatory
    - **ExistingVpa**:
      - Description: Needed only for CHANGE_VPA request. Currently linked vpa to the upi Number
      - Value: Example: abc123@handle2
      - 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 performed in the SDK.
      - Value: Value: upiUpdateUpiNumberStatus
      - Tags: String, Mandatory
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS, FAILURE
      - Tags: String, Mandatory
    - **ResponseCode**:
      - Description: SUCCESS if the call succeeded. Otherwise shows the error code.
      - Tags: String, Mandatory
    - **ResponseMessage**:
      - Description: SUCCESS if the call succeeded. Otherwise shows verbose error.
      - Tags: String, Mandatory
    - **GatewayStatus**:
      - Description: UpiNumber Status :- ACTIVE | INACTIVE | DEREGISTER | PENDING | NEW | FAILED
      - Tags: String, Mandatory
    - **GatewayResponseStatus**:
      - Description: Response status returned by gateway
      - Tags: String, Mandatory
    - **GatewayResponseMessage**:
      - Description: Verbose response message returned by gateway for the transaction.
      - Tags: String, Mandatory
    - **GatewayResponseCode**:
      - Description: Response code returned by gateway for the transaction
      - Tags: String, Mandatory
    - **GatewayTransactionId**:
      - Description: UPI request id returned by gateway for the transaction.
      - Tags: String, Mandatory
    - **CustomerMobileNumber**:
      - Description: Customer mobile number
      - Tags: String, Mandatory
    - **UpiNumber**:
      - Description: Unique upi number
      - Tags: String, Mandatory
    - **MerchantCustomerId**:
      - Description: Customer Id
      - Tags: String, Mandatory
    - **GatewayTimestamp**:
      - Description: Timestamp when the request was processed
      - Tags: String, Mandatory
    - **ExistingVpa**:
      - Description: Vpa to which upiNumber is currently linked. Only returned when command is "PORT" and upiNumber is linked to some other customerId
      - Tags: String, Optional
    - **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
{
  "service": "in.juspay.hyperapi",
  "requestId": "26d8efaf-b2ff-4a46-a4a0-973124ac2a3b",
  "payload": {
    "action": "upiUpdateUpiNumberStatus",
    "command": "CHANGE_VPA",
    "upiRequestId": "ABC123456789",
    "upiNumber": "98765432",
    "vpa": "newerVpa@xyz",
    "existingVpa": "olderVpa@xyz",
    }
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "service": "in.juspay.hyperapi",
  "requestId": "26d8efaf-b2ff-4a46-a4a0-973124ac2a3b",
  "payload": {
    "action": "upiUpdateUpiNumberStatus",
    "command": "CHANGE_VPA",
    "upiRequestId": "ABC123456789",
    "upiNumber": "98765432",
    "vpa": "newerVpa@xyz",
    "existingVpa": "olderVpa@xyz",
    }
}
```


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

#### Request Code Snippet:

```request
{
  "service": "in.juspay.hyperapi",
  "requestId": "26d8efaf-b2ff-4a46-a4a0-973124ac2a3b",
  "payload": {
    "action": "upiUpdateUpiNumberStatus",
    "command": "CHANGE_VPA",
    "upiRequestId": "ABC123456789",
    "upiNumber": "98765432",
    "vpa": "newerVpa@xyz",
    "existingVpa": "olderVpa@xyz",
    }
}
```

### Response snippets:

#### Response:
```plaintext
{
   "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9",
   "service": "in.juspay.hyperupi",
   "payload": {
      "action": "upiUpdateUpiNumberStatus",
      "status": "SUCCESS" ,
      "responseMessage" : "SUCCESS",
      "responseCode" : "SUCCESS",
      "otherInfo" : "{}",
      "gatewayStatus" :"DISABLED",
      "gatewayResponseStatus" :  "SUCCESS",
      "gatewayResponseMessage" :  "",
      "gatewayResponseCode" : "00",
      "gatewayTransactionId" : "ABC1234567898765",
      "customerMobileNumber" : "9876543456",
      "upiNumber" : "345678989",
      "merchantCustomerId" : "987654345678",
      "gatewayTimestamp" : "2021-12-21T11:19:48+05:30",
      "vpa": "abc@xyz",
   },
   "error": false,
   "errorMessage": "",
   "errorCode": "",
   "event": ""
}
```