Create Offer

Use this API to create offers with Cashfree from your backend

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 key in the merchant dashboard.

Headers

x-api-version · string · default: 2025-01-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<UUID>

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 create an offer at Cashfree

create offer backend request object

offer_meta · object · required

Offer meta details object

Show child attributes

Example:

{
  "$ref": "#/components/schemas/OfferMeta/example",
  "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 · object · required

Offer terms and condition object

Show child attributes

Example:

{
  "$ref": "#/components/schemas/OfferTnc/example",
  "offer_tnc_type": "text",
  "offer_tnc_value": "TnC for the Offer."
}

offer_details · object · required

Offer details and type

Show child attributes

Example:

{
  "$ref": "#/components/schemas/OfferDetails/example",
  "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 · object · required

Offer validation object

Show child attributes

Example:

{
  "$ref": "#/components/schemas/OfferValidations/example",
  "min_amount": 10,
  "payment_method": { "wallet": { "issuer": "paytm" } },
  "max_allowed": 2
}

Response

200

application/json

OK

Offer entity object

offer_id · string

Example:

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

offer_status · string

Example:

"active"

order_amount · number

payable_amount · number

offer_meta · object

Offer meta response details object

Show child attributes

Example:

{
  "$ref": "#/components/schemas/OfferMetaResponse/example",
  "offer_code": "CFTESTOFFER",
  "offer_description": "some offer description",
  "offer_end_time": "2023-03-29T08:09:51Z",
  "offer_start_time": "2023-03-21T08:09:51Z",
  "offer_title": "some title"
}

offer_tnc · object

Offer terms and condition object

Show child attributes

Example:

{
  "$ref": "#/components/schemas/OfferTncResponse/example",
  "offer_tnc_type": "text",
  "offer_tnc_value": "TnC for the Offer."
}

offer_details · object

Offer details response and type

Show child attributes

Example:

{
  "$ref": "#/components/schemas/OfferDetailsResponse/example",
  "cashback_details": {
    "cashback_type": "percentage",
    "cashback_value": "20",
    "max_cashback_amount": "150"
  },
  "discount_details": {
    "discount_type": "flat",
    "discount_value": "10",
    "max_discount_amount": "10"
  },
  "offer_type": "DISCOUNT_AND_CASHBACK"
}

offer_validations · object

Offer validation object

Show child attributes

Example:

{
  "$ref": "#/components/schemas/OfferValidationsResponse/example",
  "max_allowed": 2,
  "min_amount": 10,
  "payment_method": { "wallet": { "issuer": "paytm" } }
}