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

SDK Process Payload

This is a Client side SDK call that takes payload parameters from the merchant application based on the payment method selected by your user. It creates an transaction on Juspay and forward the request to the underlying gateways to process the transaction and then navigate to bank page for OTP authentication.

Refer the details to create Process Payload for Card transactions with offer parameters.

                      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
                      *
                      

String

Mandatory

Offer ID created on Juspay dashboard during offer configuration on Juspay Offers dashboard. It can be passed in the array of Strings
offers parameter is mandatory parameter and should be passed only for offer transactions