--- page_title: UPI Intent Payments product: EC Headless platform: Android page_source: https://juspay.io/in/docs/ec-headless/android/payloads/upi-intent-payments llms_txt: https://juspay.io/in/docs/llms.txt product_llms_txt: https://juspay.io/in/docs/ec-headless/llms.txt --- # UPI Intent Transactions ### Step 1.1. UPI - Get Available Apps This action needs to be called to get the list of all UPI apps available in the device. Once received all or selective UPI apps needs to be displayed on the UI as per evolving UPI guidelines. ### Step 1.1. UPI Txn - Intent Intent flow (user selects one of the UPI enabled Apps present in his phone) and pays via the respective app. Create Payload to call Process API for UPI intent Payments. Refer code snippets on the right for reference. ### Step 1.1. Payload Parameters ## Request Payload - **RequestId**: - Description: Unique uuid-v4 string Example: abcd-12345-abcd-12345 - Value: value - Tags: String, Mandatory - **Service**: - Description: Value: in.juspay.hyperapi - Tags: String, Mandatory - **Payload**: - Description: Parameters required to call Hyper SDK API - Value: - **Action**: - Description: Must be upiTxn for UPI Process calls. - Tags: String, Mandatory - **OrderId**: - Description: order id pertaining to the order for which the payment is started. - Tags: String, Mandatory - **PayWithApp**: - Description: Package name of the app selected by the user. You can get this value from the response of getAvailableApps call done to list the available apps. For eg. For phonepe app pass**** `com.phonepe.app`(Android) and `phonepe://pay` (iOS) - Tags: String, Mandatory - **ClientAuthToken**: - Description: Required for client side authentication - Tags: String, Mandatory - **ShowLoader**: - Description: To show a loader for the processing state. - Tags: Boolean - **ShouldCreateMandate**: - Description: This is a customer’s consent flag. This should be always **TRUE** in case of a mandate transaction. - Tags: Boolean - **Offers**: - Description: The key offers should be passed only when juspay offers are being used. The value for this key can set as the offerID which is received from /v1/offers/list api - Tags: Array of Strings - Tags: JSON, Mandatory ## Sample Code Snippets: ### Sample Request: #### UPI Txn - Intent Code Snippet: ```upi txn - intent { "requestId": "eee6f65e-23dc-42e1-ad7c-ec3cddd64ac9", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "orderId": "hyperorder45314", "upiSdkPresent": true, "payWithApp": "com.phonepe.app", "displayNote": "UPI Intent", "clientAuthToken": "tkn_0e37edc631d647fdb606ab48ccfc4213", "showLoader": true } } ``` #### UPI - Get Available Apps (Android) Code Snippet: ```upi - get available apps (android) { "requestId": "eee6f65e-23dc-42e1-ad7c-ec3cddd64ac9", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "getAvailableApps": true, "showLoader": true } } ``` #### UPI - Get Available Apps (iOS) Code Snippet: ```upi - get available apps (ios) { "requestId": "eee6f65e-23dc-42e1-ad7c-ec3cddd64ac9", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "getAvailableApps": true, "showLoader": true } } ``` #### UPI Txn - Old TPV Intent Code Snippet: ```upi txn - old tpv intent { "requestId": "ccfad467-391a-43c7-b69f-147233f6414f", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "clientAuthToken": "tkn_bc83bb096607424d9f405e17c93c80e4", "displayNote": "UPI Intent ", "orderId": "82374941", "payWithApp": "com.phonepe.app", "paymentMethod": "PAY", "upiSdkPresent": true, "tpvEnabled": true, "showLoader": true } } ``` #### UPI Txn - New TPV Intent Code Snippet: ```upi txn - new tpv intent { "requestId": "ccfad467-391a-43c7-b69f-147233f6414f", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "clientAuthToken": "tkn_bc83bb096607424d9f405e17c93c80e4", "displayNote": "UPI Intent ", "orderId": "82374941", "payWithApp": "com.phonepe.app", "paymentMethod": "UPI_PAY", "upiSdkPresent": true, "tpvEnabled": true, "showLoader": true } } ``` #### UPI Txn - Intent (New Flow) Code Snippet: ```upi txn - intent (new flow) { "requestId": "eee6f65e-23dc-42e1-ad7c-ec3cddd64ac9", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "orderId": "hyperorder45314", "upiSdkPresent": true, "payWithApp": "com.phonepe.app", "displayNote": "UPI Intent", "clientAuthToken": "tkn_0e37edc631d647fdb606ab48ccfc4213", "showLoader": true, "paymentMethod": "UPI_PAY" } } ``` #### UPI Txn - New TPV Mandate Intent Code Snippet: ```upi txn - new tpv mandate intent { "requestId": "ccfad467-391a-43c7-b69f-147233f6414f", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "clientAuthToken": "tkn_bc83bb096607424d9f405e17c93c80e4", "displayNote": "UPI Intent ", "orderId": "82374941", "payWithApp": "com.phonepe.app", "paymentMethod": "UPI_PAY", "shouldCreateMandate": true, "upiSdkPresent": true, "tpvEnabled": true, "showLoader": true } } ``` #### UPI Txn - Old TPV Mandate Intent Code Snippet: ```upi txn - old tpv mandate intent { "requestId": "ccfad467-391a-43c7-b69f-147233f6414f", "service": "in.juspay.hyperapi", "payload": { "action": "upiTxn", "clientAuthToken": "tkn_bc83bb096607424d9f405e17c93c80e4", "displayNote": "UPI Intent ", "orderId": "82374941", "payWithApp": "com.phonepe.app", "paymentMethod": "PAY", "upiSdkPresent": true, "shouldCreateMandate": true, "tpvEnabled": true, "showLoader": true } } ``` ### Sample Response: #### UPI Txn - Intent: ```json { "service": "in.juspay.hyperapi", "requestId": "eee6f65e-23dc-42e1-ad7c-ec3cddd64ac9", "payload": { "action": "upiTxn", "status": "CHARGED", "orderId": "hyperorder45314" }, "errorMessage": "", "errorCode": "", "error": false } ``` #### UPI - Get Available Apps (Android): ```plaintext { "service": "in.juspay.hyperapi", "requestId": "eee6f65e-23dc-42e1-ad7c-ec3cddd64ac9", "payload": { "action": "upiTxn", "availableApps": [ { "packageName": "com.myairtelapp", "appName": "Airtel" }, { "packageName": "com.phonepe.app", "appName": "PhonePe" } ] }, "errorMessage": "", "errorCode": "", "error": false } ``` #### UPI - Get Available Apps (iOS): ```plaintext { "service": "in.juspay.hyperapi", "requestId": "eee6f65e-23dc-42e1-ad7c-ec3cddd64ac9", "payload": { "action": "upiTxn", "availableApps": [{ "appName": "GooglePay", "packageName": "tez://upi/pay" }, { "appName": "PhonePe", "packageName": "phonepe://pay" }, { "appName": "Paytm", "packageName": "paytmmp://upi/pay" }, { "appName": "Airtel", "packageName": "myairtel://upi_welcome_screen" }, { "appName": "CRED Pay UPI", "packageName": "credpay://upi/pay" }] }, "errorMessage": "", "errorCode": "", "error": false } ``` --- ## See Also - [UPI Collect Payments](https://juspay.io/in/docs/ec-headless/android/payloads/upi-collect-payments) - [Wallets Integration Workflow](https://juspay.io/in/docs/ec-headless/android/payloads/wallets-integration-workflow)