---
page_source: https://docs.juspay.io/upi-inapp/flutter/ui-process-payloads/direct-links
page_title: UI Direct Links
---


## UI Direct Links




### 1. UPI Transaction History




###   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 upiUiTransactionHistory for this call.
      - Value: Value: upiUiTransactionHistory
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Value: Example: 1234
      - Tags: String, Mandatory
    - **Offset**:
      - Description: Offset for transactions to be returned.
      - Value: Example: 0
      - Tags: String, Mandatory
    - **UdfParameters**:
      - Description: Stringified JSON for udf parameters.
      - Value: Example: {}
      - 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: upiUiTransactionHistory
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS/FAILURE
      - 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.hyperapi",
  "payload": {
    "action": "upiUiTransactionHistory",
    "merchantKeyId": "<Merchant Key Id>",
    "offset": "0",
    "udfParameters": "{}",
    "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 Send Money



This operation lets the user directly access the SendMoney flow.


###   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 upiUiSendMoney for this call.
      - Value: Value: upiUiSendMoney
      - 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
    - **Vpa**:
      - Description: To pay directly to a vpa, it needs to be passed otherwise user is redirected to Recent Transaction, and can choose and pay from them.
      - 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: upiUiSendMoney
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS/FAILURE
      - Value: Example: SUCCESS
      - Tags: String
    - **AccountReferenceId**:
      - Description: Unique Identifier of the account.
      - Value: abcde12345abcde
      - Tags: String
    - **GatewayTransactionId**:
      - Description: UPI request id returned by gateway for the transaction
      - Value: Example: ABC123456789
      - 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: pay
      - 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": "4b38f52d-1554-492a-89eb-37e87d806825",
  "service": "in.juspay.hyperapi",
  "payload": {
    "signaturePayload":"<Stringified signature payload used for signature generation>",
    "signature":"<Generated signature for signature payload>",
    "merchantKeyId":"1234",
    "vpa":"abc@xyz",
    "action":"upiUiSendMoney"
  }
}

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



### 3. UPI Scan Pay



This operation lets the user directly access the QR code scanner, and pay.


###   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 upiUiScanPay for this call.
      - Value: Value: upiUiScanPay
      - 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
    - **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: upiUiScanPay
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS/FAILURE
      - Value: Example: SUCCESS
      - Tags: String
    - **AccountReferenceId**:
      - Description: Unique Identifier of the account.
      - Value: abcde12345abcde
      - Tags: String
    - **GatewayTransactionId**:
      - Description: UPI request id returned by gateway for the transaction
      - Value: Example: ABC123456789
      - 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: pay
      - 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": "4b38f52d-1554-492a-89eb-37e87d806825",
  "service": "in.juspay.hyperapi",
  "payload": {
    "signaturePayload":"<Stringified signature payload used for signature generation>",
    "signature":"<Generated signature for signature payload>",
    "merchantKeyId": "1234",
    "action": "upiUiScanPay"
  }
}

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



### 4. Get Bank List




###   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: getBankList
      - 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: getBankList
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS/FAILURE
      - 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": "f7443c1d-9acb-4b3d-9ae5-0e3c33dfcf5b",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "getBankList",
    "signaturePayload":"<Stringified signature payload used for signature generation>",
    "signature":"<Generated signature for signature payload>",
    "merchantKeyId": "1234",
  }
}

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



### 5. My Qr Code



This operation lets the user directly access the My QR code screen.


###   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 upiUiQrCode for this call.
      - Value: Value: upiUiQrCode
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Value: Example: 1234
      - Tags: String, Mandatory
    - **UdfParameters**:
      - Description: Stringified JSON for udf parameters.
      - Value: Example: {}
      - 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: upiUiQrCode
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : BACKPRESS/FAILURE
      - Value: Example: BACKPRESS
      - 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": "4b38f52d-1554-492a-89eb-37e87d806825",
  "service": "in.juspay.hyperapi",
  "payload": {
    "signaturePayload":"<Stringified signature payload used for signature generation>",
    "signature":"<Generated signature for signature payload>",
    "merchantKeyId": "1234",
    "action": "upiUiQrCode"
  }
}

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



### 6. Bank Transfer



This operation lets the user directly access the Bank Transfer screen.


###   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 upiUiBankTransfer for this call.
      - Value: Value: upiUiBankTransfer
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - Value: Example: 1234
      - Tags: String, Mandatory
    - **UdfParameters**:
      - Description: Stringified JSON for udf parameters.
      - Value: Example: {}
      - 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: upiUiBankTransfer
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : SUCCESS/FAILURE
      - Value: Example: SUCCESS
      - Tags: String
    - **AccountReferenceId**:
      - Description: Unique Identifier of the account.
      - Value: abcde12345abcde
      - Tags: String
    - **GatewayTransactionId**:
      - Description: UPI request id returned by gateway for the transaction
      - Value: Example: ABC123456789
      - 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: pay
      - 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": "4b38f52d-1554-492a-89eb-37e87d806825",
  "service": "in.juspay.hyperapi",
  "payload": {
    "signaturePayload":"<Stringified signature payload used for signature generation>",
    "signature":"<Generated signature for signature payload>",
    "merchantKeyId": "1234",
    "action": "upiUiBankTransfer"
  }
}

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