---
page_title: payment-filter-generator
product: Payment Locking
page_source: https://juspay.io/in/docs/payment-locking/docs/payment-locking/paymentfiltergenerator
llms_txt: https://juspay.io/in/docs/llms.txt
product_llms_txt: https://juspay.io/in/docs/payment-locking/llms.txt
---


## Payment Filter Payload Generator 



This guide provides instructions on generating a payment locking payload based on your preferences to include or exclude specific payment methods.

**To create a payment locking payload:** 

Click on either "Include Payment Options" or "Exclude Payment Options." This action will open a screen where you can create a sample payload by filtering or restricting specific payment methods that you wish to include or exclude for a user during transactions on the payment page.

After selecting the desired payment methods for inclusion or exclusion, click the "Copy Payload" button. This action will copy the payment locking payload to your clipboard for further use.

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


### 🔘 Button: [Include Payment Options](https://studio.juspay.in/configurator/payload_generator.html?payloadGeneratorMode=paymentlock_include)



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


### 🔘 Button: [Exclude Payment Options](https://studio.juspay.in/configurator/payload_generator.html?payloadGeneratorMode=paymentlock_exclude)




### Payload Details




### Step 1.1a PaymentFilter Payload


Refer below parameters for Payment Locking.


### Payload
- **AllowDefaultOptions**:
  - Description: 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. ORYou passed paylaod to enable cards payment option and set 'allowDefaultOptions' as false, then it will only display cards option on the Hypercheckout screen.
  - Value: <p><b>Possible Values:</b> true or false</p>
  - Tags: Boolean, Mandatory
- **Options**:
  - Description: Options defines the method on which payment locking has to be applied.
  - Value:
    - **Enable**:
      - Description: 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.
      - Value: <b>Possible Values:</b> true, false
      - Tags: Boolean, Mandatory
    - **PaymentMethodType**:
      - Description: This decides on which payment method type the payment locking should be applied on.
      - Value: <p><b> Possible Values:</b> CARD, UPI, WALLET, NB, CONSUMER_FINANCE, REWARD, CASH</p>
      - Tags: String, Mandatory
    - **PaymentMethods**:
      - Description: This contains the payment methods on which payment locking have to be applied It won't be considered if paymentMethodType is UPI / CARD.
      - Value: <p><b>Possible Values:</b> [PHONEPE, PAYTM],...<br>
<br>
In case of <b>mandate flows</b> (NB, WALLET, CONSUMER_FINANCE) pass additional values with prefix JP_<br>
<br>
<b>For example,</b> <br>
In NB pass both ["NB_HDFC", "JP_HDFC"] <br>
In WALLET pass both["PAYTM", "JP_PAYTM"] <br>
In CONSUMER_FINANCE pass both ["ZESTMONEY", "JP_ZESTMONEY"] <br></p>
      - Tags: Array, Optional
    - **CardFilters**:
      - Description: It won't be considered unless paymentMethodType is CARD.
      - Value:
        - **CardBrand**:
          - Description: This contains the card brand on which payment locking has to be applied.
          - Value: <b>Possible values:</b> VISA, RUPAY,...
          - Tags: Array, Optional
        - **CardBin**:
          - Description: This contains the card BINS on which payment locking has to be applied.
          - Value: <p><b>Possible values:</b> ["459000::460000"]</p>
          - Tags: Array, Optional
        - **CardType**:
          - Description: This contains the card type on which payment locking has to be applied.
          - Value: <p><b>Possible values:</b> DEBIT, CREDIT</p>
          - Tags: Array, Optional
        - **CardSubType**:
          - Description: This contains the card sub type on which payment locking has to be applied.
          - Value: <p><b>Possible values:</b> BUSINESS, EMPLOYEE_CARD,...</p>
          - Tags: Array, Optional
        - **CardBanks**:
          - Description: This contains the Bank names on which payment locking has to be applied.
          - Value: <p><b>Possible values:</b> SBI, ICICI,....</p>
          - Tags: Array, Optional
        - **Enable**:
          - Description: 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.
          - Value: <p><b>Possible values:</b>true, false</p>
          - Tags: Boolean, Mandatory
      - Tags: Array, Optional
    - **UpiFilters**:
      - Description: It won't be considered unless paymentMethodType is UPI.
      - Value:
        - **UpiType**:
          - Description: This contains the UPI type on which payment locking has to be applied.
          - Value: <p> <b>Possible values:</b>COLLECT, INTENT </p>
          - Tags: String, Optional
        - **UpiMethods**:
          - Description: This contains the UPI method on which payment locking has to be applied.
          - Value: <p> <b>Possible values:</b> If upiType is 'COLLECT' then '@ybl', '@okicici'... <br> If upiType is 'INTENT' then 'phonepe', 'googlepay'... </p>
          - Tags: Array, Optional
        - **Enable**:
          - Description: 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.
          - Value: <p><b>Possible values:</b> true or false</p>
          - Tags: Boolean, Mandatory
      - Tags: Array, Optional
  - Tags: Array, Mandatory




You can refer this [Doc](https://docs.juspay.in/payment-locking/docs/payment-locking/paymentlockingbankcodes) to get the possible values that needs to passed in the payment locking parameters.

## Sample Code Snippets:
### Payment Locking Sample Payloads:

#### UPI: Hide Specific UPI Apps or UPI Collect handles Code Snippet:

```upi: hide specific upi apps or upi collect handles
"payment_filter": {
       "allowDefaultOptions": true,
       "options": [{
               "paymentMethodType": "UPI",
               "enable": true,
               "upiFilters": [{
                       "upiType": "COLLECT",
               "enable": false,     
                       "upiMethods": ["@ybl", "@okhdfcbank"]
                   },
                   {
                       "upiType": "INTENT",
                       "enable": false,
                       "upiMethods": ["PHONEPE", "GPAY", "PAYTM"]
                   }]
               }
           ]
       }

```

#### Card: Hide Card Section  Code Snippet:

```card: hide card section 
"payment_filter": {
       "allowDefaultOptions" : true,
       "options": [
         {
           "paymentMethodType": "CARD",
           "enable" : false
         }
       ]
     }

```

#### Card: Hide Credit Card Section Code Snippet:

```card: hide credit card section
"payment_filter": 
{
       "allowDefaultOptions" : true,
       "options": [
         {
           "paymentMethodType": "CARD",
           "enable" : true,
     "cardFilters": [
             {
               "enable": false,
               "cardTypes": ["CREDIT"]
             }
           ]
         }
       ]
     }

```

#### Card: Hide particular card bins Code Snippet:

```card: hide particular card bins
"payment_filter": {
       "allowDefaultOptions" : true,
       "options": [
         {
           "paymentMethodType": "CARD",
           "enable": true,
           "cardFilters": [
             {
               "enable": false,
                 "cardBins":["459000::460000"]
             }
           ]
         }
       ]
     }

```

#### Wallet: Hide Specific Wallets Code Snippet:

```wallet: hide specific wallets
"payment_filter": {
       "allowDefaultOptions": true,
       "options": [
           {
               "paymentMethodType": "WALLET",
               "paymentMethods": ["LAZYPAY,SIMPL"],
               "enable": false
           }
       ]
   }

```

#### Netbanking: Hide Net Banking Section Code Snippet:

```netbanking: hide net banking section
"payment_filter": {
       "allowDefaultOptions" : true,
       "options": [
         {
           "paymentMethodType": "NB",
           "enable" : false
         }
       ]
     }

```

#### COD: Hide COD section Code Snippet:

```cod: hide cod section
"payment_filter": {
       "allowDefaultOptions": true,
       "options": [
           {
               "paymentMethodType": "CASH",
               "enable": false
           }
       ]
   }

```

#### EMI: Show only EMI Code Snippet:

```emi: show only emi
{
"payment_filter": {
    "allowDefaultOptions": true,
    "options": [],
    "emiOptions": {
    "showOnlyEmi" : true 
   }
}
}
```

#### EMI: Show only no cost EMI Code Snippet:

```emi: show only no cost emi
"payment_filter": {
    "allowDefaultOptions": true,
    "options": [],
    "emiOptions": {
        "standardEmi" : {
          "enable" : false
        },
        "lowCostEmi" : {
          "enable" : false
        },
        "noCostEmi" : {
          "enable" : true
        },
    "showOnlyEmi" : true
   }
}

```

#### EMI: Show standard EMI and low cost EMI (likewise any combination of standard, low cost and not cost can be achieved) Code Snippet:

```emi: show standard emi and low cost emi (likewise any combination of standard, low cost and not cost can be achieved)
{
"payment_filter": {
    "allowDefaultOptions": true,
    "options": [],
    "emiOptions": {
    "standardEmi" : {
      "enable" : true
    },
    "lowCostEmi" : {
      "enable" : true
    },
    "noCostEmi" : {
      "enable" : false
    }
  }
 
 }
}
```

#### EMI: Hide EMI Code Snippet:

```emi: hide emi
{
"payment_filter": {
    "allowDefaultOptions": true,
    "options": [],
    "emiOptions": {
    "standardEmi" : {
      "enable" : false
    },
    "lowCostEmi" : {
      "enable" : false
    },
    "noCostEmi" : {
      "enable" : false
    }
  }
 }
}
```

#### EMI: Hide only credit card based EMI within No cost EMI (likewise any combination of credit, debit and cardless can be achieved) Code Snippet:

```emi: hide only credit card based emi within no cost emi (likewise any combination of credit, debit and cardless can be achieved)
{
"payment_filter": {
    "allowDefaultOptions": true,
    "options": [],
    "emiOptions": {
    "standardEmi" : {
      "enable" : true
    },
    "lowCostEmi" : {
      "enable" : true
    },
    "noCostEmi" : {
       "enable" : true,
       "credit": {
       "enable" : false
      }
    }
  }
 }
}
```

#### EMI: Remove tenures between 5-6 and 12-20 only for ICICI Issuer for both noCost and standardEmi Code Snippet:

```emi: remove tenures between 5-6 and 12-20 only for icici issuer for both nocost and standardemi
{
    "allowDefaultOptions": true,
    "emiOptions": {
      "noCostEmi": {
        "credit": {
          "enable": true,
          "filters": [
            {
              "issuerFilter": {
                "issuers": [
                  "JP_ICICI"
                ],
                "tenures": [
                  "5::6",
                  "12::20"
                ],
                "enable": false
              },
              "paymentMethodType": "CARD",
              "paymentMethod": "CARD",
              "enable": true
            }
          ]
        },
        "enable": true
      },
      "standardEmi": {
        "credit": {
          "enable": true,
          "filters": [
            {
              "issuerFilter": {
                "issuers": [
                  "JP_ICICI"
                ],
                "tenures": [
                  "5::6",
                  "12::20"
                ],
                "enable": false
              },
              "paymentMethodType": "CARD",
              "paymentMethod": "CARD",
              "enable": true
            }
          ]
        },
        "enable": true
      }
    }
  }
  
```

#### UPI: Hide Specific UPI Code Snippet:

```upi: hide specific upi
"payment_filter": {
       "allowDefaultOptions": true,
       "options": [{
               "paymentMethodType": "UPI",
               "enable": true,
               "upiFilters": [{
                       "upiType": "COLLECT",
               "enable": false,     
                       "upiMethods": ["@ybl", "@okhdfcbank"]
                   },
                   {
                       "upiType": "INTENT",
                       "enable": false,
                       "upiMethods": ["PHONEPE", "GPAY", "PAYTM"]
                   }]
               }
           ]
       }

```

#### Show only 3 month tenure for BOB Issuer for only Credit Card Standard EMI Code Snippet:

```show only 3 month tenure for bob issuer for only credit card standard emi
"payment_filter":{
    "allowDefaultOptions": false,
    "options": [
        {
            "enable": true,
            "paymentMethodType": "CARD"
        }
    ],
    "emiOptions": {
    "standardEmi" : {
      "enable" : true,
      "credit":{
        "enable": true,
        "filters":[
            {
                "paymentMethodType": "CARD",
                "paymentMethod": "CARD",
                "enable": true,
                "issuerFilter": {
                    "issuers": ["JP_BOB"],
                    "tenures": ["3::3"],
                    "enable": true
                }
            }
        ]
      },
      "debit": {
        "enable": false
      },
      "cardless":{
        "enable": false
      }
    },
    "lowCostEmi" : {
      "enable" : false
    },
    "noCostEmi" : {
      "enable" : false
    },
    "showOnlyEmi": true
  }
 }

```



---

## See Also

- [Enable Payment Locking](https://juspay.io/in/docs/payment-locking/docs/payment-locking/enable-payment-locking)
- [Construct Payment Filter Payload](https://juspay.io/in/docs/payment-locking/docs/payment-locking/construct-payment-filter-payload)