Integrate Offers with Standard Checkout

Exception

You need not integrate offers with Orders API if you use any of the following Razorpay products or plugins to accept payments:

• Plugins: Magento, Shopify or WooCommerce.
• Products: Payment Links, Payment Buttons, Payment Pages and Invoices.

This is because Razorpay automatically creates orders for these products or plugins when customers initiate payment at the Checkout.

Validation Criteria

Only those offers that pass the following validations are be displayed at the Checkout:

Display Offers at Checkout

There are three ways in which you can display offers at Razorpay Checkout:

• Display Offers by Default

• Display Limited Offers

• Force Offer

Method 1: Display Offers by Default

This is the easiest way to display offers at the Checkout. While creating the offer from the Dashboard, enable the Show Offer on Checkout option. The offer automatically appears at the Checkout.

Method 2: Display Limited Offers

To display a specific set of offers at the Checkout, you should associate the offers with an order. You can pass the offers array as a request attribute in the Create Orders API.

Some use cases:

• If you have multiple product lines running on the same account and certain business logic on your side for displaying offers.
• The discount has already been applied, and you would like to restrict the payment method to avail the offer.

Method 3: Force Offer

Use this method when a customer has already selected an offer on your website or app before the payment process begins. By forcing an offer, you lock the checkout to that specific offer, ensuring the customer can only pay using the forced offer. If the customer does not accept the forced offer, the payment will not be processed.

Integrate Offers with Orders API

To integrate offers, follow these steps:

1. Create an Offer

   .

2. Pass the Offer in Orders API

   .

3. Pass order_id and Trigger Checkout

   .

Step 1: Create an Offer from the Dashboard

You can

Let us say you have created an offer offer_ANZoaxsOww2X53, such that a discount of ₹200 is applicable on all transactions done through AXIS netbanking only.

Step 2: Pass the Offer in Orders API

Create an order using the

curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
-X POST https://api.razorpay.com/v1/orders \
-H "content-type: application/json" \
-d '{
  "amount": 5000,
  "currency": "",
  "receipt": "receipt#1",
  "notes": {
    "key1": "value3",
    "key2": "value2"
  }
}'

Step 3: Pass Order_id and Trigger the Checkout

The order_id obtained in the previous step can be passed to the Checkout form as follows:

<button id="rzp-button1">Pay</button>
<script src="https://checkout.razorpay.com/v1/checkout.js"></script>
<script>
var options = {
    "key": "[YOUR_KEY_ID]",
    "amount": "1000000",
    "currency": "",
    "order_id":"order_FIL1vBOsWFllnO",
    "name": "Acme Corp",
    "description": "Test Transaction",
    "image": "https://cdn.razorpay.com/logos/F9Yhfb7ZXjXmIQ_medium.jpg",
    "handler": function (response){
        alert(response.razorpay_payment_id);
        alert(response.razorpay_order_id);
        alert(response.razorpay_signature)
    },
    "prefill": {
        "name": "Gaurav Kumar",
        "email": "gaurav.kumar@example.com",
        "contact": "+919876543210"
    },
    "notes": {
        "address": "Razorpay Corporate Office"
    },
    "theme": {
        "color": "#3399cc"
    }
};
var rzp1 = new Razorpay(options);
document.getElementById('rzp-button1').onclick = function(e){
    rzp1.open();
    e.preventDefault();
}
</script>

Know more about

Next Steps

After the customer has availed the offers and made the payment at the Checkout, you can track the status of the payments:

• From the Dashboard.
• By

  configuring webhooks

  .
• By polling our

  payment APIs

  .

Related Information

• About Offers

• Create Offers

• Tutorial - How to Create Offers

• Disable Offers

• Offers FAQs