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

UPI Onboarding and Pay

The following parameters are to be passed in request if it is a pay flow i.e., merchantRequestId, merchantVpa, amount.

Process Parameters

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

                      protected
                      *
                      

String

Mandatory

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

                      kid
                      *
                      

String

Mandatory

Key ID to identify the public-private key pair used for signature generation.It will be provided to you by the Juspay team.

Example: uat833359804655gg748702e324111

                      Alg
                      *
                      

String

Mandatory

Algorithm to generate JWS signature in respect to base 64.

Example:- RS256

                      signature
                      *
                      

String

Mandatory

Generated by base 64 encoding of signaturePayload and Protected.

                      signaturePayload
                      *
                      

String

Mandatory

Base 64 encoded stringified signature payload

                      merchantId
                      *
                      

String

Mandatory

Unique identifier associated with an account created by juspay.

Example: stock

                      merchantChannelId
                      *
                      

String

Mandatory

As provided by Juspay.

Example: ABC123

                      merchantVpa
                      *
                      

String

Mandatory

VPA of the merchant.

Example: abc@xyz

                      amount
                      *
                      

String

Mandatory

Amount to be paid. Numeric String with two decimals. If it's use for mutual funds then total amount of the mutual fund would be considered.

Example: 2.00

                      merchantRequestId
                      *
                      

String

Mandatory

Merchant generated unique request Id for the transaction.

Example: ABC123456789

                      merchantCustomerId
                      *
                      

String

Mandatory

Any unique reference associated with your customer.

Example: abcde12345

                      mutualFundDetails
                      
                      

JSON

Optional

Mutual funds details payload. If Mutual funds opted then all the parameters inside it are mandatory.

                      memberId
                      *
                      

String

Mandatory

Member Id required for the customer

Example: DECIMLON

                      userId
                      *
                      

String

Mandatory

User id for the customer.

Example: DECIML

                      amount
                      *
                      

String

Mandatory

Amount to be passed in mutual fund.

Example: 13.00

                      folioNumber
                      *
                      

String

Mandatory

Folio number for the particular mutual fund.

Example: 977584255500

                      schemeCode
                      *
                      

String

Mandatory

Code value of that particular mutual fund

Example: MCGPG

                      investmentType
                      *
                      

String

Mandatory

Type of the investment.

Example:- Value: LUMPSUM/SIP

                      panNumber
                      *
                      

String

Mandatory

PAN number of the customer

Example: AJJPM7414Q

                      amcCode
                      *
                      

String

Mandatory

The asset management company code of the mutual funds.

Example: PLF

                      mfPartner
                      *
                      

String

Mandatory

Mutual fund partner.

Example:- value: CAMS/NSE/BSE/KFIN

                      orderNumber
                      *
                      

String

Mandatory

Mutual fund's order number

Example:- 32158

                      timestamp
                      *
                      

String

Mandatory

Time when request is created in milliseconds.

Example: 1665996901100

                      bankAccountHashes
                      
                      

Array

Optional

Array of bank account hashes generated using below method:

bankAccountHashes = sha256( account Number + first 4 digit of account IFSC)

From account Number the leading zeros should be removed and then the hash should be calculated.

Eg: accNo = 0000123456789 ifsc = ABCD0000345
Hash will be calculated on 123456789ABCD

Example: ["fejgfvhef67t376", "gryiu349rewiufdhsy8934"]

                      accountRefId
                      
                      

String

Optional

Reference Id of the account to be used for pay if user is onboarded.

Example: A1234

                      showStatusScreen
                      
                      

String

Optional

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

Example:- Possible values: true/false

                      bankCodes
                      
                      

Array

Optional

Array of bank codes for the respective bank accounts.

Example: ["550055", "551100"]

                      udfParameters
                      
                      

Optional

Stringified JSON for udf parameters.