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_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
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

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

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

offer_discount number

This is amount that will be discounted as per the offers that have been configured by you

offer_id string

This is the unique offer id provided by Nimbbl, it can be used in subsequent API calls

offer_name string

This is the offer name as configured

offer_start_date date-time

This is the offer start date in UTC

offer_end_date date-time

This is the offer end date in UTC

offer_desc string

This is the description of the offer that can be used by you on your checkout

{
  "additional_charges": 10,
  "offers": {
    "offer_discount": 100,
    "offer_id": "off_0a7f13b507ba",
    "offer_name": "Diwali Dhamaka",
    "offer_start_date": "2023-03-22 16:10:22",
    "offer_end_date": "2023-09-23 23:59:59",
    "offer_desc": "10% off upto INR 100 on Simpl"
  }
}

{
  "card": [
    {
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      }
    }
  ]
}

{
  "net_banking": [
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "bank_name": "Axis Bank",
      "code": "axis"
    },
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "bank_name": "HDFC Bank",
      "code": "hdfc"
    },
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "bank_name": "ICICI Bank",
      "code": "icic"
    },
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "bank_name": "State Bank of India",
      "code": "sbi"
    }
  ]
}

{
  "wallet": [
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "wallet_name": "Freecharge",
      "code": "FREECHARGE"
    },
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "wallet_name": "Jio Money",
      "code": "JIO_MONEY"
    },
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "wallet_name": "Olamoney",
      "code": "OLAMONEY"
    },
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "wallet_name": "PhonePe",
      "code": "PHONEPE"
    }
  ]
}

{
  "upi": [
    {
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      }
    }
  ]
}

{
  "additional_charges": 0,
  "offer": {
    "offer_id": "off_e81eee27ff65",
    "offer_name": "dfafadsf",
    "offer_start_date": "2024-08-29 11:12:14",
    "offer_end_date": "2025-01-30 12:46:14",
    "offer_description": "fixed_percentage",
    "offer_discount": 2
  }
}

{
  "pay_later": [
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "pay_later_name": "Flash Pay Later",
      "pay_later_code": "flash_paylater"
    },
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "pay_later_name": "Mobikwik Zip",
      "pay_later_code": "mobikwik_zip"
    },
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "pay_later_name": "Splash Paylater",
      "pay_later_code": "splash_paylater"
    },
    {
      "additional_charges": 0,
      "offer": {
        "offer_id": "off_4f36a4f64803",
        "offer_name": "Get 20% on UPI Transactions",
        "offer_start_date": "2024-01-05 06:17:47",
        "offer_end_date": "2024-03-23 06:14:47",
        "offer_description": "fixed_percentage",
        "offer_discount": 0.8
      },
      "pay_later_name": "Kissht Paylater",
      "pay_later_code": "kissht_paylater"
    }
  ]
}

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...