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

ClickStream Events

Merchants can access the clickstream events in the onEvent callback from Juspay’s SDK with the event name - log_stream. The final event value will be available under the payload within the callback response.

Pass this parameter in initiate payload to receive the user click events.
"logLevel" : "1"

Step 1

Create Initiate payload

Initiate API takes two parameters as input. One of the parameter is a JSON object referred as InitiatePayload. This payload contains certain key value pairs used by the SDK to perform a successful initiate

Refer to the following table for information about the description and sample payload.

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example:- $requestId

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperpay

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK API

                      action
                      *
                      

String

Mandatory

Value: initiate

                      logLevel
                      *
                      

String

Mandatory

Value: 1

                      merchantId
                      *
                      

String

Mandatory

Unique merchant id shared during onboarding

                      clientId
                      *
                      

String

Mandatory

Unique Client id shared during onboarding

                      environment
                      *
                      

String

Mandatory

Environment to be used for the session. Accepted value is production

Step 2

Create CallbackHandler

Step 3

Check the Event Json Response

Scroll inside to view more

Event Types	Description
current_screen	This provides the name of the screen being displayed
button_clicked	This provides the name of the button which was clicked
checkbox_clicked	This provides the name of the checkbox along with the state of the checkbox
payment_instrument_group	This is emitted whenever a user selects a payment method and initiates the transaction
stored_card_selected	This is emitted whenever user taps on a stored card or transacts via it
card_selected	This is emitted whenever user transacts via the add card flow
bank_selected	This provides the bank name whenever user taps on a net banking option or transacts via it
wallet_selected	This provides the wallet name whenever user taps on a wallet option or transacts via it
upi_apps	This provides the UPI app name whenever user taps on a UPI app or transacts via it
expiry_date_changed	This is emitted when user changes the expiry value. This also provides the name of the screen where the card expiry field is changed
cvv_changed	This is emitted when user changes the cvv text. This also provides the name of the screen where the card cvv field is changed
card_number_changed	This is emitted when user changes the card number
upi_id_changed	This is emitted when user changes the UPI VPA in the collect flow