--- page_source: https://juspay.io/in/docs/upi-plugin-sdk/cordova/process-payloads/upi-onboarding page_title: UPI Onboarding and Pay --- # UPI Onboarding and Pay ### Process Parameters - Signature Support ## 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 onboardingAndPay for this call. - Value: Value: onboardingAndPay - Tags: String, Mandatory - **CustomerMobileNumber**: - Description: Customer mobile number. Device binding will take place via this number if the parameter is passed. - Value: 12 digits mobile number string - Tags: String, Conditional - **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 - **Amount**: - Description: Amount to be paid. Numeric String with two decimals - Value: Example: 2.00 - Tags: String, Mandatory - **Order_id**: - Description: Unique Identifier for the order. Should be Alphanumeric with character length less than 21.Using only sequential or numeric characters is not recommended. - Value: Example: ABC123456789 - 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 - **Customer_mobile_number**: - Description: 12 digit mobile number to be passed (with 91 prefix). To be passed when issuing PSP is BHIM or when device binding has to be limited to a particular mobile number. - Tags: String, Conditional - Tags: String, Mandatory - **ShowStatusScreen**: - Description: Pass false to hide payment status screen. Default value: true - Value: Possible values: true/false - Tags: Boolean, Optional - **UdfParameters**: - Description: Stringified JSON for udf parameters - Tags: Optional - **AccountRefId**: - Description: Reference Id to be selected for the account - Value: Example: A12345 - Tags: String, Optional - **PaymentMethod**: - Description: Payment method - Value: UPI_INAPP - 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: onboardingAndPay - Tags: String - **Status**: - Description: Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE, Pay_Failure, BACKPRESS, USER_ABORTED - Value: Example: SUCCESS - Tags: String - **SelectedAccount**: - Description: Account selected for payment - Value: - **Vpa**: - Description: UPI ID linked to account - Value: Example: XXXX - Tags: String - **Account**: - Description: Account Details - Value: - **BankCode**: - Description: Bank Code - Value: Example: 123456 - Tags: String - **BankName**: - Description: Bank Name - Value: Example: YES Bank - Tags: String - **MaskedAccountNumber**: - Description: Account Number with last few digits visible - Value: Example: XXXXXXXXX1234 - Tags: String - **MpinSet**: - Description: Is MPIN set? - Value: Value: true/false - Tags: String - **ReferenceId**: - Description: Unique Identifier for the account - Value: Example: abcd1234xyz - Tags: String - **IsPrimary**: - Description: Is the account primary? - Value: Value: true/false - Tags: String - **Ifsc**: - Description: IFSC Code - Value: Example: ABCD0123456 - Tags: String - Tags: JSON - Tags: JSON - **OrderId**: - Description: Order ID for the transaction. - Value: Example: ABC123456789 - Tags: String - **TxnUuid**: - Description: Unique reference number for the transaction - Value: Example: ABC123456789 - Tags: String - **AccountRefId**: - Description: Reference Id for selected account - Value: Example: A12345 - Tags: String - **UdfParameters**: - Description: As passed in request - 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":"No Data found for the given path"} ``` #### Kotlin Code Snippet: ```kotlin {"success":false,"message":"No Data found for the given path"} ``` ### Process Parameters - ClientAuthToken Support ## Request Payload - **RequestId**: - Description: Unique uuid-v4 string - Value: $requestId - 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 onboardingAndPay for this call. - Value: Value: onboardingAndPay - Tags: String, Mandatory - **CustomerMobileNumber**: - Description: Customer mobile number. Device binding will take place via this number if the parameter is passed. - Value: 12 digits mobile number string - Tags: String, Conditional - **MerchantId**: - Description: Unique identifier associated with an account created by juspay. - Value: Example: stock - Tags: String, Mandatory - **Amount**: - Description: Amount to be paid. Numeric String with two decimals - Value: Example: 2.00 - Tags: String, Mandatory - **OrderId**: - Description: Unique Identifier for the order. Should be Alphanumeric with character length less than 21.Using only sequential or numeric characters is not recommended. - Value: Example: ABC123456789 - Tags: String, Mandatory - **CustomerId**: - Description: Any unique reference associated with your customer. - Value: Example: abcde12345 - Tags: String, Mandatory - **ClientAuthToken**: - Description: clientAuthToken - Value: Example: tkn_2p2k1b6d26eg4740b9ef01294d3a43b4 - Tags: String, Mandatory - **AccountRefId**: - Description: Reference Id to be selected for the account - Value: Example: A12345 - Tags: String, Optional - **AuthExpiry**: - Description: Default 15min (functionality to be extended if configuration to change signature expiry is added) - Value: Example: 2021-07-19T07:20:53.318Z - Tags: String, Optional - **ShowStatusScreen**: - Description: Pass false to hide payment status screen. Default value: true - Value: Possible values: true/false - Tags: Boolean, Optional - **PaymentMethod**: - Description: Payment method - Value: UPI_INAPP - 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: onboardingAndPay - Tags: String - **Status**: - Description: Status of the Operation. Possible values : SUCCESS, PENDING, FAILURE, Pay_Failure, BACKPRESS, USER_ABORTED - Value: Example: SUCCESS - Tags: String - **SelectedAccount**: - Description: Account selected for payment - Value: - **Vpa**: - Description: UPI ID linked to account - Value: Example: XXXX - Tags: String - **Account**: - Description: Account Details - Value: - **BankCode**: - Description: Bank Code - Value: Example: 123456 - Tags: String - **BankName**: - Description: Bank Name - Value: Example: YES Bank - Tags: String - **MaskedAccountNumber**: - Description: Account Number with last few digits visible - Value: Example: XXXXXXXXX1234 - Tags: String - **MpinSet**: - Description: Is MPIN set? - Value: Value: true/false - Tags: String - **ReferenceId**: - Description: Unique Identifier for the account - Value: Example: abcd1234xyz - Tags: String - **IsPrimary**: - Description: Is the account primary? - Value: Value: true/false - Tags: String - **Ifsc**: - Description: IFSC Code - Value: Example: ABCD0123456 - Tags: String - Tags: JSON - Tags: JSON - **OrderId**: - Description: Order ID for the transaction. - Value: Example: ABC123456789 - Tags: String - **TxnUuid**: - Description: Unique reference number for the transaction - Value: Example: ABC123456789 - 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":"No Data found for the given path"} ``` #### Kotlin Code Snippet: ```kotlin {"success":false,"message":"No Data found for the given path"} ``` ### > **Note** > For more calls refer this section [Additional Processes](../miscellaneous/additional-processes)