Section |
Parameter |
Mandatory / Optional
|
Description
|
Campaign Details |
Campaign Name
|
Mandatory |
Enter the name of the bank offer campaign you want to create and it must include the alpha-numeric characters only with no special characters.
This will be your Promo Code. Campaign name be maximum of 20 characters.
Note: You can have only one active campaign with a particular name.
|
|
Date & Time |
Mandatory |
Select the start and end date & time for your campaign.
Note: You cannot edit these fields once the campaign is created.
|
|
Schedule Your Offer |
Optional |
This feature can be used to schedule campaigns only on certain days of the week or dates of the month in the duration between the start and end dates of the campaign.
Note: Campaign would run only on chosen days/dates if the option is switched ON.
|
|
Offer Title |
Mandatory |
Enter the title of the offer which you will show to your audience to draw their attention.
Example: Get 20% discount upto Rs. 50 using HDFC credit card
|
|
Offer Description |
|
Enter the brief description of the offer which you want to create.
Example: Use code FRIDAY50 & get 20% discount up to Rs. 50 on order of Rs. 300 and above.
|
|
Terms & Conditions |
|
Enter the terms and conditions which a customer must satisfy to avail this offer.
Example:
Maximum discount allowed is Rs. 50
Offer valid on a minimum order value of Rs. 300
Offer valid once per user per month
Offer valid on payments made through ICICI Credit card only
Offer valid till 31st March 2023 only
|
|
Show Offer On
|
|
You can select different platforms to run your campaign. It presents you with All Channels, Website, or App options. You can either select one of them or all of them and pass them to Paytm via Apply Promo API to let Paytm know where you want to apply the promo/offer.
Note: This parameter is passed as channel ID in Fetch All Offers API and Apply Promo API. Mobile websites are covered under the App option.
|
|
Offer Error Message |
|
Add an error message to be displayed to the user in case the user is unable to avail the promo on the chosen platform. |
|
Promo Code Visibility |
|
You can manage your promo code visibility through Paytm on your platform and handle the UI for a particular campaign at your end. To make the Promo Code option visible on your payment screen, you need to switch it ON using the toggle button.
|
Offer Configuration |
Payment Instrument
|
Mandatory |
Select one or more payment instruments like Net Banking, CC, EMI etc as per your agreement with the bank which would allow you to extend discount to your end users.
|
|
Banks |
Mandatory |
Select one or more banks from the list of banks. Please verify the agreement with the bank based on the payment instrument selected.
|
|
Payment Network |
|
Select one or more networks on which you want to make the offer valid. If left blank, all the listed networks would be considered for the offer. |
|
Error Messages |
|
Enter the error messages pertaining to each bank/payment instrument/payment network error. You can fetch them in response to the Apply Offers API. If no message is added, the default error message would be displayed. |
|
Upload BIN Details |
Optional |
This section describes how to manage the bank offer campaigns on particular BINs. You can upload a list of 6 or 8 digit BIN. Use the sample format available while uploading the file.
- If you want to run a bank offer/campaign on particular BINs, then select Include BIN and upload the set of BINs in the given format.
- If you do not want to run a bank offer/campaign on particular BINs, then select Exclude BIN and upload the set of BINs in the given format.
|
Offer Details |
Offer Type |
Mandatory |
This section enables you to choose either discount or cashback as the type of bank offer which you want to offer to your end users.
-
Discount: It means your user gets an instant discount on the final transaction and reduces the price upfront.
Example: If the offer says “Get Rs 100 off on minimum order value of Rs 1000”, then if the order value is Rs 1100, an instant discount of Rs 100 will apply and the user will pay Rs 1000 only. For Paytm, transaction value would be Rs 1000 only and settlement would be done as per Rs 1000 order value only.
-
Cashback: It means you/your bank offers a reward in the form of cashback to the users after the successful completion of the transaction. It gets credited into a user’s account after a certain time, as per the terms and conditions of your offer/campaign on using your services.
Example: If you offer 10% cashback to your user on a minimum order value of Rs.1000, then if the order value is Rs.1000, initially the user will pay Rs.1000 only. The cashback of Rs. 100 will be credited into the user’s account later. Here, for the same offer, order value will be Rs 1000 only i.e. Paytm will treat it as Rs 1000 transaction value and settlement will be done as per Rs 1000 order value.
Note: Currently, Paytm does not support Cashback offer type in the DIY mode. However, you can get it configured through special request by contacting your KAM or Paytm Support.
Flat/Percentage
This section explains how you can extend either the flat amount discount or the percentage discount to your users on a transaction.
- Choose FLAT option, if your campaign is of type ”Get FLAT Rs 50 off on orders above Rs 1000”
- Choose PERCENTAGE option, if your offer is of following type:
- Get 15% off on minimum order value of Rs 1000
- Get 15% off or upto Rs 100 on minimum order value of Rs 1000
Example: If a merchant changes the discount from 10% to 15%. It may take upto 30 minutes for this value to reflect in response to the API. In those 30 minutes, this may happen anytime (say the change happens at 16th minute then users till that time would get a 10% discount and after the change reflects, the users will enjoy 15% discount). Hence, merchants are advised to ensure front-end handling/user communication accordingly in sync with the offer constructs. Merchant must ensure the API response and the offer that is advertised is the same.
|
Add Campaign Rules |
|
|
Paytm offers some non-mandatory rules which you can choose and apply in summation to make them work together smoothly. For a user to get the benefits of the offer/campaign, a user must satisfy all the rules. Ruling out a single rule will disqualify the user from getting the benefits, and will show an error message associated with that rule.
|