---
page_title: Scan & Pay (Optional)
product: UPI Plugin SDK
platform: Android
page_source: https://juspay.io/in/docs/upi-plugin-sdk/android/process-payloads/scan-pay-optional
llms_txt: https://juspay.io/in/docs/llms.txt
product_llms_txt: https://juspay.io/in/docs/upi-plugin-sdk/llms.txt
---


# UPI Scan & Pay



This action lets the user scan a QR code and complete the transaction that way. It also onboards the user if onboarding has not yet been completed.


###   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
    - **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"
  }
}

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

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


## Sample Code Snippets:
### Top Header:

#### Request Code Snippet:

```request
// 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"
  }
}

"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
```

### Bottom Header:

#### Response:
```plaintext
// 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"
  }
}

"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
```



---

## Complete Code Reference

The following code files are referenced in the steps above:

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

"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](https://juspay.io/in/docs/upi-plugin-sdk/android/process-payloads/upi-management)
- [P2M Transaction Status](https://juspay.io/in/docs/upi-plugin-sdk/android/backend-apis/p2m-transaction-s)
