Offer Discovery Integration

Overview

Merchants can power the offer discovery on their website through the Offer Discovery API with offers created with Paytm:

Retrieve Amount or Item/SKU-based offers for the desired payment instruments
Retrieve all plans applicable to the product or amount including subvention and standard EMI plans
It can be used to display the offers applicable on the Product Description Page, cart, and checkout page of the merchant
Retrieve all offers on EMI applicable on:
a. Specific amount

b. Specific item

c. Specific Bank

d. Specific tenure
Retrieve all offers on CC/DC using:
a. Specific amount

b. Specific item

c. Specific Bank/Network
Currently supports - Credit Card, Debit Card, EMI, UPI, Net Banking, and Paytm Wallet
Can retrieve detailed calculations (e.g. discount/cashback applicable, interest rate and amount, monthly EMI, effective price, etc.) on the order amount after applying the Bank offer and No cost EMI and show on the Product Description Page in the desired format

Advantages of Offer Discovery

E-Commerce merchants can create a nudge on the Product Description Pages by displaying all the offers and the possible least effective price
Can reflect a newly created offer within less than 30 mins without having to redeploy
Offer maintainence at Paytm’s end, reducing the merchant’s effort to show the offers on different parts of their website

Integration Steps

For retrieving the item-based offers, the merchant has to pass:

Item details - Brand_id, category_id and product_id, price
i.) Id - Item identifier which is generated by the merchant for every item sent in the items list in the request for which the offers have to be retrieved.
ii.) Brand_id - The brand identifier which is configured in the offers. Refer to the default brandIds configured in Paytm. Currently numeric values are supported for Brand_Id. Eg: 123
iii.) Category_id - The category identifier which is configured in the offers. Refer to the default categoryIds configured in Paytm. Currently, numeric values are supported for category_Id. Eg: 1234
iv.) Product_id - The product identifier which is configured in the offers. Eg: iPhone14
v.) Price - Price of the product
orderAmount (sum of the prices of all items in the cart)
Payment Instruments on which the offers have to be retrieved - CREDIT_CARD, CC-EMI, DEBIT_CARD, DC-EMI, UPI, Paytm wallet, NET_BANKING in the paymentOptions
For retrieving offers on specific card issuers/schemes for Credit Cards, Debit Cards, and EMI, corresponding values can be populated in issuingBank, issuingNetworkCode

In the response, the merchant would receive all the bank offers applicable to the Payment Instruments sent in the request. For EMI and EMI_DC payment instruments, the subvention offers configured on the product would also be retrieved.

"body": {
    "items": [
        {
            "id": "item12", //Merchant generated ID
            "productId": "P12", //Product Identifier
            "brandId": "9876598765", //Brand Identifier
            "categoryId": "C1", // Category Identifier
            "price": 10000.00 // Price
        }
    ],
    "mid": "YOUR MID",
    "paymentDetails": {
        "orderAmount": 10000.00, // Cart Amount
        "paymentOptions": [
            {
                "payMethod": "CREDIT_CARD"
            },
            {
                "payMethod": "DEBIT_CARD"
            },
            {
                "payMethod": "EMI"
            }
        ]
    }
}

Note: For the creation of Item based Bank offers and SKU-based offers, provide SKU-related parameters - brand_id, category_id, and product_id for the offer configuration