--- page_source: https://docs.juspay.io/upi-inapp/flutter/headless-process-payloads/list-pending-transactions page_title: List Pending Transactions --- ## List Pending Transactions This api is used to list all the pending collect requests ### 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 upiListPendingTransactions for this call. - Value: value: upiListPendingTransactions - Tags: String, Mandatory - **Limit**: - Description: Maximum number of rows to be returned. - Value: Example: 10 - Tags: String, Mandatory - **Offset**: - Description: Offset for transactions to be returned. - Tags: String, Mandatory - **UdfParameters**: - Description: Stringified json for udf parameters. - 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: upiListPendingTransactions - Tags: String, Mandatory - **Status**: - Description: Status of the Operation. Possible values : SUCCESS/FAILURE - Value: Example: SUCCESS - Tags: String, Mandatory - **Count**: - Description: Number of transactions - Value: abcde12345abcde - Tags: Int, Mandatory - **PendingTransactions**: - Description: List of pending transactions - Value: - **PayerVpa**: - Description: Payer VPA - Tags: String, Mandatory - **PayeeVpa**: - Description: Payee VPA - Tags: String, Mandatory - **PayeeName**: - Description: Payee Name - Tags: String, Mandatory - **Type**: - Description: Type of pending transaction - Tags: String, Mandatory - **Amount**: - Description: Amount for the transaction. Numeric String with two decimals - Value: Example: 200.00 - Tags: String, Mandatory - **TransactionTimestamp**: - Description: Time of the transaction - Tags: String, Mandatory - **GatewayTransactionId**: - Description: Transaction Id returned by gateway - Tags: String, Mandatory - **GatewayReferenceId**: - Description: Customer reference number (rrn) for the transaction - Tags: String, Mandatory - **Remarks**: - Description: Remarks as passed for the transaction - Tags: String, Optional - **Expiry**: - Description: Expiry time of the request - Tags: String, Mandatory - **RefUrl**: - Description: Reference url for the transaction - Tags: String, Optional - **RefCategory**: - Description: Ref category of the transaction - Value: value: upiListPendingTransactions - Tags: String, Optional - **CollectType**: - Description: Type of collect request - Tags: String, Optional - **SeqNumber**: - Description: Denotes the recurring cycle of mandate execution. Will be received only during mandate executions. - Tags: String, Optional - **AccountReferenceId**: - Description: Unique id for the bank account used - Tags: String, Optional - **IsVerifiedPayee**: - Description: Stringified boolean flag if the payee is a verified vpa - Value: value: upiListPendingTransactions - Tags: Boolean, Optional - **IsMarkedSpam**: - Description: Is the transaction initiator marked spam? - Tags: Boolean, Optional - Tags: Array of JSON, Mandatory - **OtherInfo**: - Description: Other info - Tags: String, Optional - Tags: JSON - **Error**: - Description: Possible values :- true/false - Tags: Boolean - **ErrorMessage**: - Description: Error Message - Tags: String - **ErrorCode**: - Description: Error Code - Tags: String - **Event**: - Description: value: process_result - Tags: String #### Code Snippets: - #### Java Code Snippet: ```java // block:start:managementReq { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperupi", "payload": { "action": "management", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:managementReq // block:start:managementResp { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperupi", "payload": { "action": "management", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:managementResp // block:start:incomingIntentReq { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperupi", "payload": { "action": "incomingIntent", "merchantKeyId": "", "signature": "", "signaturePayload": "" "intentData": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:incomingIntentReq // block:start:incomingIntentResp { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperupi", "payload": { "action": "incomingIntent", "status": "PAYMENT_SUCCESS", "accountRefId": "ABC123456789", "gatewayResponseCode": "", "gatewayResponseMessage": "Your transaction is successful", "actionPerformed": "approve" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:incomingIntentResp // block:start:approveCollectReq { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperupi", "payload": { "action": "approveCollect", "merchantKeyId": "", "signature": "", "signaturePayload": "" "intentData": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:approveCollectReq // block:start:approveCollectResp { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperupi", "payload": { "action": "approveCollect", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:approveCollectResp // block:start:incomingMandateIntentReq { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperupi", "payload": { "action": "incomingMandate", "merchantKeyId": "", "signature": "", "signaturePayload": "" "intentData": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:incomingMandateIntentReq // block:start:incomingMandateIntentResp { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperupi", "payload": { "action": "incomingMandate", "status": "PAYMENT_SUCCESS", "accountRefId": "ABC123456789", "gatewayMandateId": "", "gatewayResponseCode": "", "gatewayResponseMessage": "Your transaction is successful", "actionPerformed": "approve" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:incomingMandateIntentResp // block:start:approveMandateReq { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperupi", "payload": { "action": "approveMandate", "merchantKeyId": "", "gatewayMandateId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:approveMandateReq // block:start:approveMandateResp { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperupi", "payload": { "action": "approveMandate", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:approveMandateResp // block:start:upiUiTransactionHistoryReq { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperapi", "payload": { "action": "upiUiTransactionHistory", "merchantKeyId": "", "offset": "0", "udfParameters": "{}", "signature": "", "signaturePayload": "" } } "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":"", "signature":"", "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":"", "signature":"", "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" }, "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":"", "signature":"", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:getBankListReq // block:start:getBankListResp { "service": "in.juspay.hyperapi", "requestId": "f62cf173-0da9-4d78-ba9e-4ad0f61dff40", "payload": { "status": "SUCCESS", "action": "getBankList" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:getBankListResp // block:start:upiUiQrCode { "requestId": "4b38f52d-1554-492a-89eb-37e87d806825", "service": "in.juspay.hyperapi", "payload": { "signaturePayload":"", "signature":"", "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":"", "signature":"", "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 ``` #### Kotlin Code Snippet: ```kotlin // block:start:managementReq { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperupi", "payload": { "action": "management", "merchantKeyId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:managementReq // block:start:managementResp { "requestId": "19d7fa5f-24b9-4864-a659-147ca57918b4", "service": "in.juspay.hyperupi", "payload": { "action": "management", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:managementResp // block:start:incomingIntentReq { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperupi", "payload": { "action": "incomingIntent", "merchantKeyId": "", "signature": "", "signaturePayload": "" "intentData": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:incomingIntentReq // block:start:incomingIntentResp { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperupi", "payload": { "action": "incomingIntent", "status": "PAYMENT_SUCCESS", "accountRefId": "ABC123456789", "gatewayResponseCode": "", "gatewayResponseMessage": "Your transaction is successful", "actionPerformed": "approve" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:incomingIntentResp // block:start:approveCollectReq { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperupi", "payload": { "action": "approveCollect", "merchantKeyId": "", "signature": "", "signaturePayload": "" "intentData": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:approveCollectReq // block:start:approveCollectResp { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperupi", "payload": { "action": "approveCollect", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:approveCollectResp // block:start:incomingMandateIntentReq { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperupi", "payload": { "action": "incomingMandate", "merchantKeyId": "", "signature": "", "signaturePayload": "" "intentData": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:incomingMandateIntentReq // block:start:incomingMandateIntentResp { "requestId": "46a548a7-66f1-4df2-ad64-0ee2ff13a87c", "service": "in.juspay.hyperupi", "payload": { "action": "incomingMandate", "status": "PAYMENT_SUCCESS", "accountRefId": "ABC123456789", "gatewayMandateId": "", "gatewayResponseCode": "", "gatewayResponseMessage": "Your transaction is successful", "actionPerformed": "approve" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:incomingMandateIntentResp // block:start:approveMandateReq { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperupi", "payload": { "action": "approveMandate", "merchantKeyId": "", "gatewayMandateId": "", "signature": "", "signaturePayload": "" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:approveMandateReq // block:start:approveMandateResp { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperupi", "payload": { "action": "approveMandate", "status": "SUCCESS" }, "error": false, "errorMessage": "", "errorCode": "", "event": "process_result" } // block:end:approveMandateResp // block:start:upiUiTransactionHistoryReq { "requestId": "f4a7907e-5e33-4269-a989-f901c1824eb9", "service": "in.juspay.hyperapi", "payload": { "action": "upiUiTransactionHistory", "merchantKeyId": "", "offset": "0", "udfParameters": "{}", "signature": "", "signaturePayload": "" } } "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":"", "signature":"", "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":"", "signature":"", "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" }, "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":"", "signature":"", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "stock", "customer_id": "abcde12345", "timestamp": "1668389349848" } // block:end:getBankListReq // block:start:getBankListResp { "service": "in.juspay.hyperapi", "requestId": "f62cf173-0da9-4d78-ba9e-4ad0f61dff40", "payload": { "status": "SUCCESS", "action": "getBankList" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } // block:end:getBankListResp // block:start:upiUiQrCode { "requestId": "4b38f52d-1554-492a-89eb-37e87d806825", "service": "in.juspay.hyperapi", "payload": { "signaturePayload":"", "signature":"", "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":"", "signature":"", "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 ``` ## Sample Code Snippets: ### Request snippets: #### Request Code Snippet: ```request { "service": "in.juspay.hyperapi", "requestId": "693e4b2c-55af-42c0-85a9-a97972e2906f", "payload": { "limit": "100", "offset": "0", "action": "upiListPendingTransactions" } } "signaturePayload": { "merchant_id": "stock", "customer_id": "XXXXXXXX", "timestamp": "1639147293629" } ``` ### Response snippets: #### Response: ```plaintext { "service": "in.juspay.hyperapi", "requestId": "621e5bc9-a06a-4593-a16a-1be7d01d1cac", "payload": { "status": "SUCCESS", "count": "100", "pendingTransactions": [ { }, { } ], "action": "upiListPendingTransactions" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } ```