Telr Developer Documentation

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:2025-01-01

required

API version to be used

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 get eligible offers for a customer and order

Eligiblty API request

queries

OfferQueries · object

required

Offer Query Object

Show child attributes

queries.order_id

string<string>

OrderId of the order. Either of order_id or order_amount is mandatory.

Required string length: 3 - 50

Example:

"order_413462PK1RI1IwYB1X69LgzUQWiSxYDF"

queries.amount

number

Amount of the order. OrderId of the order. Either of order_id or order_amount is mandatory.

Required range: x >= 1

Example:

100

Example:

{
  "order_id": "order_413462PK1RI1IwYB1X69LgzUQWiSxYDF",
  "amount": 100
}

filters

OfferFilters · object

Filter for offers

Show child attributes

filters.offer_type

enum<string>[]

Array of offer_type to be filtered.

Offer Type Object

Available options:

DISCOUNT,

CASHBACK,

DISCOUNT_AND_CASHBACK,

NO_COST_EMI

Example:

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

Response

eligibility

boolean

Example:

true

entity_type

string

Example:

"offers"

entity_value

string

Example:

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

entity_details

OfferEntity · object

Offer entity object

Show child attributes

entity_details.offer_id

string

Example:

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

entity_details.offer_status

string

Example:

"active"

entity_details.order_amount

number<float64>

entity_details.payable_amount

number<float64>

entity_details.offer_meta

OfferMetaResponse · object

Offer meta response details object

Show child attributes

entity_details.offer_meta.offer_code

string

Unique identifier for the Offer.

Required string length: 1 - 45

Example:

"CFTESTOFFER"

entity_details.offer_meta.offer_description

string

Description for the Offer.

Required string length: 3 - 100

Example:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit"

entity_details.offer_meta.offer_end_time

string

Expiry Time for the Offer

Example:

"2023-03-29T08:09:51Z"

entity_details.offer_meta.offer_start_time

string

Start Time for the Offer

Required string length: 3 - 20

Example:

"2023-03-21T08:09:51Z"

entity_details.offer_meta.offer_title

string

Title for the Offer.

Required string length: 3 - 50

Example:

"Test Offer"

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",
  "$ref": "#/components/schemas/OfferMetaResponse/example"
}

entity_details.offer_tnc

OfferTncResponse · object

Offer terms and condition object

Show child attributes

entity_details.offer_tnc.offer_tnc_type

enum<string>

TnC Type for the Offer. It can be either text or link

Available options:

text,

link

Required string length: 3 - 50

Example:

"text"

entity_details.offer_tnc.offer_tnc_value

string

TnC for the Offer.

Required string length: 3 - 100

Example:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit"

Example:

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

entity_details.offer_details

OfferDetailsResponse · object

Offer details response and type

Show child attributes

entity_details.offer_details.cashback_details

CashbackDetails · object

Cashback detail boject

Show child attributes

entity_details.offer_details.cashback_details.cashback_type

enum<string>

required

Type of discount

Available options:

flat,

percentage

Required string length: 1 - 50

entity_details.offer_details.cashback_details.cashback_value

number<float64>

required

Value of Discount.

entity_details.offer_details.cashback_details.max_cashback_amount

number<float64>

required

Maximum Value of Cashback allowed.

Example:

{
  "cashback_type": "percentage",
  "cashback_value": "20",
  "max_cashback_amount": "150"
}

entity_details.offer_details.discount_details

DiscountDetails · object

detils of the discount object of offer

Show child attributes

entity_details.offer_details.discount_details.discount_type

enum<string>

required

Type of discount

Available options:

flat,

percentage

Required string length: 3 - 50

entity_details.offer_details.discount_details.discount_value

number<float64>

required

Value of Discount.

entity_details.offer_details.discount_details.max_discount_amount

number<float64>

required

Maximum Value of Discount allowed.

Example:

{
  "discount_type": "flat",
  "discount_value": "10",
  "max_discount_amount": "10"
}

entity_details.offer_details.offer_type

enum<string>

Offer Type for the Offer.

Available options:

DISCOUNT,

CASHBACK,

DISCOUNT_AND_CASHBACK,

NO_COST_EMI

Required string length: 3 - 50

Example:

"DISCOUNT_AND_CASHBACK"

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",
  "$ref": "#/components/schemas/OfferDetailsResponse/example"
}

entity_details.offer_validations

OfferValidationsResponse · object

Offer validation object

Show child attributes

entity_details.offer_validations.max_allowed

number

Maximum Amount for Offer to be Applicable

Required range: x >= 1

Example:

1

entity_details.offer_validations.min_amount

number

Minimum Amount for Offer to be Applicable

Required range: x >= 1

Example:

1

entity_details.offer_validations.payment_method

All Offers · object

returns all offers

Show child attributes

entity_details.offer_validations.payment_method.all

All Offers · object

required

All offers applicable

Example:

{
  "all": {},
  "wallet": { "issuer": "paytm" }
}

Example:

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

Example:

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

Payments API

v2025-01-01

Get Eligible Offers for an Order

Authorizations

Headers

Body

Response