Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Sample Payloads

Basic Payload Structure:

This specific example will disable Mastercards from being displayed, while displaying all other available payment instruments. The side comments will explain how the "offer_details" object parameters can be modified for other filtering cases, as listed below.

"order_details":
 {
  "order_id": "R8205947560",
  "first_name": "John",
  "last_name": "Wick",
  "mobile_number": "9592329220",
  "email_address": "[email protected]",
  "customer_id": "9592329220",
  "timestamp": "1611559686153",
  "merchant_id": "abcd",
  "amount": "1.00",
  "currency": "INR",
  "offer_details":
     {
       "merge_with_default_payment_methods": "true", //"true" or "false"-- "true" displays all available instruments unless hid.
                                                     //"false" will display only instruments mentioned in **merchant_offer_payment_methods**.
       "offer_applied": "false",                     //set to "false" for examples here (enables payment locking).
       "merchant_offer_payment_methods": [           //Array of instances on how filtering is to be applied 
          {
            "filter_type": "blacklist",              //"blacklist or" "whitelist"
            "offer_payment_method_type": "cards",    //Examples here include: cards, wallets, emi, nb, and upiAppsWithOther.
            "offer_payment_card_type": "CREDIT",     //Applicable only for cards ("DEBIT" or "CREDIT")
            "offer_payment_methods": [               //Specific instruments from "offer_payment_method_type" selection to be filtered 
                “MASTERCARD”
            ]
          }
       ] 
     }
 }

The following code samples show how the "offer_details" object parameters vary with different scenarios:

UPI

Hide UPI Section

"offer_details": 
   {
     "merge_with_default_payment_methods": "true",  
     "offer_applied": "false",     
     "merchant_offer_payment_methods": [
        {
          "filter_type": "blacklist",
          "offer_payment_method_type": "upiAppsWithOther"
        }
     ] 
   }

Hide Specific UPI Apps

"offer_details": 
   {
     "merge_with_default_payment_methods": "true",
     "offer_applied": "false",
     "merchant_offer_payment_methods": [
        {
          "filter_type": "blacklist",
          "offer_payment_methods": ["GPAY"],               //specify apps here as per use-case
          "offer_payment_method_type": "upiAppsWithOther"
        }
     ]
   }

Wallets

Hide Wallet Section

"offer_details":
   {
     "merge_with_default_payment_methods": "true",
     "offer_applied": "false",
     "merchant_offer_payment_methods": [
        {
          "filter_type": "blacklist",
          "offer_payment_method_type": "wallets"
        }
     ]
   }

Hide Specific Wallets

"offer_details":
   {
     "merge_with_default_payment_methods": "true",
     "offer_applied": "false",
     "merchant_offer_payment_methods": [
        {
          "filter_type": "blacklist",
          "offer_payment_methods": ["paytm"],        //specify wallets here as per use-case
          "offer_payment_method_type": "wallets"
        }
     ]
   }

Display Only Wallet Section

"offer_details":
   {
     "merge_with_default_payment_methods": "false",
     "offer_applied": "false",
     "merchant_offer_payment_methods": [
        {
          "filter_type": "whitelist",
          "offer_payment_method_type": "wallets"
        }
     ]
   }

Cards

Disable Credit Cards

"offer_details":
   {
     "merge_with_default_payment_methods": "true",
     "offer_applied": "false",
     "merchant_offer_payment_methods": [
        {
          "filter_type": "blacklist",
          "offer_payment_method_type": "cards",
          "offer_payment_card_type": "CREDIT"
        }
     ]
   }

Hide Card Section

"offer_details": 
   {
     "merge_with_default_payment_methods": "true",
     "offer_applied": "false",
     "merchant_offer_payment_methods": [
        {
          "filter_type": "blacklist",
          "offer_payment_method_type": "cards"
        }
     ]
   }

Display Only Card Section

"offer_details":
   {
     "merge_with_default_payment_methods": "false",
     "offer_applied": "false",
     "merchant_offer_payment_methods": [
        {
          "filter_type": "whitelist",
          "offer_payment_method_type": "cards"
        }
     ]
   }

Netbanking

Hide Netbanking Section

"offer_details":
   {
     "merge_with_default_payment_methods": "true",
     "offer_applied": "false",
     "merchant_offer_payment_methods": [
        {
          "filter_type": "blacklist",
          "offer_payment_method_type": "nb"
        }
     ]
   }

Display only Netbanking Section

"offer_details":
   {
     "merge_with_default_payment_methods": "false",
     "offer_applied": "false",
     "merchant_offer_payment_methods": [
        {
          "filter_type": "whitelist",
          "offer_payment_method_type": "nb"
        }
     ]
   }

EMI

Hide EMI Section

"offer_details":
   {
     "merge_with_default_payment_methods": "true",
     "offer_applied": "false",
     "offer_payment_methods": [
        {
          "filter_type": "blacklist",
          "offer_payment_method_type": "emi"
        }
     ]
   }

Did this page help you?