---
page_title: UI Direct Links
product: UPI TPAP SDK
platform: iOS
page_source: https://juspay.io/in/docs/upi-tpap-sdk/ios/ui-process-payloads/direct-links
llms_txt: https://juspay.io/in/docs/llms.txt
product_llms_txt: https://juspay.io/in/docs/upi-tpap-sdk/llms.txt
---


## 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
    - **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: -

#### Java Code Snippet:

```java
{
  "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiUiTransactionHistory",
    "merchantKeyId": "<Merchant Key Id>",
    "offset": "0",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
  }
}

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

#### Kotlin Code Snippet:

```kotlin
{
  "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiUiTransactionHistory",
    "merchantKeyId": "<Merchant Key Id>",
    "offset": "0",
    "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: -

#### Java Code Snippet:

```java
{
  "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"
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "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 Number



This operation lets the user directly access the UPI Number or mapper 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 upiUiMapper for this call.
      - Value: Value: upiUiMapper
      - 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, Optional
    - **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, 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: upiUiMapper
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : FAILURE/BACKPRESS
      - 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: -

#### Java Code Snippet:

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

#### Kotlin Code Snippet:

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



### 4 UPI Lite Direct link.



This operation lets the user directly access the UPI Lite screen.


### Step 1.1. 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 upiUiLinkedAccounts for this call.
      - Value: Value: upiUiLinkedAccounts
      - Tags: String, Mandatory
    - **FlowKey**:
      - Description: This key will be used to identify UPI Lite flow in the SDK.
      - Value: Example: lite
      - 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, optional
    - **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, 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: upiUiLinkedAccounts
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : BACKPRESS
      - 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: -

#### Java Code Snippet:

```java
{
  "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": "upiUiLinkedAccounts",
    "flowKey": "lite"
  }
}

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

#### Kotlin Code Snippet:

```kotlin
{
  "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": "upiUiLinkedAccounts",
    "flowKey": "lite"
  }
}

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



### 5. 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
    - **UrlData**:
      - Description: provide the full QR-embedded URL.
      - Tags: String, optional
    - **EntryType**:
      - Description: Pass `cameraqr` if a camera-based scanner is being used.
      - 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: 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
    - **PayeeName**:
      - Description: Payee Name
      - Value: Example: ABC
      - Tags: String
    - **Amount**:
      - Description: Amount to be paid. Numeric String with two decimals.
      - Value: Example: 20.00
      - Tags: String
    - **TransactionTimestamp**:
      - Value: Example: 2022-01-28T14:44:51+05:30
      - 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: -

#### Java Code Snippet:

```java
{
  "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",
    "urlData":"upi://pay?pa=abcd@ypay",
    "entryType":"cameraqr",
    "showStatusScreen": true
  }
}

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

#### Kotlin Code Snippet:

```kotlin
{
  "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",
    "urlData":"upi://pay?pa=abcd@ypay",
    "entryType":"cameraqr",
    "showStatusScreen": true
  }
}

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



### 6. 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: getBankList
      - Tags: String
    - **Status**:
      - Description: Status of the Operation. Possible values : FAILURE / FRESH / BOUND / LINKED. Accounts will be available only in case status is LINKED.
      - Tags: String
    - **SessionTokenResponse**:
      - Description: Session token response
      - Value:
        - **VpaAccounts**:
          - Description: It's an array of Vpa Accounts. We will get this only after successful linking of accounts.
          - Value:
            - **Vpa**:
              - Description: UPI ID linked to account
              - Tags: String
            - **Account**:
              - Description: Accounts linked to this vpa
              - Value:
                - **Type**:
                  - Description: Type of account
                  - Value: Example: Savings
                  - Tags: String
                - **ReferenceId**:
                  - Description: Account Reference Id
                  - Tags: String
                - **Name**:
                  - Description: Account holder name
                  - Value: Example: ABC
                  - Tags: String
                - **MpinSet**:
                  - Description: Is mpin set?
                  - Value: Possible values: true/false
                  - Tags: String
                - **MaskedAccountNumber**:
                  - Description: Account Number with last few digits visible
                  - Tags: String
                - **IsPrimary**:
                  - Description: Is this account the primary account
                  - Value: Possible values: true/false
                  - Tags: String
                - **Ifsc**:
                  - Description: Account IFSC
                  - Tags: String
                - **BranchName**:
                  - Description: Name of branch in which account is registered
                  - Tags: String
                - **BankName**:
                  - Description: Name of bank
                  - Tags: String
                - **BankCode**:
                  - Description: IIN Code for the bank
                  - Tags: String
                - **BankAccountHash**:
                  - Description: hash bank account
                  - Tags: String
              - Tags: JSON
          - Tags: Array of JSON
        - **Status**:
          - Description: Status of the Operation. Possible values : FAILURE / FRESH / BOUND / LINKED. Accounts will be available only in case status is LINKED.
          - Tags: String
        - **IsDeviceBound**:
          - Description: If the current device is in bound state or not.
          - Value: Possible values: true/false
          - Tags: String
      - Tags: JSON
    - **LinkedAccounts**:
      - Description: List of linked accounts.
      - Value:
        - **Vpa**:
          - Description: UPI ID linked to account
          - Tags: String
        - **Account**:
          - Description: Accounts linked to this vpa
          - Value:
            - **Type**:
              - Description: Type of account
              - Value: Example: CURRENT
              - Tags: String
            - **ReferenceId**:
              - Description: Account Reference Id
              - Tags: String
            - **Name**:
              - Description: Account holder name
              - Value: Example: ABC
              - Tags: String
            - **MpinSet**:
              - Description: Is mpin set?
              - Value: Possible values: true/false
              - Tags: String
            - **MaskedAccountNumber**:
              - Description: Account Number with last few digits visible
              - Tags: String
            - **IsPrimary**:
              - Description: Is this account the primary account
              - Value: Possible values: true/false
              - Tags: String
            - **Ifsc**:
              - Description: Account IFSC
              - Tags: String
            - **BranchName**:
              - Description: Name of branch in which account is registered
              - Tags: String
            - **BankName**:
              - Description: Name of bank
              - Tags: String
            - **BankCode**:
              - Description: IIN Code for the bank
              - Tags: String
            - **BankAccountHash**:
              - Description: hash bank account
              - Tags: String
          - Tags: JSON
      - Tags: Array of JSON
  - 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
{
  "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"
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "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"
}
```



### 7. 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
    - **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: -

#### Java Code Snippet:

```java
{
  "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"
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "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"
}
```



### 8. 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
    - **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: -

#### Java Code Snippet:

```java
{
  "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"
}
```

#### Kotlin Code Snippet:

```kotlin
{
  "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"
}
```



### 9. Account Management



This operation lets the user directly access the Account Management screen.


### Step 1.1. 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 upiUiLinkedAccounts for this call.
      - Value: Value: upiUiLinkedAccounts
      - 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: upiUiLinkedAccounts
      - 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: -

#### Java Code Snippet:

```java
{
  "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": "upiUiLinkedAccounts"
  }
}

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

#### Kotlin Code Snippet:

```kotlin
{
  "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": "upiUiLinkedAccounts"
  }
}

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



### 10. Manage Pending Autopay :



This operation lets the user directly access the Pending Autopay screen.


### Step 1.1. Process Parameters



### Payload
- **RequestId**:
  - Description: Unique uuid-v4 string
  - Value: Example: abcd-1N2345-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.
      - 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.
          - 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
  - Tags: JSON, Mandatory




#### Code Snippets: -

#### Java Code Snippet:

```java
{
    "requestId": "4b38f52d-1554-492a-89eb-37e87d806825",
    "service": "in.juspay.hyperapi",
    "payload": {
      "signaturePayload": "<Base 64 encoding of stringified signature payload>",
      "protected": "<Base 64 encoding of stringified protected payload>",
      "signature": "<Base 64 encoding of signaturePayload and Protected>"
      "action": "approveMandate"
    }
  }

  "signaturePayload": {
    "merchantId": "<stock>",
    "merchantChannelId": "<stock>"
    "merchantCustomerId": "12345",
    "timestamp": "1668389349848",
    "simSerialNos": "0",
    "deviceId": "57c91b75d6cf51718efd28f75b59a8694"
  }

  "protected": {
  "kid":"uat833359804655bb748702e324111",
  "alg":"RS256"
}
```



### 11. Transaction Detail



This operation lets the user directly access the Transaction Detail screen.


### Step 1.1. 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 upiUiTransactionDetails for this call.
      - Value: Value: upiUiTransactionDetails
      - Tags: String, Mandatory
    - **TxnList**:
      - Description: JSON containing all transaction related data .
      - Value:
        - **Amount**:
          - Description: Amount for which the particular transaction was executed. Numeric String with two decimals
          - Value: eg : 5000
          - Tags: String, Mandatory
        - **GatewayReferenceId**:
          - Tags: String, Mandatory
        - **GatewayResponseCode**:
          - Description: Response Code received from NPCI
          - Tags: String, Mandatory
        - **GatewayTransactionId**:
          - Description: upiRequestId as passed in request
          - Tags: String, Mandatory
        - **PayeeName**:
          - Description: Payee Name
          - Tags: String, Mandatory
        - **PayeeVpa**:
          - Description: Payee Vpa
          - Tags: String, Optional
        - **PayerName**:
          - Description: Payer Name
          - Tags: String, Optional
        - **PayerVpa**:
          - Description: Payer Vpa
          - Tags: String, Optional
        - **Remarks**:
          - Description: Remarks for this transaction
          - Tags: String, Mandatory
        - **TransactionTimestamp**:
          - Description: Time at which this transaction was executed.
          - Tags: String, Mandatory
        - **Type**:
          - Description: Type of transaction.
          - Tags: String, Mandatory
        - **IsP2MTransaction**:
          - Description: If the transaction was P2M transaction or P2P transaction
          - Value: true / false
          - Tags: Boolean, Mandatory
        - **Expiry**:
          - Description: Time after which the transaction would expire
          - Tags: String, Optional
        - **RefUrl**:
          - Tags: String, Optional
        - **RefCategory**:
          - Tags: String, Optional
        - **GatewayResponseMessage**:
          - Description: Response Message received from NPCI
          - Tags: String, Optional
        - **MerchantRequestId**:
          - Description: Merchant generated id for the mandate request.
          - Tags: String, Optional
        - **SelfInitiated**:
          - Description: If this transaction was self initiated or not
          - Tags: String, Optional
      - Tags: JSON, 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: upiUiTransactionDetails
      - 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: -

#### Java Code Snippet:

```java
{
  "requestId": "4b38f52d-1554-492a-89eb-37e87d806825",
  "service": "in.juspay.hyperapi",
  "payload": {
    "txnList": {
      "type": "COLLECT",
      "transactionTimestamp": "2023-04-13T11:49:09+05:30",
      "selfInitiated": "true",
      "remarks": "UPI",
      "refUrl": "https:\/\/www.juspay.com\/",
      "payerVpa": "hah@yesg",
      "payerName": "Venkat",
      "payeeVpa": "venkat590@yesg",
      "payeeName": "Venkat",
      "merchantRequestId": "065ae19dffe94e349bf30aaeae76922b",
      "isP2MTransaction": false,
      "gatewayTransactionId": "YJP065ae19dffe94e349bf30aaeae76922b",
      "gatewayResponseMessage": "Your collect request has expired",
      "gatewayResponseCode": "U69",
      "gatewayReferenceId": "346980007941",
      "expiry": "2023-04-13T12:19:09+05:30",
      "amount": "51.00"
    },
    "signaturePayload": "<Stringified signature payload used for signature generation>",
    "signature": "<Generated signature for signature payload>",
    "merchantKeyId": "1234",
    "action": "upiUiTransactionDetails"
  }
}

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

#### Kotlin Code Snippet:

```kotlin
{
  "requestId": "4b38f52d-1554-492a-89eb-37e87d806825",
  "service": "in.juspay.hyperapi",
  "payload": {
    "txnList": {
      "type": "COLLECT",
      "transactionTimestamp": "2023-04-13T11:49:09+05:30",
      "selfInitiated": "true",
      "remarks": "UPI",
      "refUrl": "https:\/\/www.juspay.com\/",
      "payerVpa": "hah@yesg",
      "payerName": "Venkat",
      "payeeVpa": "venkat590@yesg",
      "payeeName": "Venkat",
      "merchantRequestId": "065ae19dffe94e349bf30aaeae76922b",
      "isP2MTransaction": false,
      "gatewayTransactionId": "YJP065ae19dffe94e349bf30aaeae76922b",
      "gatewayResponseMessage": "Your collect request has expired",
      "gatewayResponseCode": "U69",
      "gatewayReferenceId": "346980007941",
      "expiry": "2023-04-13T12:19:09+05:30",
      "amount": "51.00"
    },
    "signaturePayload": "<Stringified signature payload used for signature generation>",
    "signature": "<Generated signature for signature payload>",
    "merchantKeyId": "1234",
    "action": "upiUiTransactionDetails"
  }
}

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



### **12. FAQs** 



This operation lets the user directly access the FAQs screen.


### Step 1.1. 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 upiUiFaqCategories for this call.
      - Value: Value: upiUiFaqCategories
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - 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: uat833359804655bb748702e324111
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Value: RS256
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - 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: upiUiTransactionDetails
      - 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






### **13. My Queries** 



This operation lets the user directly access the My Queries screen.


### Step 1.1. 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 upiUiMyQueries for this call.
      - Value: Value: upiUiMyQueries
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - 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: uat833359804655bb748702e324111
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Value: RS256
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - 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: upiUiTransactionDetails
      - 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






### **14. Pending Mandates** 



This operation lets the user directly access the Pending Mandates screen.


### Step 1.1. 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 upiUiPendingMandates for this call.
      - Value: Value: upiUiPendingMandates
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - 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: uat833359804655bb748702e324111
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Value: RS256
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - 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: upiUiTransactionDetails
      - 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






### **15. Mandate History** 



This operation lets the user directly access the Mandate History screen.


### Step 1.1. 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 upiUiMandateHistory for this call.
      - Value: Value: upiUiMandateHistory
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - 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: uat833359804655bb748702e324111
          - Tags: String, Mandatory
        - **Customer_id**:
          - Description: Any unique reference associated with your customer.
          - Value: RS256
          - Tags: String, Mandatory
        - **Timestamp**:
          - Description: Time when request is created in milliseconds.
          - 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: upiUiTransactionDetails
      - 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






### **16. Blocked VPAs** 



This operation lets the user directly access the Blocked VPAs screen.


### Step 1.1. 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 upiUiBlockedVpa for this call.
      - Value: Value: upiUiBlockedVpa
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - 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.
          - 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
  - 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: upiUiTransactionDetails
      - 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






### **17. Credit Cards** 



This operation lets the user directly access the Credit Cards screen.


### Step 1.1. 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 upiUiCreditCards for this call.
      - Value: Value: upiUiCreditCards
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - 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.
          - 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
  - 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: upiUiTransactionDetails
      - 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






### **18. Upi Circle** 



This operation lets the user directly access Upi Circle Management screen.


### Step 1.1. 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 upiCircle for this call.
      - Value: Value: upiUiCircle
      - Tags: String, Mandatory
    - **MerchantKeyId**:
      - Description: Key ID to identify the public-private key pair used for signature generation.
      - 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.
          - 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
  - 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: upiUiTransactionDetails
      - 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





---

## Complete Code Reference

The following code files are referenced in the steps above:

### bankDirectLinks.txt

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

### InappDirectLinks.txt

```
// block:start:upiUiTransactionHistoryReq

{
  "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiUiTransactionHistory",
    "merchantKeyId": "<Merchant Key Id>",
    "offset": "0",
    "signature": "<Generated signature for signature payload>",
    "signaturePayload": "<Stringified signature payload used for signature generation>"
  }
}

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

// block:end:upiUiTransactionHistoryReq

// block:start:upiUiTransactionHistoryResp

{
  "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9",
  "service": "in.juspay.hyperapi",
  "payload": {
    "action": "upiUiTransactionHistory",
    "status": "SUCCESS"
  },
  "error": false,
  "errorMessage": "",
  "errorCode": "",
  "event": "process_result"
}

// block:end:upiUiTransactionHistoryResp

// block:start:upiUiSendMoneyReq

{
  "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"
}

// block:end:upiUiSendMoneyReq

// block:start:upiUiSendMoneyResp

{
  "service": "in.juspay.hyperapi",
  "requestId": "d0c1d85e-c954-4758-9701-bfa69dd33239",
  "payload": {
    "status": "Successful",
    "gatewayTransactionId": "AXB4e3459e929a6464d8a37c47e9e52b7c1",
    "gatewayResponseMessage": "Your transaction is successful",
    "gatewayResponseCode": "00",
    "actionPerformed": "Pay",
    "action": "upiUiSendMoney",
    "accountReferenceId": "Aa6c1763d28a406e8c2d7fbe23fcc1"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}

// block:end:upiUiSendMoneyResp

// block:start:upiUiScanPayReq

{
  "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",
    "urlData":"upi://pay?pa=abcd@ypay",
    "entryType":"cameraqr",
    "showStatusScreen": true
  }
}

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

// block:end:upiUiScanPayReq

// block:start:upiUiScanPayResp

{
  "service": "in.juspay.hyperapi",
  "requestId": "d0c1d85e-c954-4758-9701-bfa69dd33239",
  "payload": {
    "status": "Successful",
    "gatewayTransactionId": "AXB4e3459e929a6464d8a37c47e9e52b7c1",
    "gatewayResponseMessage": "Your transaction is successful",
    "gatewayResponseCode": "00",
    "actionPerformed": "Pay",
    "action": "upiUiScanPay",
    "accountReferenceId": "Aa6c1763d28a406e8c2d7fbe23fcc1",
    "payeeName": "ABC",
    "amount": "20.00",
    "transactionTimestamp": "2022-01-28T14:44:51+05:30"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}

// block:end:upiUiScanPayResp

// block:start:getBankListReq

{
  "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"
}

// block:end:getBankListReq

// block:start:getBankListResp

{
      "service":"in.juspay.hyperapi",
     "requestId":"e64db3ab-9614-4847-a088-9fd49965d177",
      "payload":{
         "status":"LINKED",
         "sessionTokenResponse":{
            "vpaAccounts":[
               {
                  "vpa":"abcaa47169@axisbiz",
                  "account":{
                     "type":"CURRENT",
                     "referenceId":"Afff44cf2f404129947f786c33e695",
                     "name":"ABC",
                     "mpinSet":"true",
                     "maskedAccountNumber":"XXXXXXXXXX254769",
                     "isPrimary":"true",
                     "ifsc":"AABF0008032",
                     "branchName":"",
                     "bankName":"Mypsp2",
                     "bankCode":"500004",
                     "bankAccountHash":null,
                  }
               }
            ],
            "status":"LINKED",
            "isDeviceBound":"true"
         },
         "linkedAccounts":[
            {
               "vpa":"abcaa47169@axisbiz",
               "account":{
                  "type":"CURRENT",
                  "referenceId":"Afff44cf2f404129947f786c33e695",
                  "name":"ABC",
                  "mpinSet":"true",
                  "maskedAccountNumber":"XXXXXXXXXX254769",
                  "isPrimary":"true",
                  "ifsc":"AABF0008032",
                  "branchName":"",
                  "bankName":"Mypsp2",
                  "bankCode":"500004",
                  "bankAccountHash":null,
               }
            }
         ],
         "action":"getBankList"
      },
      "errorMessage":"",
      "errorCode":"",
      "error":false,
      "event": "process_result"
},

// block:end:getBankListResp

// block:start:upiUiQrCode

{
  "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"
}

// block:end:upiUiQrCode

// block:start:upiUiQrCodeResp

{
  "service": "in.juspay.hyperapi",
  "requestId": "d0c1d85e-c954-4758-9701-bfa69dd33239",
  "payload": {
    "action": "upiUiQrCode",
    "status": "BACKPRESS"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}

// block:end:upiUiQrCodeResp

// block:start:upiUiBankTransfer

{
  "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"
}

// block:end:upiUiBankTransfer

// block:start:upiUiBankTransferResp

{
  "service": "in.juspay.hyperapi",
  "requestId": "d0c1d85e-c954-4758-9701-bfa69dd33239",
  "payload": {
    "status": "Successful",
    "gatewayTransactionId": "AXB4e3459e929a6464d8a37c47e9e52b7c1",
    "gatewayResponseMessage": "Your transaction is successful",
    "gatewayResponseCode": "00",
    "actionPerformed": "Pay",
    "action": "upiUiBankTransfer",
    "accountReferenceId": "Aa6c1763d28a406e8c2d7fbe23fcc1"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}

// block:end:upiUiBankTransferResp

// block:start:upiUiLinkedAccounts

{
  "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": "upiUiLinkedAccounts"
  }
}

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

// block:end:upiUiLinkedAccounts

// block:start:upiUiLinkedAccountsResp

{
  "service": "in.juspay.hyperapi",
  "requestId": "d0c1d85e-c954-4758-9701-bfa69dd33239",
  "payload": {
    "action": "upiUiLinkedAccounts",
    "status": "BACKPRESS"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}

// block:end:upiUiLinkedAccountsResp

// block:start:upiUiTransactionDetails

{
  "requestId": "4b38f52d-1554-492a-89eb-37e87d806825",
  "service": "in.juspay.hyperapi",
  "payload": {
    "txnList": {
      "type": "COLLECT",
      "transactionTimestamp": "2023-04-13T11:49:09+05:30",
      "selfInitiated": "true",
      "remarks": "UPI",
      "refUrl": "https:\/\/www.juspay.com\/",
      "payerVpa": "hah@yesg",
      "payerName": "Venkat",
      "payeeVpa": "venkat590@yesg",
      "payeeName": "Venkat",
      "merchantRequestId": "065ae19dffe94e349bf30aaeae76922b",
      "isP2MTransaction": false,
      "gatewayTransactionId": "YJP065ae19dffe94e349bf30aaeae76922b",
      "gatewayResponseMessage": "Your collect request has expired",
      "gatewayResponseCode": "U69",
      "gatewayReferenceId": "346980007941",
      "expiry": "2023-04-13T12:19:09+05:30",
      "amount": "51.00"
    },
    "signaturePayload": "<Stringified signature payload used for signature generation>",
    "signature": "<Generated signature for signature payload>",
    "merchantKeyId": "1234",
    "action": "upiUiTransactionDetails"
  }
}

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

// block:end:upiUiTransactionDetails

// block:start:upiUiTransactionDetailsResp

{
  "service": "in.juspay.hyperapi",
  "requestId": "d0c1d85e-c954-4758-9701-bfa69dd33239",
  "payload": {
    "action": "upiUiTransactionDetails",
    "status": "BACKPRESS"
  },
  "event": "process_result",
  "errorMessage": "",
  "errorCode": "",
  "error": false
}

// block:end:upiUiTransactionDetailsResp

// block:start:upiUiLite

{
  "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": "upiUiLinkedAccounts",
    "flowKey": "lite"
  }
}

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

// block:end:upiUiLite

// block:start:upiUiMapper
  
{
  "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": "upiUiMapper"
  }
}
  
"signaturePayload": {
  "merchant_id": "stock",
  "customer_id": "abcde12345",
  "timestamp": "1668389349848"
}
  
// block:end:upiUiMapper

// block:start:upiUiMapperResp
{
  "errorMessage": "",
  "requestId": "4b38f52d-1554-492a-89eb-37e87d806825",
  "service": "in.juspay.hyperapi",
  "payload": { "status": "User has aborted", "action": "upiUiMapper" },
  "errorCode": "",
  "event": "process_result",
  "error": false
}
// block:end:upiUiMapperResp
```


---

## See Also

- [UPI Management with UI ](https://juspay.io/in/docs/upi-tpap-sdk/ios/ui-process-payloads/management)
- [Get Session Token](https://juspay.io/in/docs/upi-tpap-sdk/ios/headless-process-payloads/get-session-token)