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

Eligibility Check (Native)

Always invoke this method whenever there is a change in the order amount.

To display the complete list of SDK based wallet instruments (ApplePay), call the below process function with action as ‘sdkWalletEligibility’.

Depending on the isEligible parameter in the response, the merchant needs to decide to show or hide the corresponding instrument.

Verify whether the device supports Apple Pay

The applePayCapabilities method asynchronously contacts Apple Pay servers as part of the verification process and returns the paymentCredentialStatus of the device.

The following are possible return values:

paymentCredentialsAvailable
Confirms that the device supports Apple Pay and there’s at least one active payment credential in Wallet that qualifies for payments on the web. Show an Apple Pay button and offer Apple Pay as the primary, but not necessarily sole, payment option.
applePayUnsupported
Indicates that the device doesn’t support Apple Pay. Don’t display an Apple Pay button or offer Apple Pay as a payment option.

Request Parameters

                      requestId
                      *
                      

String

Mandatory

Unique identifier for the request.

                      service
                      *
                      

String

Mandatory

Always in.juspay.hyperapi

                      payload
                      *
                      

Object

Mandatory

Contains the main request payload.

payload Object Parameters

                      action
                      *
                      

String

Mandatory

Action type. Always sdkWalletEligibility.

                      customerId
                      *
                      

String

Mandatory

Unique customer ID generated by Juspay.

                      clientAuthToken
                      *
                      

String

Mandatory

Authentication token from the merchant backend.

                      countryCode
                      *
                      

String

Mandatory

Transaction currency

Example:- AE

                      currency
                      
                      

String

Optional

Transaction currency

Example:- AED

                      amount
                      *
                      

String

Mandatory

Transaction amount.

                      paymentMethods
                      *
                      

String

Mandatory

List of payment methods to check eligibility.

paymentMethods Array Parameters

                      paymentMethod
                      *
                      

String

Mandatory

Use APPLEPAY for normal payments.

                      paymentMethodType
                      *
                      

String

Mandatory

Always WALLET

Have questions?
Need help? Contact support
LLM? Read llms.txt