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

Process Payload for Merchant Container

To initiate your in- house wallet flow, pass the following additional parameters under metadata.merchant_container_list in the process call to Juspay SDK. Please refer to the sample payload for the exact structure of the payload.

This will open the HyperCheckout screen (Juspay payment page) with your in-house wallet in the UI.

                      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

Must be cardTxn for Card Process calls.

                      orderId
                      *
                      

String

Mandatory

order id pertaining to the order for which the payment is started.

                      cardNumber
                      *
                      

String

Mandatory

A valid credit/debit card number entered by the user.

                      cardExpMonth
                      *
                      

String

Mandatory

Represent the expiry month of the card as MM (two digits only)

                      cardExpYear
                      *
                      

String

Mandatory

Represent the expiry year of the card as YY (two digits only)

                      cardSecurityCode
                      *
                      

String

Mandatory

CVV of the card. Usually three digits. Optional for all VISA saved cards, PLUXEE | SODEXO saved cards, and saved cards of select issuing banks of MASTERCARD

                      clientAuthToken
                      *
                      

String

Mandatory

Required for client side authentication

                      tokenize
                      
                      

boolean

This is a boolean variable and accepts true/false. If set to true, then the card will be tokenised when the transaction is successful. Else, the card will not be saved.

                      nameOnCard
                      
                      

String

Card holder name. Should contain alphabetical characters only.

                      paymentMethod
                      
                      

String

This is network of the card number provided. One of VISA/MASTERCARD/MAESTRO/AMEX/RUPAY. Mandatory for AMEX to verify the input of 4 digit CVV.

                      offers
                      
                      

Array of Strings

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

                       authType
                      
                      

String

THREE_DS/OTP/VISA_CHECKOUT

                      shouldCreateMandate
                      *
                      

Boolean

Mandatory

This is a customer’s consent flag. This should be always TRUE in case of a mandate transaction.

Merchant Container Parameters

                      display_name
                      *
                      

string

Required

Display name for your wallet

Example:-
Spencers Wallet

                      balance_amount
                      *
                      

string

Required

Wallet Balance amount in INR

Example:-
1000.0

                      eligible_amount
                      *
                      

string

Required

Max amount that can be used for the amount

Example:-
500.00

                      walletIconURL
                      *
                      

string

Required

URL to the icon that you want to show for your custom wallet

Example:-
1633088989

                      payment_method
                      *
                      

string

Required

This value will be shared from Juspay

Example:-
SPENCERS_WALLET

                      payment_method_type
                      *
                      

string

Required

Should be passed as MERCHANT_CONTAINER

Example:-
1

                      isPreSelected
                      
                      

Boolean

Optional

Should be passed as TRUE if the wallet needs to be pre-selected while opening the payment page

Example:-
TRUE

SDK Process Call Complete Paramaters

                      action
                      *
                      

String

Mandatory

Pass paymentPage is to start the Hypercheckout screen

Pass paymentManagement to start the payment management interface for deleting saved cards and linking/unlinking wallets

                      merchantId
                      *
                      

String

Mandatory

Merchant ID provided by Juspay during onboarding

                      clientId
                      *
                      

String

Mandatory

Client ID provided by Juspay during onboarding

                      orderId
                      *
                      

String

Mandatory

Unique identifier for the order. Should be Alphanumeric with character length less than 21.

Order ID at Juspay end is not case sensitive. We do not differentiate between upper and lower case values

                      amount
                      *
                      

String

Mandatory

Amount that the customer has to pay. Will accept stringified double or integer values with upto two decimal places. For example, "100.15" and "100" are valid input but "100.1532" is not valid.

Example:-
1.00

                      customerId
                      *
                      

String

Mandatory

It is the ID with which merchant refers to a customer object. This id is used to access the stored payment methods, allow EMI transactions and setup subscriptions.
In case of guest login it should be an empty string.

Example:-
customer-id-007

                      customerEmail
                      *
                      

String

Mandatory

Email address of the customer. If the backend gateway requires it, then you must send this value.

Constraints : You are allowed to use alphanumeric characters and the following special characters:!#$%&'*+-/=?^_.{|}~`@

_ and . cannot appear at the beginning or end of the local part of the email address (before and after the @ symbol).

Example:-
test@gmail.com

                      customerMobile
                      *
                      

String

Mandatory

Mobile number or fixed line number of the customer. If the backend gateway requires it, then you must send this value. We recommend passing a 10-digit number without including the "+91" or any mobile country code at the beginning.

Example:-
9999999912

                      orderDetails
                      *
                      

String

Mandatory

Stringify the orderDetails JSON payload

                      signature
                      *
                      

String

Mandatory

To provide enterprise-grade security, it is required to create a RSA-SHA256 signature of the orderDetails payload created above.

The orderDetails JSON payload first needs to be converted into a string and then signed using the Private key stored on the merchant server. Click here to know How to Generate the Signature

Example:-

AZOn8jH8RPWSzrbZ0iiHSLjMdvnvDBkyKslgx4yDadtiQ49kqf8vFh7GMEC/aSARgfovwUOBoPPRTksV6IXNlwIBwuSLWeH7/dIBC+FdtgOR1UNhRGKM17xNg/A6iLufR880Pa31QT3JAWJtRPeQ3aGczsgsFc8NzbSNCQmV2w7ziSSUAwdpU8JWthkFc2oW23QTcMHXnk/EHXf9vAHUZS1x2vKMnrUE6JuTa8vNLlpAcsZ8ueGLvBuobx6lBltsyb8+DjWT+3+W4nt1xmH734g9aOkduLyQTvGIYDKCpnvWdR0J34SvgUnCnv5XzRm9+HQInZDSslJ+1q5hAe3PQQ==

                      merchantKeyId
                      *
                      

String

Mandatory

Unique identifier against which merchant’s public key is stored with Juspay. Can be fetched from Juspay Dashboard. Login>EC Operations>Settings>Security>RSA Key

                      language
                      
                      

String

Pass the language value to localise payment experience in regional language. Accepted values are "english", "hindi", "telugu", "tamil", "bengali", "malayalam", "gujarati", "kannada", "marathi"

                      payeeName
                      
                      

String

Custom payeeName to override default payeeName in UPI-INTENT APP
May or may not reflect due to extra verification at UpiApps end which cannot be controlled by Juspay

                      displayNote
                      
                      

String

Custom displayNote to override default displayNote(transaction-note) in UPI-INTENT APP
May or may not reflect due to extra verification at UpiApps end which cannot be controlled by juspay

                      description
                      
                      

String

Description for order to be displayed to the user on amountBar

Example:-
Complete your payment