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

Enroll & Process Transaction

Step 2

Process Biometric Enrollment and Payment

Create Payload to call Process API for Enroll and Process Transaction. Refer code snippets on the right for reference.

Once the SDK process function is invoked, JUSPAY SDK takes care of all the subsequent interactions with Juspay Servers as well as Native OS for the best Experience for the customer.

In this flow the SDK will start the enrollment, confirm Users Biometric Credentials and then process the first payment

Payload Parameters

Request

                      requestId
                      *
                      

String

Mandatory

Unique uuid-v4 string

Example: abcd-12345-abcd-12345

                      service
                      *
                      

String

Mandatory

Value: in.juspay.hyperpay

                      payload
                      *
                      

JSON

Mandatory

Parameters required to call Hyper SDK to initiate enrollment registration.

                      action
                      *
                      

String

Mandatory

For direct enrollment and txn the value should be pixBiometric

                      orderId
                      *
                      

String

Mandatory

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

                      clientAuthToken
                      *
                      

String

Mandatory

Required for client side authentication

                      identityCredentials
                      *
                      

String

Mandatory

Mandatory for BRL transactions

cpf

String

                      cnpj
                      
                      

String

                      accountRegistrationDate
                      *
                      

String

Mandatory

This is the date when customer registered with the business, its a mandatory field for Pix Biometric Flow.

Example: 2020-12-09

                      amount
                      *
                      

Double

required

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

required

Max Length :300

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

Example:-
customer-id-007

                      customerEmail
                      *
                      

string

required

Max Length :300

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

                      customerPhone
                      *
                      

string

required

Max Length :300

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 "+55" or any mobile country code at the beginning.

Example:-
9999999912

                      clientId
                      *
                      

string

required

A unique identifier of merchant for all client-side requests. This is available in welcome e-mail shared by Juspay

Example:-
sampleMerchantId

                      returnUrl
                      *
                      

string

required

Max Length :255

A fully qualified URL on which the customer will be redirected after payment completion. It is also required to provide the control back to SDK after the completion of transaction. This URL takes higher precedence over the common return URL configured in your account settings.

NOTE:

URL shouldn't contain any query parameters or Ip address.
URL should be a valid HTTPS endpoint that is reachable from Juspay servers.
Return URL should not redirect to a different URL.
Please ensure to pass a valid return URL in the session API call or configure it on the Juspay Dashboard. Not doing the same will lead the SDK not being closed post transaction completion.

Example:-
https://shop.merchant.com

                      firstName
                      
                      

string

Max Length :255

First Name of customer. This value will be used for customer identification.

Constraints : You are allowed to use alphanumeric characters and the following special characters: ().-_

Example:-
John

                      lastName
                      
                      

string

Max Length :255

Last name of customer. This value will be used for customer identification.

Constraints : You are allowed to use alphanumeric characters and the following special characters: ().-_

Example:-
Wick

                      description
                      
                      

String

Max Length :255

Description for order to be displayed to the user on amountBar.

Example:-
Complete your payment