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:

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

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, WALLET, RTP etc.

                      paymentMethods
                      
                      

Array

Optional

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

Example:-

Possible Values: FPS_QR etc.

                      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

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

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