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

Payment Locking

Payment locking allows you to block/ allow specific payment instrument groups/ payment instruments on the Hypercheckout screen. For example, if you want to display or hide a specific payment option for a particular product/ service, you can use payment locking to handle such scenarios.

Follow the below steps to implement payment locking:

Pass the payment locking payload in the payment_filter parameter while calling the session API, where all the fields are CASE SENSITIVE.
Session API will respond with a JSON object containing process payload and payment filter parameters inside sdk_payload key.
Call the Process API by passing the JSON object you received in sdk_payload of session API.

Payment Locking Payload Generator:

A guide on how to create a payment locking payload based on your selection to include or exclude specific payment methods.

Create a payment locking payload :
Clicking on either “Include Payment Options” or “Exclude Payment Options” will open up a screen where you can create a sample payload by filtering/restricting the specific payment methods that you want to include or exclude for a user while transacting through the payment page.

Once you have selected the specific payment methods that you want to include or exclude, you can click the “Copy Payload” button. This will copy the payment locking payload to your clipboard.

Include payment options : Select this option if you want to include specific payment options.
Exclude payment options : Select this option if you want to exclude specific payment options.

Payload Details

Step 1.1a

PaymentFilter Payload

Refer below parameters for Payment Locking.

                      allowDefaultOptions
                      *
                      

Boolean

Mandatory

It defines whether you want to display all default payment options along with the payment options on which payment filters were applied.

For Example: You passed payload to disable cards payment option and set 'allowDefaultOptions' as true, then it will display all other payment options other than cards.
OR
You passed paylaod to enable cards payment option and set 'allowDefaultOptions' as false, then it will only display cards option on the Hypercheckout screen.

Example:-

Possible Values: true or false

                      options
                      *
                      

Array

Mandatory

Options defines the method on which payment locking has to be applied.

                      enable
                      *
                      

Boolean

Mandatory

This is to decide whether to disable or enable the payment method, false will disable the payment method and true will enable the payment method.
For CARD/UPI as paymentMethodType it should be true if upiFilters or cardFilters are passed.

Example:- Possible Values: true, false

                      paymentMethodType
                      *
                      

String

Mandatory

This decides on which payment method type the payment locking should be applied on.

Example:-

Possible Values: CARD, UPI, WALLET, NB, CONSUMER_FINANCE, REWARD, CASH

                      paymentMethods
                      
                      

Array

Optional

This contains the payment methods on which payment locking have to be applied
It won't be considered if paymentMethodType is UPI / CARD.

Example:-

Possible Values: [PHONEPE, PAYTM],...

In case of mandate flows (NB, WALLET, CONSUMER_FINANCE) pass additional values with prefix JP_

For example,
In NB pass both ["NB_HDFC", "JP_HDFC"]
In WALLET pass both["PAYTM", "JP_PAYTM"]
In CONSUMER_FINANCE pass both ["ZESTMONEY", "JP_ZESTMONEY"]

                      cardFilters
                      
                      

Array

Optional

It won't be considered unless paymentMethodType is CARD.

                      cardBrand
                      
                      

Array

Optional

This contains the card brand on which payment locking has to be applied.

Example:- Possible values: VISA, RUPAY,...

                      cardBin
                      
                      

Array

Optional

This contains the card BINS on which payment locking has to be applied.

Example:-

Possible values: ["459000::460000"]

                      cardType
                      
                      

Array

Optional

This contains the card type on which payment locking has to be applied.

Example:-

Possible values: DEBIT, CREDIT

                      cardSubType
                      
                      

Array

Optional

This contains the card sub type on which payment locking has to be applied.

Example:-

Possible values: BUSINESS, EMPLOYEE_CARD,...

                      cardBanks
                      
                      

Array

Optional

This contains the Bank names on which payment locking has to be applied.

Example:-

Possible values: SBI, ICICI,....

                      enable
                      *
                      

Boolean

Mandatory

This is to decide whether to disable or enable the payment instrument. False will disable the payment method and true will enable the payment method.

Example:-

Possible values:true, false

                      upiFilters
                      
                      

Array

Optional

It won't be considered unless paymentMethodType is UPI.

                      upiType
                      
                      

String

Optional

This contains the UPI type on which payment locking has to be applied.

Example:-

Possible values:COLLECT, INTENT

                      upiMethods
                      
                      

Array

Optional

This contains the UPI method on which payment locking has to be applied.

Example:-

Possible values: If upiType is 'COLLECT' then '@ybl', '@okicici'...
If upiType is 'INTENT' then 'phonepe', 'googlepay'...

                      enable
                      *
                      

Boolean

Mandatory

This is to decide whether to disable or enable the payment method on which upiFilters are applied, false will disable the payment method and true will enable the payment method.

Example:-

Possible values: true or false

You can refer this Doc to get the possible values that needs to passed in the payment locking parameters.

EMI Filter:

You can show/ hide/ only display EMI without cards by passing below values in 'sdk_udf' parameter while calling the session API.

Please intimate your Juspay POC if you plan on using sdk_udf. They will enable a config required to use this feature.

Scroll inside to view more

Use case	Description and Type	sdk_udf : Possible Values
Show EMI	Type: String Use Case: Need to show EMI on the Hypercheckout screen	Value: showEMI
No EMI	Type: String Use Case: Need to hide EMI on the Hypercheckout screen.	Value: hideEMI
EMI without Cards	Type: String Use Case: Need to show EMI on the Hypercheckout screen, but not CARD.	Value: ShowEMIWithoutCards

Structure for EMI Filter

Feature Details

Allows merchants to hide/show different types of EMI plans(standard, low cost, no cost) under both card EMIs (debit & credit) and cardless EMIs
Any particular issuer can be hidden within any of these categories (Ex. HDFC Debit card EMI plans can be specifically blocked)
Solution also supports showing only EMI Options on the Payment Page
Reach out to your Juspay POC to enable EMI filter via payment locking for your account

EmiFilter filters EMI plans on a basic level (Ex. Display only no-cost EMI)
EmiSubFilter filters specific plans (Ex. HDFC debit card EMI plans to be specifically blocked)

Structure

The Schema of EmiFilter payload :

Structure

The Schema of EmiSubFilter payload :

Payload : emiOptions

Scroll inside to view more

Property	Type & Description	Possible Values
standardEmi	Type: Maybe EmiSubFilter; Use Case: Controls everything with regards to standard EMI plans
lowCostEmi	Type: Maybe EmiSubFilter; Use Case: Controls everything with regards to low cost EMI plans
noCostEmi	Type: Maybe EmiSubFilter; Use Case: Controls everything with regards to no cost EMI plans
showOnlyEmi	Type: Maybe Boolean; Use Case: EMI will be the only visible instrument on payment page	Possible values: true, false

Payload : standardEmi/lowCostEmi/noCostEmi/showOnlyEmi

Scroll inside to view more

Property	Type & Description	Possible Values
enable	Type: Boolean; (*Required) Use Case: This is to decide whether to disable or enable standardEMI, lowCostEMI or noCostEMI	Possible values: true, false
credit	Type: Maybe Use Case: Controls everything with regards to credit card plans within the given EMI type (standard/ low cost/ no cost)
debit	Type: Maybe Use Case: Controls everything with regards to debit card plans within the given EMI type (standard/ low cost/ no cost)
cardless	Type: Maybe Use Case: Controls everything with regards to cardless card plans within the given EMI type (standard/ low cost/ no cost)

Payload : credit/ debit/ cardless

Scroll inside to view more

Property	Type & Description	Possible Values
enable	Type: Boolean; (*Required) Use Case: This is to decide whether to disable or enable credit, debit or cardless EMI	Possible values: true, false
filters :: enable	Type: Boolean; (*Required) Use Case: This is to decide whether to disable or enable plans	Possible values: true, false
filters :: paymentMethodType	Type: String; Use Case: EMI plans of this particular payment method type will be locked	Possible values: “CARD”, “UPI“, “WALLET“, “NB, “CONSUMER_FINANCE“, “REWARD“, “CASH“ All the values are case sensitive
filters :: paymentMethod	Type: Array String; Use Case: EMI plans of this particular payment method will be locked	Possible values: [“PHONEPE”, ”PAYTM”],... All the values are case sensitive
filters :: issuerFilters	Type: {issuers :: Array String, enable :: Boolean} Use Case: This is to decide whether to disable or enable EMI Issuers based on above filters	Possible values: JP Bank code of the issuer. For example, JP_HDFC
filters :: issuerFilters	Type: {tenures :: Array String, enable :: Boolean} Use Case: This is to decide whether to disable or enable EMI Tenures based on above filters	Possible values: "5::6","12::20"