---
page_title: Create New UPI Number
product: UPI TPAP SDK
platform: React Native
page_source: https://juspay.io/in/docs/upi-tpap-sdk/react-native/headless-process-payloads/create-new-upi-number
llms_txt: https://juspay.io/in/docs/llms.txt
product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt
---


## Create New UPI Number



This will be used to create a new UPI Number or port. If it is a port number request, existing vpa is required


###   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: upiCreateUpiNumber
      - Tags: String, Mandatory
    - **UpiRequestId**:
      - Description: Unique identifier (uuid) for the request sent to NPCI
      - 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 port upiNumber request. Currently linked vpa to the upi Number
      - Value: Example: abc123@handle2
      - 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: upiCreateUpiNumber
      - 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
    - **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
{"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:

### InappHeadless4.txt

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


---

## See Also

- [Update UPI Number Status](https://juspay.io/in/docs/upi-tpap-sdk/react-native/headless-process-payloads/update-upi-number-status)
- [Check UPI Number Availability](https://juspay.io/in/docs/upi-tpap-sdk/react-native/headless-process-payloads/check-upi-number-availability)
