JavaScript is disabled. Some features may not work. You can also read the static version: View text version

UPI Onboarding and Pay

Process Parameters - Signature Support

Request

Response

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example: abcd-12345-abcd-12345

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      action
                      *
                      

String

Mandatory

Operation to be performed in the SDK. Should be onboardingAndPay for this call.

Example:- Value: onboardingAndPay

                      customerMobileNumber
                      
                      

String

Conditional

Customer mobile number. Device binding will take place via this number if the parameter is passed.

Example:- 12 digits mobile number string

                      merchantKeyId
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.

Example: 1234

                      signature
                      *
                      

String

Mandatory

Signature generated for the signaturePayload.

                      signaturePayload
                      *
                      

String

Mandatory

Signature payload is a stringified JSON of the details mentioned in the below table.

                      merchant_id
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay.

Example: stock

                      amount
                      *
                      

String

Mandatory

Amount to be paid. Numeric String with two decimals

Example: 2.00

                      order_id
                      *
                      

String

Mandatory

Unique Identifier for the order. Should be Alphanumeric with character length less than 21.
Using only sequential or numeric characters is not recommended.

Example: ABC123456789

                      customer_id
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

Example: abcde12345

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

Example: 1665996901100

                      customer_mobile_number
                      
                      

String

Conditional

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.

                      showStatusScreen
                      
                      

Boolean

Optional

Pass false to hide payment status screen. Default value: true

Example:- Possible values: true/false

                      udfParameters
                      
                      

Optional

Stringified JSON for udf parameters

                      accountRefId
                      
                      

String

Optional

Reference Id to be selected for the account

Example: A12345

                      paymentMethod
                      *
                      

String

Mandatory

Payment method

Example:- UPI_INAPP

Process Parameters - ClientAuthToken Support

Request

Response

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example:- $requestId

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperapi

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      action
                      *
                      

String

Mandatory

Operation to be performed in the SDK. Should be onboardingAndPay for this call.

Example:- Value: onboardingAndPay

                      customerMobileNumber
                      
                      

String

Conditional

Customer mobile number. Device binding will take place via this number if the parameter is passed.

Example:- 12 digits mobile number string

                      merchantId
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay.

Example: stock

                      amount
                      *
                      

String

Mandatory

Amount to be paid. Numeric String with two decimals

Example: 2.00

                      orderId
                      *
                      

String

Mandatory

Unique Identifier for the order. Should be Alphanumeric with character length less than 21.
Using only sequential or numeric characters is not recommended.

Example: ABC123456789

                      customerId
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

Example: abcde12345

                      clientAuthToken
                      *
                      

String

Mandatory

clientAuthToken

Example: tkn_2p2k1b6d26eg4740b9ef01294d3a43b4

                      accountRefId
                      
                      

String

Optional

Reference Id to be selected for the account

Example: A12345

                      authExpiry
                      
                      

String

Optional

Default 15min (functionality to be extended if configuration to change signature expiry is added)

Example: 2021-07-19T07:20:53.318Z

                      showStatusScreen
                      
                      

Boolean

Optional

Pass false to hide payment status screen. Default value: true

Example:- Possible values: true/false

                      paymentMethod
                      *
                      

String

Mandatory

Payment method

Example:- UPI_INAPP