--- page_source: https://docs.juspay.io/upi-inapp/flutter/headless-process-payloads/request-money page_title: Request Money --- ## Request Money This operation will enable customers to request money from other UPI users ### 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. - Value: upiRequestMoney - Tags: String, Mandatory - **CustomerVpa**: - Description: Customer Vpa - Tags: String, Mandatory - **PayerVpa**: - Description: Payer Vpa. In case of UPI Number, you can get the VPA using valid VPA process - Tags: String, Mandatory - **PayerName**: - Description: Payer Name - Tags: String, Mandatory - **CollectRequestExpiryMinutes**: - Description: Duration after which collect request will become invalid. Default: 30 - Value: eg : 15 - Tags: String, Optional - **Amount**: - Description: Amount to be transfered. Numeric String with two decimals - Tags: String, Mandatory - **AccountReferenceId**: - Description: reference id for selected accounts - Tags: String, Mandatory - **Remarks**: - Description: Remarks of transaction - Tags: String, Mandatory - **UpiRequestId**: - Description: Request id for upi transaction - Tags: String, Mandatory - **Timestamp**: - Description: Time when request is created in milliseconds - Tags: String, Mandatory - **UpiNumber**: - Description: If request is to be sent to UPI Number - Tags: String, Optional - **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 - Value: - 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. Ex: stock - 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 - **Amount**: - Description: Amount to be paid. Numeric String with two decimals - Value: eg: 2.00 - Tags: String, Mandatory - **Currency**: - Value: eg: INR - Tags: String, Optional - **Customer_phone**: - Description: Mobile number - Tags: String, Optional - **Customer_email**: - Tags: String, Optional - 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 to be performed in the SDK. - Value: upiRequestMoney - Tags: String, Mandatory - **Status**: - Description: If upiRequestMoney call was success or failure - Value: SUCESS/FAILURE - Tags: String, Mandatory - **BankAccountUniqueId**: - Description: Unique Identifier for bank account across banks - Tags: String, Mandatory - **BankCode**: - Description: IIN Code for the bank - Tags: String, Mandatory - **CustomerMobileNumber**: - Description: Masked phone number of the customer - Value: - Tags: String, Mandatory - **CustomerVpa**: - Description: Customer Vpa - Tags: String, Mandatory - **MaskedAccountNumber**: - Description: Account Number with last few digits visible - Tags: String, Mandatory - **Amount**: - Description: Amount for which request is to be done. Numeric String with two decimals - Tags: String, Mandatory - **PayeeMcc**: - Description: Merchant Category Code of the payee merchant - Tags: String, Optional - **RefUrl**: - Tags: String, Optional - **GatewayResponseCode**: - Description: Response Code received from NPCI - Tags: String, Mandatory - **GatewayTransactionId**: - Description: upiRequestId as passed in request - Tags: String, Mandatory - **GatewayResponseMessage**: - Description: Response Message received from NPCI - Tags: String, Mandatory - **GatewayReferenceId**: - Description: upiResponseId as passed in request - Tags: String, Mandatory - **TransactionTimestamp**: - Description: Timestamp at which the request is made. - Tags: String, Mandatory - **OtherInfo**: - Description: As passed in request - 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 { "service": "in.juspay.hyperapi", "requestId": "9863bf03-cd26-4fe0-9b71-1200bc7e5506", "payload": { "action": "upiRequestMoney", "accountReferenceId": "XXXXXXXXXXXXXXXX", "upiRequestId": "XXXXXXXXXXXXXXXX", "timestamp": "1639129434233", "remarks": "pa", "payerName": "ABC", "payerVpa": "XXXXXXXX@XXXXXXXX", "collectRequestExpiryMinutes": "2", "customerVpa": "XXXXXXXX@XXXXXXXX", "amount": "100", "signature": "cCDo6KtDmGM.......Pl8HAlLc==", "signaturePayload": "", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639129434233", "amount": "100.00", } ``` #### Kotlin Code Snippet: ```kotlin { "service": "in.juspay.hyperapi", "requestId": "9863bf03-cd26-4fe0-9b71-1200bc7e5506", "payload": { "action": "upiRequestMoney", "accountReferenceId": "XXXXXXXXXXXXXXXX", "upiRequestId": "XXXXXXXXXXXXXXXX", "timestamp": "1639129434233", "remarks": "pa", "payerName": "ABC", "payerVpa": "XXXXXXXX@XXXXXXXX", "collectRequestExpiryMinutes": "2", "customerVpa": "XXXXXXXX@XXXXXXXX", "amount": "100", "signature": "cCDo6KtDmGM.......Pl8HAlLc==", "signaturePayload": "", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639129434233", "amount": "100.00", } ``` ## Sample Code Snippets: ### Request snippets: #### Request Code Snippet: ```request { "service": "in.juspay.hyperapi", "requestId": "9863bf03-cd26-4fe0-9b71-1200bc7e5506", "payload": { "action": "upiRequestMoney", "accountReferenceId": "XXXXXXXXXXXXXXXX", "upiRequestId": "XXXXXXXXXXXXXXXX", "timestamp": "1639129434233", "remarks": "pa", "payerName": "ABC", "payerVpa": "XXXXXXXX@XXXXXXXX", "collectRequestExpiryMinutes": "2", "customerVpa": "XXXXXXXX@XXXXXXXX", "amount": "100", "signature": "cCDo6KtDmGM.......Pl8HAlLc==", "signaturePayload": "", "merchantKeyId": "1234", } } "signaturePayload": { "merchant_id": "XXXXXX", "customer_id": "XXXXXX", "timestamp": "1639129434233", "amount": "100.00", } ``` ### Response snippets: #### Response: ```plaintext { "service": "in.juspay.hyperapi", "requestId": "f3d954b4-e9e2-4703-8758-c8b9a488d677", "payload": { "transactionTimestamp": "2021-12-11T01:54:27+05:30", "status": "SUCCESS", "maskedAccountNumber": "XXXXXXXXXXXXXXXX", "gatewayTransactionId": "XXXXXXXXXXXXXXXX", "gatewayResponseMessage": "Collect request sent successfully", "gatewayResponseCode": "00", "gatewayReferenceId": "XXXXXXXXXXX", "customerVpa": "XXXXXXXX@XXXXXX", "customerMobileNumber": "XXXXXXXXX", "bankCode": "500007", "bankAccountUniqueId": "XXXXXXXXXXXXXXXXXXXXXXXXX", "amount": "1.00", "action": "upiRequestMoney" "refUrl": "www.google.com" }, "event": "process_result", "errorMessage": "", "errorCode": "", "error": false } ```