---
page_source: https://docs.juspay.io/upi-inapp/flutter/ui-process-payloads/management
page_title: UPI Management with UI 
---


## UPI Management with UI




### 1. UPI Profile Management



This operation supports all UPI Profile management features.


###   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. Should be getBankList for this call.
      - Value: value: management
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Value: Example: 1234
      - Tags: String, Mandatory
    - **Signature**:
      - Description: Signature generated for the signaturePayload.
      - 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.
          - Value: Example: stock
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Value: Example: abcde12345
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Value: Example: 1665996901100
          - Tags: String, Mandatory
      - Tags: String, Mandatory
  - 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: management
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE
      - Value: Example: SUCEESS
      - Tags: String
  - 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: -

#### Flutter Code Snippet:

```flutter
{
  "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4",
  "service": "in.juspay.hyperupi",
  "payload": {
    "action": "management",
    "merchantKeyId": "<Merchant Key Id>",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "abcde12345",
  "timestamp": "1668389349848"
}
```



### 2. UPI Incoming Intent for Collect



This operation will enable the merchant app to accept incoming UPI Intent requests from other apps.


###   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. Should be incomingIntent for this call.
      - Value: value: incomingIntent
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Value: Example: 1234
      - Tags: String, Mandatory
    - **IntentData**:
      - Description: It will be provided by the app triggering the merchant app for UPI transaction
      - Tags: String, Mandatory
    - **Signature**:
      - Description: Signature generated for the signaturePayload.
      - 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.
          - Value: Example: stock
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Value: Example: abcde12345
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Value: Example: 1665996901100
          - Tags: String, Mandatory
      - Tags: String, Mandatory
    - **GatewayTransactionId**:
      - Description: UPI request id returned by gateway for the transaction
      - Value: Example: ABC123456789
      - Tags: String, Optional
    - **GatewayReferenceId**:
      - Description: Customer reference number (rrn).
      - Value: Example: 1234567890
      - Tags: String, Optional
    - **ShowStatusScreen**:
      - Description: Pass false to hide payment status screen. Default value: true
      - Value: Possible values: true/false
      - Tags: Boolean, 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: incomingIntent
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : PAYMENT_SUCCESS, PAYMENT_FAILURE, BACKPRESS
      - Value: Example: PAYMENT_SUCCESS
      - Tags: String
    - **AccountReferenceId**:
      - Description: Unique Identifier of the account.
      - Value: abcde12345abcde
      - Tags: String
    - **GatewayReferenceId**:
      - Description: Customer reference number (rrn)
      - Value: Example: 1234567890
      - Tags: String
    - **GatewayResponseCode**:
      - Description: Response code returned by gateway for the mandate Operation.
      - Value: Example: 00
      - Tags: String
    - **GatewayResponseMessage**:
      - Description: Response message returned by gateway for the mandate Operation.
      - Value: Example: Your transaction is successful.
      - Tags: String
    - **ActionPerformed**:
      - Description: Name of the action Performed.
      - Value: Possible values: block/spam/approve/decline
      - Tags: String
  - 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: -

#### Flutter Code Snippet:

```flutter
{
  "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c",
  "service": "in.juspay.hyperupi",
  "payload": {
    "action": "incomingIntent",
    "merchantKeyId": "<Merchant Key Id>",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
    "intentData": "<Intent Data provided by the app triggering the merchant app for UPI transaction>"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "abcde12345",
  "timestamp": "1668389349848"
}
```



### 3. Approve UPI Collect



This operation will enable the merchant app to accept incoming UPI Collect requests from other apps. A merchant server endpoint will be configured on the axis backend. Hook will be triggered to the merchant server, which should be integrated to the merchant app GCM/FCM.


###   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. Should be approveCollect for this call.
      - Value: Value: approveCollect
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Value: Example: 1234
      - Tags: String, Mandatory
    - **Intentdata**:
      - Description: It will be provided by the app triggering the merchant app for UPI transaction. It should be base64 encrypted
      - Tags: String, Mandatory
    - **GatewayTransactionId**:
      - Description: UPI request id returned by gateway for the transaction
      - Value: Example: ABC123456789
      - Tags: String, Optional
    - **GatewayReferenceId**:
      - Description: Customer reference number (rrn).
      - Value: Example: 1234567890
      - Tags: String, Optional
    - **Signature**:
      - Description: Signature generated for the signaturePayload.
      - 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.
          - Value: Example: stock
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Value: Example: abcde12345
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Value: Example: 1665996901100
          - Tags: String, Mandatory
      - Tags: String, Mandatory
  - 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: approveCollect
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS/FAILURE/PENDING
      - Value: Example: SUCCESS
      - Tags: String
  - 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: -

#### Flutter Code Snippet:

```flutter
{
  "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9",
  "service": "in.juspay.hyperupi",
  "payload": {
    "action": "approveCollect",
    "merchantKeyId": "<Merchant Key Id>",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
    "intentData": "<Intent Data provided by the app triggering the merchant app for UPI transaction>"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "abcde12345",
  "timestamp": "1668389349848"
}
```



### 4. UPI Incoming Intent for Mandate



This operation will enable the merchant app to accept incoming UPI Intent requests from other apps.


###   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. Should be incomingIntent for this call.
      - Value: Value: incomingMandate
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Value: Example: 1234
      - Tags: String, Mandatory
    - **IntentData**:
      - Description: It will be provided by the app triggering the merchant app for UPI transaction
      - Tags: String, Mandatory
    - **Signature**:
      - Description: Signature generated for the signaturePayload.
      - 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.
          - Value: Example: stock
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Value: Example: abcde12345
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Value: Example: 1665996901100
          - Tags: String, Mandatory
      - Tags: String, Mandatory
    - **GatewayTransactionId**:
      - Description: UPI request id returned by gateway for the transaction
      - Value: Example: ABC123456789
      - Tags: String, Optional
    - **GatewayReferenceId**:
      - Description: Customer reference number (rrn).
      - Value: Example: 1234567890
      - Tags: String, Optional
    - **ShowStatusScreen**:
      - Description: Pass false to hide payment status screen. Default value: true
      - Value: Possible values: true/false
      - Tags: Boolean, 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: incomingMandate
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : PAYMENT_SUCCESS, PAYMENT_FAILURE, BACKPRESS
      - Value: Example: PAYMENT_SUCCESS
      - Tags: String
    - **AccountReferenceId**:
      - Description: Unique Identifier of the account.
      - Value: abcde12345abcde
      - Tags: String
    - **GatewayMandateId**:
      - Description: Details of the incoming mandate from the webhook
      - Value: Example: abc12345
      - Tags: String
    - **GatewayReferenceId**:
      - Description: Customer reference number (rrn)
      - Value: Example: 1234567890
      - Tags: String
    - **GatewayResponseCode**:
      - Description: Response code returned by gateway for the mandate Operation.
      - Value: Example: 00
      - Tags: String
    - **GatewayResponseMessage**:
      - Description: Response message returned by gateway for the mandate Operation.
      - Value: Example: Your transaction is successful.
      - Tags: String
    - **ActionPerformed**:
      - Description: Name of the action Performed.
      - Value: Values: approve/decline
      - Tags: String
  - 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: -

#### Flutter Code Snippet:

```flutter
{
  "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c",
  "service": "in.juspay.hyperupi",
  "payload": {
    "action": "incomingMandate",
    "merchantKeyId": "<Merchant Key Id>",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
    "intentData": "<Intent Data provided by the app triggering the merchant app for UPI transaction>"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "abcde12345",
  "timestamp": "1668389349848"
}
```



### 5. Approve UPI Mandate



This operation will enable the merchant app to accept incoming UPI Mandate requests from other apps. A merchant server endpoint will be configured on the axis backend. Hook will be triggered to the merchant server, which should be integrated to the merchant app GCM/FCM.


###   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. Should be approveMandate for this call.
      - Value: Value: approveMandate
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Value: Example: 1234
      - Tags: String, Mandatory
    - **GatewayMandateId**:
      - Description: Details of the incoming mandate from the webhook
      - Value: Example: abc12345
      - Tags: String, Mandatory
    - **GatewayReferenceId**:
      - Description: Customer reference number (rrn).
      - Value: Example: 1234567890
      - Tags: String, Optional
    - **Signature**:
      - Description: Signature generated for the signaturePayload.
      - 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.
          - Value: Example: stock
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Value: Example: abcde12345
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - Value: Example: 1665996901100
          - Tags: String, Mandatory
      - Tags: String, Mandatory
  - 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: approveMandate
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS, FAILURE, PENDING, BACKPRESS
      - Value: Example: SUCCESS
      - Tags: String
  - 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: -

#### Flutter Code Snippet:

```flutter
{
  "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9",
  "service": "in.juspay.hyperupi",
  "payload": {
    "action": "approveMandate",
    "merchantKeyId": "<Merchant Key Id>",
    "gatewayMandateId": "<gatewayMandateId from webhook>",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
  }
}

"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "abcde12345",
  "timestamp": "1668389349848"
}
```