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 Express Checkout 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:

Step 1

Construct the Payment Locking Payload

Step 2(a)

Pass the Payment Locking Payload (Web Integration)

Step 2(b)

Pass the Payment Locking Payload (Android/iOS Integration)

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 payload to enable cards payment option and set 'allowDefaultOptions' as false, then it will only display cards option on the Express Checkout 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.

                      cardBrands
                      
                      

Array

Optional

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

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

                      cardBins
                      
                      

Array

Optional

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

Example:-

Possible values: ["459000::460000"]

                      cardTypes
                      
                      

Array

Optional

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

Example:-

Possible values: DEBIT, CREDIT

                      cardSubTypes
                      
                      

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

EMI Filter:

You can show/ hide/ only display EMI without cards by passing below values in 'sdk_udf' parameter while creating an order.

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 Express Checkout screen	Value: showEMI
No EMI	Type: String Use Case: Need to hide EMI on the Express Checkout screen.	Value: hideEMI
EMI without Cards	Type: String Use Case: Need to show EMI on the Express Checkout screen, but not CARD.	Value: ShowEMIWithoutCards

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