Offers [v3]

This API returns a list of offers according to the payment modes

application/json

Request Body required

order_id string required

The order_id for which the payment is being made

payment_mode_code string required
This is the payment mode code chosen by the customer to pay for your order
• card
• upi
• pay_later
• netbanking
• wallet
• all
---
card_input_type string
Possible values: [card_pan, merchant_network_token, nimbbl_token_id]
This field specifies whether the transaction will be performed via plain card, network token or using nimbbl token
• card_pan
• merchant_network_token
• nimbbl_token_id
---
card object
This object will have the details of the plain card
card_no string
This is the card number typically between 15-19 digits, you should only pass this from your server if you are PCI-DSS certified
expiry string
This expiry date of the card, it should be of the current month or future. You should only pass this from your server if you are PCI-DSS certified
card_holder_name string
This is the name of the card holder, you should only pass this from your server if you are PCI-DSS certified
cvv string
This is a 3 or 4 digit number provided at the back of the card, you should only pass this from your server if you are PCI-DSS certified
save_card boolean
This is an optional field and will be used to create a card token for the card details passed in the payload. The saved card will be returned in the Payment modes API.
card_label string
This is an optional field used to provide the name for the saved card token
card_details string
If you don't have PCI-DSS, you can always encrypt the card details on your client and send us the encrypted string in this key.
Steps for encryption
1. Get the Nimbbl Public key for encryption. To get the Nimbbl public key reach out to us at help@nimbbl.biz.
2. Format the Card details in the format : {"card_no":"4111111111111111","cvv":"123","card_holder_name":"test","expiry":"11/22"}
3. Encrypt the above card details using the RSA encryption.
card object
This object will have the details of the network token
network_token string required
The network generated at your end.
cvv string required
This is a 3 or 4 digit number provided at the back of the card
expiry string required
The expiry details of the token
last4 string required
These are the last 4 digits of the tokenized card
cryptogram string required
The cryptogram value for the token. This will be provided by the entity which provided the token.
token_requestor_id string required
The id provided by the networks for generating the token.
token_ref_no string required
The reference number generated while generating the token.
card_network_code string required
The network of the card
card_issuer_code string required
The issuer of the card
card_type string
Possible values: [retail, corporate]
The type of the card
card_geography string
Possible values: [domestic, international]
The geography of the card
card object
This object will have the details of the nimbbl token
nimbbl_token_id string required
This field is used to pass the nimbbl token when the card is tokenized at nimbbl
cvv string required
This is a 3 or 4 digit number provided at the back of the card. If cvv_required is false, then we expect you to pass random cvv.
payment_flow string
Possible values: [intent, qr, collect]
This is the flow of the UPI payment mode
upi_app_code string
This is the code for the UPI app created by Nimbbl, it could be used in subsequent API calls
upi_id string
Possible values: Value must match regular expression [a-zA-Z0-9.\-_]{2,256}@[a-zA-Z]{2,64}
This is the UPI ID of the customer that needs to be validated
pay_later_code string
This is the code of the pay later as provided in the v3/payment-modes API call
bank_code string
This is the bank code shared in response of /v3/list-of-banks API. Please share the code of the bank as chosen by the customer
wallet_code string
This is the wallet code shared in response of /v3/list-of-wallets API. Please share the code of the wallet as chosen by the customer
currency string nullable

to fetch offer(s) for a specific currency, the currency must be a valid ISO3 code

Responses

• 200
• 4XX
• 5XX

---

When the offers is successfully fetched, the response will be as below

application/json

Schema

Example (from schema)

Example with payment mode "card"

Example with payment mode "net_banking"

Example with payment mode "wallet"

Example with payment mode "UPI"

Example with payment mode "UPI" and "payment_flow"

Example with payment mode "pay_later"

---

Schema

net_banking object[]
The payment_mode passed in request to check the offers
Array [
additional_charges number
This is the additional charge that will be charged for this payment mode
offers object[]
This field list the offers for the payment_mode
Array [
id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
name string
This is the offer name as configured
display_text string
This is the offer display text as configured
logo_url string nullable
This is the public url from which logo of the offer can be fetched
coupon_code string nullable
This is coupon code for the offer
terms_and_condition string nullable
This is offer's T&C in markdown format
start_date date-time
This is the offer start date in UTC
end_date date-time
This is the offer end date in UTC
type string
Possible values: [discount, cashback]
This is offer's type.
construct string
Possible values: [fixed_percentage, flat_amount, random]
This is offer's construct.
currency string
This is offer's currency
discount_amount number
This is the amount that will be discounted as per the offer that has been configured. Sent in case of type being discount
cashback_amount number
This is the amount that will be cashback as per the offer that has been configured. Sent in case of type being cashback and construct not being random
random_cashback_min_amount float nullable
This is the minimum amount that can be cashback as per the offer that has been configured. Sent in case of type being cashback and construct being random
random_cashback_max_amount float nullable
This is the maximum amount that can be cashback as per the offer that has been configured. Sent in case of type being cashback and construct being random
pending_validations object nullable
This provides the fields that will be validated after initiating the payment to ascertain that the offer can be applied or not. This is only relevant for offers on upi and dependent on the conditions configured for the offer.
collect string[] nullable
intent string[] nullable
qr string[] nullable
order_line_items object[] nullable
Array [
sku_id string
This is the unique id of the product stored in your system
title string
This is the title of the product that is being sold
description string
This is the detailed description of the product being sold
image_url string
This is the public URL from which the image of the product can be fetched
rate number
This is the pre tax rate of the item, if validations are enabled then the amount must be total_amount ÷ quantity
quantity int
This is the quantity that is being purchased
amount_before_tax string
This is the rate * quantity i.e. the amount before tax
tax string
This is the tax amount on the cart item
total_amount string
This is the sum of amount before tax and the tax amount, if validations are enabled then sum of total_amount of all skus must be equal to order's total amount
serial_numbers string[]
unique identifiers for individual items, if validations are enabled then the number of provided serial number must be equal to quantity
offer_discount float nullable
This is the amount that will be discounted as per the offer that has been configured for that order line item. Sent in case of type being discount
offer_cashback float nullable
This is the amount that will be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct not being random
random_cashback_min_amount float nullable
This is the minimum amount that can be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct being random
random_cashback_max_amount float nullable
This is the maximum amount that can be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct being random
]
]
name string
The name of the bank, it can be used in subsequent API calls
code string
This is the code for the Net Banking created by Nimbbl, it could be used in subsequent API calls
]
wallet object[]
The payment_mode passed in request to check the offers
Array [
additional_charges number
This is the additional charge that will be charged for this payment mode
offers object[]
This field list the offers for the payment_mode
Array [
id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
name string
This is the offer name as configured
display_text string
This is the offer display text as configured
logo_url string nullable
This is the public url from which logo of the offer can be fetched
coupon_code string nullable
This is coupon code for the offer
terms_and_condition string nullable
This is offer's T&C in markdown format
start_date date-time
This is the offer start date in UTC
end_date date-time
This is the offer end date in UTC
type string
Possible values: [discount, cashback]
This is offer's type.
construct string
Possible values: [fixed_percentage, flat_amount, random]
This is offer's construct.
currency string
This is offer's currency
discount_amount number
This is the amount that will be discounted as per the offer that has been configured. Sent in case of type being discount
cashback_amount number
This is the amount that will be cashback as per the offer that has been configured. Sent in case of type being cashback and construct not being random
random_cashback_min_amount float nullable
This is the minimum amount that can be cashback as per the offer that has been configured. Sent in case of type being cashback and construct being random
random_cashback_max_amount float nullable
This is the maximum amount that can be cashback as per the offer that has been configured. Sent in case of type being cashback and construct being random
pending_validations object nullable
This provides the fields that will be validated after initiating the payment to ascertain that the offer can be applied or not. This is only relevant for offers on upi and dependent on the conditions configured for the offer.
collect string[] nullable
intent string[] nullable
qr string[] nullable
order_line_items object[] nullable
Array [
sku_id string
This is the unique id of the product stored in your system
title string
This is the title of the product that is being sold
description string
This is the detailed description of the product being sold
image_url string
This is the public URL from which the image of the product can be fetched
rate number
This is the pre tax rate of the item, if validations are enabled then the amount must be total_amount ÷ quantity
quantity int
This is the quantity that is being purchased
amount_before_tax string
This is the rate * quantity i.e. the amount before tax
tax string
This is the tax amount on the cart item
total_amount string
This is the sum of amount before tax and the tax amount, if validations are enabled then sum of total_amount of all skus must be equal to order's total amount
serial_numbers string[]
unique identifiers for individual items, if validations are enabled then the number of provided serial number must be equal to quantity
offer_discount float nullable
This is the amount that will be discounted as per the offer that has been configured for that order line item. Sent in case of type being discount
offer_cashback float nullable
This is the amount that will be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct not being random
random_cashback_min_amount float nullable
This is the minimum amount that can be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct being random
random_cashback_max_amount float nullable
This is the maximum amount that can be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct being random
]
]
name string
The name of the wallet, it can be used in subsequent API calls
code string
This is the code for the Wallet app created by Nimbbl, it could be used in subsequent API calls
]
pay_later object[]
The payment_mode passed in request to check the offers
Array [
additional_charges number
This is the additional charge that will be charged for this payment mode
offers object[]
This field list the offers for the payment_mode
Array [
id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
name string
This is the offer name as configured
display_text string
This is the offer display text as configured
logo_url string nullable
This is the public url from which logo of the offer can be fetched
coupon_code string nullable
This is coupon code for the offer
terms_and_condition string nullable
This is offer's T&C in markdown format
start_date date-time
This is the offer start date in UTC
end_date date-time
This is the offer end date in UTC
type string
Possible values: [discount, cashback]
This is offer's type.
construct string
Possible values: [fixed_percentage, flat_amount, random]
This is offer's construct.
currency string
This is offer's currency
discount_amount number
This is the amount that will be discounted as per the offer that has been configured. Sent in case of type being discount
cashback_amount number
This is the amount that will be cashback as per the offer that has been configured. Sent in case of type being cashback and construct not being random
random_cashback_min_amount float nullable
This is the minimum amount that can be cashback as per the offer that has been configured. Sent in case of type being cashback and construct being random
random_cashback_max_amount float nullable
This is the maximum amount that can be cashback as per the offer that has been configured. Sent in case of type being cashback and construct being random
pending_validations object nullable
This provides the fields that will be validated after initiating the payment to ascertain that the offer can be applied or not. This is only relevant for offers on upi and dependent on the conditions configured for the offer.
collect string[] nullable
intent string[] nullable
qr string[] nullable
order_line_items object[] nullable
Array [
sku_id string
This is the unique id of the product stored in your system
title string
This is the title of the product that is being sold
description string
This is the detailed description of the product being sold
image_url string
This is the public URL from which the image of the product can be fetched
rate number
This is the pre tax rate of the item, if validations are enabled then the amount must be total_amount ÷ quantity
quantity int
This is the quantity that is being purchased
amount_before_tax string
This is the rate * quantity i.e. the amount before tax
tax string
This is the tax amount on the cart item
total_amount string
This is the sum of amount before tax and the tax amount, if validations are enabled then sum of total_amount of all skus must be equal to order's total amount
serial_numbers string[]
unique identifiers for individual items, if validations are enabled then the number of provided serial number must be equal to quantity
offer_discount float nullable
This is the amount that will be discounted as per the offer that has been configured for that order line item. Sent in case of type being discount
offer_cashback float nullable
This is the amount that will be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct not being random
random_cashback_min_amount float nullable
This is the minimum amount that can be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct being random
random_cashback_max_amount float nullable
This is the maximum amount that can be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct being random
]
]
name string
The name of the pay later, it can be used in subsequent API calls
code string
This is the code for the Pay Laters created by Nimbbl, it could be used in subsequent API calls
]
cards object[]
The payment_mode passed in request to check the offers
Array [
offers object[]
This field list the offers for the Card Based Payment Modes
Array [
id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
name string
This is the offer name as configured
display_text string
This is the offer display text as configured
logo_url string nullable
This is the public url from which logo of the offer can be fetched
coupon_code string nullable
This is coupon code for the offer
terms_and_condition string nullable
This is offer's T&C in markdown format
start_date date-time
This is the offer start date in UTC
end_date date-time
This is the offer end date in UTC
type string
Possible values: [discount, cashback]
This is offer's type.
construct string
Possible values: [fixed_percentage, flat_amount, random]
This is offer's construct.
currency string
This is offer's currency
discount_amount number
This is the amount that will be discounted as per the offer that has been configured. Sent in case of type being discount
cashback_amount number
This is the amount that will be cashback as per the offer that has been configured. Sent in case of type being cashback and construct not being random
random_cashback_min_amount float nullable
This is the minimum amount that can be cashback as per the offer that has been configured. Sent in case of type being cashback and construct being random
random_cashback_max_amount float nullable
This is the maximum amount that can be cashback as per the offer that has been configured. Sent in case of type being cashback and construct being random
pending_validations object nullable
This provides the fields that will be validated after initiating the payment to ascertain that the offer can be applied or not. This is only relevant for offers on upi and dependent on the conditions configured for the offer.
collect string[] nullable
intent string[] nullable
qr string[] nullable
order_line_items object[] nullable
Array [
sku_id string
This is the unique id of the product stored in your system
title string
This is the title of the product that is being sold
description string
This is the detailed description of the product being sold
image_url string
This is the public URL from which the image of the product can be fetched
rate number
This is the pre tax rate of the item, if validations are enabled then the amount must be total_amount ÷ quantity
quantity int
This is the quantity that is being purchased
amount_before_tax string
This is the rate * quantity i.e. the amount before tax
tax string
This is the tax amount on the cart item
total_amount string
This is the sum of amount before tax and the tax amount, if validations are enabled then sum of total_amount of all skus must be equal to order's total amount
serial_numbers string[]
unique identifiers for individual items, if validations are enabled then the number of provided serial number must be equal to quantity
offer_discount float nullable
This is the amount that will be discounted as per the offer that has been configured for that order line item. Sent in case of type being discount
offer_cashback float nullable
This is the amount that will be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct not being random
random_cashback_min_amount float nullable
This is the minimum amount that can be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct being random
random_cashback_max_amount float nullable
This is the maximum amount that can be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct being random
]
]
]
upi object[]
The payment_mode passed in request to check the offers
Array [
offers object[]
This field list the offers for the UPI based payment_mode
Array [
id string
This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls
name string
This is the offer name as configured
display_text string
This is the offer display text as configured
logo_url string nullable
This is the public url from which logo of the offer can be fetched
coupon_code string nullable
This is coupon code for the offer
terms_and_condition string nullable
This is offer's T&C in markdown format
start_date date-time
This is the offer start date in UTC
end_date date-time
This is the offer end date in UTC
type string
Possible values: [discount, cashback]
This is offer's type.
construct string
Possible values: [fixed_percentage, flat_amount, random]
This is offer's construct.
currency string
This is offer's currency
discount_amount number
This is the amount that will be discounted as per the offer that has been configured. Sent in case of type being discount
cashback_amount number
This is the amount that will be cashback as per the offer that has been configured. Sent in case of type being cashback and construct not being random
random_cashback_min_amount float nullable
This is the minimum amount that can be cashback as per the offer that has been configured. Sent in case of type being cashback and construct being random
random_cashback_max_amount float nullable
This is the maximum amount that can be cashback as per the offer that has been configured. Sent in case of type being cashback and construct being random
pending_validations object nullable
This provides the fields that will be validated after initiating the payment to ascertain that the offer can be applied or not. This is only relevant for offers on upi and dependent on the conditions configured for the offer.
collect string[] nullable
intent string[] nullable
qr string[] nullable
order_line_items object[] nullable
Array [
sku_id string
This is the unique id of the product stored in your system
title string
This is the title of the product that is being sold
description string
This is the detailed description of the product being sold
image_url string
This is the public URL from which the image of the product can be fetched
rate number
This is the pre tax rate of the item, if validations are enabled then the amount must be total_amount ÷ quantity
quantity int
This is the quantity that is being purchased
amount_before_tax string
This is the rate * quantity i.e. the amount before tax
tax string
This is the tax amount on the cart item
total_amount string
This is the sum of amount before tax and the tax amount, if validations are enabled then sum of total_amount of all skus must be equal to order's total amount
serial_numbers string[]
unique identifiers for individual items, if validations are enabled then the number of provided serial number must be equal to quantity
offer_discount float nullable
This is the amount that will be discounted as per the offer that has been configured for that order line item. Sent in case of type being discount
offer_cashback float nullable
This is the amount that will be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct not being random
random_cashback_min_amount float nullable
This is the minimum amount that can be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct being random
random_cashback_max_amount float nullable
This is the maximum amount that can be cashback as per the offer that has been configured for that order line item. Sent in case of type being cashback and construct being random
]
]
]

{
  "net_banking": [
    {
      "additional_charges": 0,
      "offers": [
        {
          "id": "off_0a7f13b507ba",
          "name": "Diwali Dhamaka",
          "display_text": "50% Off Sitewide",
          "logo_url": "string",
          "coupon_code": "string",
          "terms_and_condition": "string",
          "start_date": "2025-03-22 16:10:22",
          "end_date": "2025-09-23 23:59:59",
          "type": "discount",
          "construct": "fixed_percentage",
          "currency": "string",
          "discount_amount": 100,
          "cashback_amount": 100,
          "random_cashback_min_amount": 1,
          "random_cashback_max_amount": 200,
          "pending_validations": {
            "collect": [
              "UPI Instrument"
            ],
            "intent": [
              "UPI PSP",
              "UPI App",
              "UPI Instrument"
            ],
            "qr": []
          },
          "order_line_items": [
            {
              "sku_id": "item_2783027490",
              "title": "Best Sliced Alphonso Mango",
              "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June. The time from flowering to harvest is about 90 days, while the time from harvest to ripening is about 15 days.The fruits generally weigh between 150 and 300 grams (5.3 and 10.6 oz), have a rich, creamy, tender texture and delicate, non-fibrous, juicy pulp. As the fruit matures, the skin of an Alphonso mango turns golden-yellow with a tinge of red across the top of the fruit",
              "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
              "rate": 1050,
              "quantity": "2",
              "amount_before_tax": "2100.00",
              "tax": "105.00",
              "total_amount": "2205.00",
              "serial_numbers": [
                "359043372654548",
                "359043371395481"
              ],
              "offer_discount": 1,
              "offer_cashback": 1,
              "random_cashback_min_amount": 1,
              "random_cashback_max_amount": 200
            }
          ]
        }
      ],
      "name": "Airtel Payments Bank",
      "code": "airt"
    }
  ],
  "wallet": [
    {
      "additional_charges": 0,
      "offers": [
        {
          "id": "off_0a7f13b507ba",
          "name": "Diwali Dhamaka",
          "display_text": "50% Off Sitewide",
          "logo_url": "string",
          "coupon_code": "string",
          "terms_and_condition": "string",
          "start_date": "2025-03-22 16:10:22",
          "end_date": "2025-09-23 23:59:59",
          "type": "discount",
          "construct": "fixed_percentage",
          "currency": "string",
          "discount_amount": 100,
          "cashback_amount": 100,
          "random_cashback_min_amount": 1,
          "random_cashback_max_amount": 200,
          "pending_validations": {
            "collect": [
              "UPI Instrument"
            ],
            "intent": [
              "UPI PSP",
              "UPI App",
              "UPI Instrument"
            ],
            "qr": []
          },
          "order_line_items": [
            {
              "sku_id": "item_2783027490",
              "title": "Best Sliced Alphonso Mango",
              "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June. The time from flowering to harvest is about 90 days, while the time from harvest to ripening is about 15 days.The fruits generally weigh between 150 and 300 grams (5.3 and 10.6 oz), have a rich, creamy, tender texture and delicate, non-fibrous, juicy pulp. As the fruit matures, the skin of an Alphonso mango turns golden-yellow with a tinge of red across the top of the fruit",
              "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
              "rate": 1050,
              "quantity": "2",
              "amount_before_tax": "2100.00",
              "tax": "105.00",
              "total_amount": "2205.00",
              "serial_numbers": [
                "359043372654548",
                "359043371395481"
              ],
              "offer_discount": 1,
              "offer_cashback": 1,
              "random_cashback_min_amount": 1,
              "random_cashback_max_amount": 200
            }
          ]
        }
      ],
      "name": "Airtel Money",
      "code": "AIRTEL_MONEY"
    }
  ],
  "pay_later": [
    {
      "additional_charges": 0,
      "offers": [
        {
          "id": "off_0a7f13b507ba",
          "name": "Diwali Dhamaka",
          "display_text": "50% Off Sitewide",
          "logo_url": "string",
          "coupon_code": "string",
          "terms_and_condition": "string",
          "start_date": "2025-03-22 16:10:22",
          "end_date": "2025-09-23 23:59:59",
          "type": "discount",
          "construct": "fixed_percentage",
          "currency": "string",
          "discount_amount": 100,
          "cashback_amount": 100,
          "random_cashback_min_amount": 1,
          "random_cashback_max_amount": 200,
          "pending_validations": {
            "collect": [
              "UPI Instrument"
            ],
            "intent": [
              "UPI PSP",
              "UPI App",
              "UPI Instrument"
            ],
            "qr": []
          },
          "order_line_items": [
            {
              "sku_id": "item_2783027490",
              "title": "Best Sliced Alphonso Mango",
              "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June. The time from flowering to harvest is about 90 days, while the time from harvest to ripening is about 15 days.The fruits generally weigh between 150 and 300 grams (5.3 and 10.6 oz), have a rich, creamy, tender texture and delicate, non-fibrous, juicy pulp. As the fruit matures, the skin of an Alphonso mango turns golden-yellow with a tinge of red across the top of the fruit",
              "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
              "rate": 1050,
              "quantity": "2",
              "amount_before_tax": "2100.00",
              "tax": "105.00",
              "total_amount": "2205.00",
              "serial_numbers": [
                "359043372654548",
                "359043371395481"
              ],
              "offer_discount": 1,
              "offer_cashback": 1,
              "random_cashback_min_amount": 1,
              "random_cashback_max_amount": 200
            }
          ]
        }
      ],
      "name": "Flash Pay Later",
      "code": "flash_paylater"
    }
  ],
  "cards": [
    {
      "offers": [
        {
          "id": "off_0a7f13b507ba",
          "name": "Diwali Dhamaka",
          "display_text": "50% Off Sitewide",
          "logo_url": "string",
          "coupon_code": "string",
          "terms_and_condition": "string",
          "start_date": "2025-03-22 16:10:22",
          "end_date": "2025-09-23 23:59:59",
          "type": "discount",
          "construct": "fixed_percentage",
          "currency": "string",
          "discount_amount": 100,
          "cashback_amount": 100,
          "random_cashback_min_amount": 1,
          "random_cashback_max_amount": 200,
          "pending_validations": {
            "collect": [
              "UPI Instrument"
            ],
            "intent": [
              "UPI PSP",
              "UPI App",
              "UPI Instrument"
            ],
            "qr": []
          },
          "order_line_items": [
            {
              "sku_id": "item_2783027490",
              "title": "Best Sliced Alphonso Mango",
              "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June. The time from flowering to harvest is about 90 days, while the time from harvest to ripening is about 15 days.The fruits generally weigh between 150 and 300 grams (5.3 and 10.6 oz), have a rich, creamy, tender texture and delicate, non-fibrous, juicy pulp. As the fruit matures, the skin of an Alphonso mango turns golden-yellow with a tinge of red across the top of the fruit",
              "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
              "rate": 1050,
              "quantity": "2",
              "amount_before_tax": "2100.00",
              "tax": "105.00",
              "total_amount": "2205.00",
              "serial_numbers": [
                "359043372654548",
                "359043371395481"
              ],
              "offer_discount": 1,
              "offer_cashback": 1,
              "random_cashback_min_amount": 1,
              "random_cashback_max_amount": 200
            }
          ]
        }
      ]
    }
  ],
  "upi": [
    {
      "offers": [
        {
          "id": "off_0a7f13b507ba",
          "name": "Diwali Dhamaka",
          "display_text": "50% Off Sitewide",
          "logo_url": "string",
          "coupon_code": "string",
          "terms_and_condition": "string",
          "start_date": "2025-03-22 16:10:22",
          "end_date": "2025-09-23 23:59:59",
          "type": "discount",
          "construct": "fixed_percentage",
          "currency": "string",
          "discount_amount": 100,
          "cashback_amount": 100,
          "random_cashback_min_amount": 1,
          "random_cashback_max_amount": 200,
          "pending_validations": {
            "collect": [
              "UPI Instrument"
            ],
            "intent": [
              "UPI PSP",
              "UPI App",
              "UPI Instrument"
            ],
            "qr": []
          },
          "order_line_items": [
            {
              "sku_id": "item_2783027490",
              "title": "Best Sliced Alphonso Mango",
              "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June. The time from flowering to harvest is about 90 days, while the time from harvest to ripening is about 15 days.The fruits generally weigh between 150 and 300 grams (5.3 and 10.6 oz), have a rich, creamy, tender texture and delicate, non-fibrous, juicy pulp. As the fruit matures, the skin of an Alphonso mango turns golden-yellow with a tinge of red across the top of the fruit",
              "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
              "rate": 1050,
              "quantity": "2",
              "amount_before_tax": "2100.00",
              "tax": "105.00",
              "total_amount": "2205.00",
              "serial_numbers": [
                "359043372654548",
                "359043371395481"
              ],
              "offer_discount": 1,
              "offer_cashback": 1,
              "random_cashback_min_amount": 1,
              "random_cashback_max_amount": 200
            }
          ]
        }
      ]
    }
  ]
}

{
  "card": [
    {
      "offers": [
        {
          "id": "off_0a7f13b507ba",
          "name": "Diwali Dhamaka",
          "display_text": "50% Off Sitewide",
          "logo_url": "string",
          "coupon_code": "string",
          "terms_and_condition": "string",
          "start_date": "2025-03-22 16:10:22",
          "end_date": "2025-09-23 23:59:59",
          "type": "discount",
          "construct": "fixed_percentage",
          "currency": "string",
          "discount_amount": 100,
          "cashback_amount": 100,
          "random_cashback_min_amount": 1,
          "random_cashback_max_amount": 200,
          "order_line_items": [
            {
              "sku_id": "item_2783027490",
              "title": "Best Sliced Alphonso Mango",
              "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June.",
              "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
              "rate": 1050,
              "quantity": "2",
              "amount_before_tax": "2100.00",
              "tax": "105.00",
              "total_amount": "2205.00",
              "serial_numbers": [
                "359043372654548",
                "359043371395481"
              ],
              "offer_discount": 1,
              "offer_cashback": 1,
              "random_cashback_min_amount": 1,
              "random_cashback_max_amount": 200
            }
          ]
        }
      ]
    }
  ]
}

{
  "net_banking": [
    {
      "additional_charges": 0,
      "name": "Airtel Payments Bank",
      "code": "airt",
      "offers": [
        {
          "id": "off_0a7f13b507ba",
          "name": "Diwali Dhamaka",
          "display_text": "50% Off Sitewide",
          "logo_url": "string",
          "coupon_code": "string",
          "terms_and_condition": "string",
          "start_date": "2025-03-22 16:10:22",
          "end_date": "2025-09-23 23:59:59",
          "type": "discount",
          "construct": "fixed_percentage",
          "currency": "string",
          "discount_amount": 100,
          "cashback_amount": 100,
          "random_cashback_min_amount": 1,
          "random_cashback_max_amount": 200,
          "order_line_items": [
            {
              "sku_id": "item_2783027490",
              "title": "Best Sliced Alphonso Mango",
              "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June.",
              "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
              "rate": 1050,
              "quantity": "2",
              "amount_before_tax": "2100.00",
              "tax": "105.00",
              "total_amount": "2205.00",
              "serial_numbers": [
                "359043372654548",
                "359043371395481"
              ],
              "offer_discount": 1,
              "offer_cashback": 1,
              "random_cashback_min_amount": 1,
              "random_cashback_max_amount": 200
            }
          ]
        }
      ]
    }
  ]
}

{
  "wallet": [
    {
      "additional_charges": 0,
      "name": "Airtel Money",
      "code": "AIRTEL_MONEY",
      "offers": [
        {
          "id": "off_0a7f13b507ba",
          "name": "Diwali Dhamaka",
          "display_text": "50% Off Sitewide",
          "logo_url": "string",
          "coupon_code": "string",
          "terms_and_condition": "string",
          "start_date": "2025-03-22 16:10:22",
          "end_date": "2025-09-23 23:59:59",
          "type": "discount",
          "construct": "fixed_percentage",
          "currency": "string",
          "discount_amount": 100,
          "cashback_amount": 100,
          "random_cashback_min_amount": 1,
          "random_cashback_max_amount": 200,
          "order_line_items": [
            {
              "sku_id": "item_2783027490",
              "title": "Best Sliced Alphonso Mango",
              "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June.",
              "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
              "rate": 1050,
              "quantity": "2",
              "amount_before_tax": "2100.00",
              "tax": "105.00",
              "total_amount": "2205.00",
              "serial_numbers": [
                "359043372654548",
                "359043371395481"
              ],
              "offer_discount": 1,
              "offer_cashback": 1,
              "random_cashback_min_amount": 1,
              "random_cashback_max_amount": 200
            }
          ]
        }
      ]
    }
  ]
}

{
  "upi": [
    {
      "additional_charges": 0,
      "name": "UPI Payment",
      "code": "upi",
      "offers": [
        {
          "id": "off_0a7f13b507ba",
          "name": "Diwali Dhamaka",
          "display_text": "50% Off Sitewide",
          "logo_url": "string",
          "coupon_code": "string",
          "terms_and_condition": "string",
          "start_date": "2025-03-22 16:10:22",
          "end_date": "2025-09-23 23:59:59",
          "type": "discount",
          "construct": "fixed_percentage",
          "currency": "string",
          "discount_amount": 100,
          "cashback_amount": 100,
          "random_cashback_min_amount": 1,
          "random_cashback_max_amount": 200,
          "pending_validations": {
            "collect": [
              "UPI Instrument"
            ],
            "intent": [
              "UPI PSP",
              "UPI App",
              "UPI Instrument"
            ],
            "qr": []
          },
          "order_line_items": [
            {
              "sku_id": "item_2783027490",
              "title": "Best Sliced Alphonso Mango",
              "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June.",
              "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
              "rate": 1050,
              "quantity": "2",
              "amount_before_tax": "2100.00",
              "tax": "105.00",
              "total_amount": "2205.00",
              "serial_numbers": [
                "359043372654548",
                "359043371395481"
              ],
              "offer_discount": 1,
              "offer_cashback": 1,
              "random_cashback_min_amount": 1,
              "random_cashback_max_amount": 200
            }
          ]
        }
      ]
    }
  ]
}

[
  {
    "additional_charges": 0,
    "offers": [
      {
        "id": "off_0a7f13b507ba",
        "name": "Diwali Dhamaka",
        "display_text": "50% Off Sitewide",
        "logo_url": "string",
        "coupon_code": "string",
        "terms_and_condition": "string",
        "start_date": "2025-03-22 16:10:22",
        "end_date": "2025-09-23 23:59:59",
        "type": "discount",
        "construct": "fixed_percentage",
        "currency": "string",
        "discount_amount": 100,
        "cashback_amount": 100,
        "random_cashback_min_amount": 1,
        "random_cashback_max_amount": 200,
        "pending_validations": {
          "collect": [
            "UPI Instrument"
          ],
          "intent": [
            "UPI PSP",
            "UPI App",
            "UPI Instrument"
          ],
          "qr": []
        },
        "order_line_items": [
          {
            "sku_id": "item_2783027490",
            "title": "Best Sliced Alphonso Mango",
            "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June.",
            "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
            "rate": 1050,
            "quantity": "2",
            "amount_before_tax": "2100.00",
            "tax": "105.00",
            "total_amount": "2205.00",
            "serial_numbers": [
              "359043372654548",
              "359043371395481"
            ],
            "offer_discount": 1,
            "offer_cashback": 1,
            "random_cashback_min_amount": 1,
            "random_cashback_max_amount": 200
          }
        ]
      }
    ]
  }
]

{
  "pay_later": [
    {
      "additional_charges": 0,
      "name": "Flash Pay Later",
      "code": "flash_paylater",
      "offers": [
        {
          "id": "off_0a7f13b507ba",
          "name": "Diwali Dhamaka",
          "display_text": "50% Off Sitewide",
          "logo_url": "string",
          "coupon_code": "string",
          "terms_and_condition": "string",
          "start_date": "2025-03-22 16:10:22",
          "end_date": "2025-09-23 23:59:59",
          "type": "discount",
          "construct": "fixed_percentage",
          "currency": "string",
          "discount_amount": 100,
          "cashback_amount": 100,
          "random_cashback_min_amount": 1,
          "random_cashback_max_amount": 200,
          "order_line_items": [
            {
              "sku_id": "item_2783027490",
              "title": "Best Sliced Alphonso Mango",
              "description": "The Alphonso mango is a seasonal fruit harvested from mid-April through the end of June.",
              "image_url": "https://en.wikipedia.org/wiki/Alphonso_mango#/media/File:Alphonso_mango.jpg",
              "rate": 1050,
              "quantity": "2",
              "amount_before_tax": "2100.00",
              "tax": "105.00",
              "total_amount": "2205.00",
              "serial_numbers": [
                "359043372654548",
                "359043371395481"
              ],
              "offer_discount": 1,
              "offer_cashback": 1,
              "random_cashback_min_amount": 1,
              "random_cashback_max_amount": 200
            }
          ]
        }
      ]
    }
  ]
}

When the offers cannot be fetched, the response will be as below

application/json

Schema

Example (from schema)

---

Schema

error object

nimbbl_error_code string

This is the error_code generated by Nimbbl

nimbbl_consumer_message string

This is a customer friendly message that can be displayed to your consumer

nimbbl_merchant_message string

This explains to your team how to recover from the error

{
  "error": {
    "nimbbl_error_code": "INVALID_REQUEST_PARAMETER",
    "nimbbl_consumer_message": "Sorry, your payment cannot be processed due to a technical error. Please try again after some time.",
    "nimbbl_merchant_message": "There is an input validation error, please check the payload of your request."
  }
}

When there is a problem on the server, the response will be as below

application/json

Schema

Example (from schema)

---

Schema

error object

nimbbl_error_code string

This is the error_code generated by Nimbbl

nimbbl_consumer_message string

This is a customer friendly message that can be displayed to your consumer

nimbbl_merchant_message string

This explains to your team how to recover from the error

{
  "error": {
    "nimbbl_error_code": "INVALID_REQUEST_PARAMETER",
    "nimbbl_consumer_message": "Sorry, your payment cannot be processed due to a technical error. Please try again after some time.",
    "nimbbl_merchant_message": "There is an input validation error, please check the payload of your request."
  }
}

Loading...