POST
/
eligibility
/
offers
curl --request POST \
  --url https://sandbox.cashfree.com/pg/eligibility/offers \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "queries": {
    "amount": 1000
  }
}'
[
  {
    "offer_id": "d2b430fb-1afe-455a-af31-66d00377b29a",
    "offer_status": "active",
    "offer_meta": {
      "offer_title": "some title",
      "offer_description": "some offer description",
      "offer_code": "CFTESTOFFER",
      "offer_start_time": "2023-03-21T08:09:51Z",
      "offer_end_time": "2023-03-29T08:09:51Z"
    },
    "offer_tnc": {
      "offer_tnc_type": "text",
      "offer_tnc_value": "TnC for the Offer."
    },
    "offer_details": {
      "offer_type": "DISCOUNT_AND_CASHBACK",
      "discount_details": {
        "discount_type": "flat",
        "discount_value": "10",
        "max_discount_amount": "10"
      },
      "cashback_details": {
        "cashback_type": "percentage",
        "cashback_value": "20",
        "max_cashback_amount": "150"
      }
    },
    "offer_validations": {
      "min_amount": 10,
      "payment_method": {
        "wallet": {
          "issuer": "paytm"
        }
      },
      "max_allowed": 2
    }
  }
]

Authorizations

​
x-client-id
string
header
required

Client app ID. You can find your app id in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

​
x-api-version
string
default:2023-08-01
required

API version to be used. Format is in YYYY-MM-DD

​
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

​
x-idempotency-key
string

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Body

application/json
Request Body to get eligible offers for a customer and order

Eligiblty API request

​
queries
object
required

Offer Query Object

Example:
{
  "order_id": "order_413462PK1RI1IwYB1X69LgzUQWiSxYDF",
  "amount": 100
}
​
filters
object

Filter for offers

Example:
{
  "offer_type": ["DISCOUNT_AND_CASHBACK", "DISCOUNT"]
}

Response

200
application/json
OK
​
eligibility
boolean
Example:

true

​
entity_type
string
Example:

"offers"

​
entity_value
string
Example:

"d2b430fb-1afe-455a-af31-66d00377b29a"

​
entity_details
object

Offer entity object

Example:
{
  "$ref": "#/components/examples/offer_entity_example/value/0"
}

Was this page helpful?