Telr Developer Documentation

curl --request POST \
  --url https://sandbox.cashfree.com/pg/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 '
{
  "offer_meta": {
    "offer_title": "Test Offer",
    "offer_description": "Offer Description",
    "offer_code": "CFTESTOFFER",
    "offer_start_time": "2023-03-21T08:09:51Z",
    "offer_end_time": "2024-03-21T08:09:51Z"
  },
  "offer_tnc": {
    "offer_tnc_type": "text",
    "offer_tnc_value": "Terms and Condition of 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": "10",
      "max_cashback_amount": "10"
    }
  },
  "offer_validations": {
    "min_amount": 15,
    "max_allowed": 100,
    "payment_method": {
      "card": {
        "type": [
          "cc"
        ],
        "bank_name": "hdfc bank",
        "scheme_name": [
          "visa"
        ]
      }
    }
  }
}
'

{
  "offer_id": "d2b430fb-1afe-455a-af31-66d00377b29a",
  "offer_status": "active",
  "order_amount": 123,
  "payable_amount": 123,
  "offer_meta": {
    "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": {
    "offer_tnc_type": "text",
    "offer_tnc_value": "TnC for the Offer."
  },
  "offer_details": {
    "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": {
    "max_allowed": 2,
    "min_amount": 10,
    "payment_method": {
      "wallet": {
        "issuer": "paytm"
      }
    }
  }
}

{
  "message": "bad URL, please check API documentation",
  "help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
  "code": "request_failed",
  "type": "invalid_request_error"
}

{
  "message": "authentication Failed",
  "code": "request_failed",
  "type": "authentication_error"
}

{
  "message": "something is not found",
  "help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
  "code": "somethind_not_found",
  "type": "invalid_request_error"
}

{
  "message": "order with same id is already present",
  "help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
  "code": "order_already_exists",
  "type": "invalid_request_error"
}

{
  "message": "something is not found",
  "help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
  "code": "request_invalid",
  "type": "idempotency_error"
}

{
  "message": "Too many requests from IP. Check headers",
  "code": "request_failed",
  "type": "rate_limit_error"
}

{
  "message": "internal Server Error",
  "help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
  "code": "internal_error",
  "type": "api_error"
}

POST

offers

curl --request POST \
  --url https://sandbox.cashfree.com/pg/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 '
{
  "offer_meta": {
    "offer_title": "Test Offer",
    "offer_description": "Offer Description",
    "offer_code": "CFTESTOFFER",
    "offer_start_time": "2023-03-21T08:09:51Z",
    "offer_end_time": "2024-03-21T08:09:51Z"
  },
  "offer_tnc": {
    "offer_tnc_type": "text",
    "offer_tnc_value": "Terms and Condition of 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": "10",
      "max_cashback_amount": "10"
    }
  },
  "offer_validations": {
    "min_amount": 15,
    "max_allowed": 100,
    "payment_method": {
      "card": {
        "type": [
          "cc"
        ],
        "bank_name": "hdfc bank",
        "scheme_name": [
          "visa"
        ]
      }
    }
  }
}
'

{
  "offer_id": "d2b430fb-1afe-455a-af31-66d00377b29a",
  "offer_status": "active",
  "order_amount": 123,
  "payable_amount": 123,
  "offer_meta": {
    "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": {
    "offer_tnc_type": "text",
    "offer_tnc_value": "TnC for the Offer."
  },
  "offer_details": {
    "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": {
    "max_allowed": 2,
    "min_amount": 10,
    "payment_method": {
      "wallet": {
        "issuer": "paytm"
      }
    }
  }
}

{
  "message": "bad URL, please check API documentation",
  "help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
  "code": "request_failed",
  "type": "invalid_request_error"
}

{
  "message": "authentication Failed",
  "code": "request_failed",
  "type": "authentication_error"
}

{
  "message": "something is not found",
  "help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
  "code": "somethind_not_found",
  "type": "invalid_request_error"
}

{
  "message": "order with same id is already present",
  "help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
  "code": "order_already_exists",
  "type": "invalid_request_error"
}

{
  "message": "something is not found",
  "help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
  "code": "request_invalid",
  "type": "idempotency_error"
}

{
  "message": "Too many requests from IP. Check headers",
  "code": "request_failed",
  "type": "rate_limit_error"
}

{
  "message": "internal Server Error",
  "help": "Check latest errors and resolution from Merchant Dashboard API logs: https://bit.ly/4glEd0W Help Document: https://bit.ly/4eeZYO9",
  "code": "internal_error",
  "type": "api_error"
}

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

create offer backend request object

offer_meta

OfferMeta · object

required

Offer meta details object

Show child attributes

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

OfferMeta · object

required

Offer terms and condition object

Show child attributes

Example:

{
  "offer_tnc_type": "text",
  "offer_tnc_value": "TnC for the Offer."
}

offer_details

OfferDetails · object

required

Offer details and type

Show child attributes

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

OfferValidations · object

required

Offer validation object

Show child attributes

Example:

{
  "min_amount": 10,
  "payment_method": { "wallet": { "issuer": "paytm" } },
  "max_allowed": 2
}

Response

Offer entity object

offer_id

string

Example:

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

offer_status

string

Example:

"active"

order_amount

number<float64>

payable_amount

number<float64>

offer_meta

OfferMetaResponse · object

Offer meta response details object

Show child attributes

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

OfferTncResponse · object

Offer terms and condition object

Show child attributes

Example:

{
  "offer_tnc_type": "text",
  "offer_tnc_value": "TnC for the Offer."
}

offer_details

OfferDetailsResponse · object

Offer details response and type

Show child attributes

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

OfferValidationsResponse · object

Offer validation object

Show child attributes

Example:

{
  "max_allowed": 2,
  "min_amount": 10,
  "payment_method": { "wallet": { "issuer": "paytm" } }
}

Payments API

v2025-01-01

Create Offer

Authorizations

Headers

Body

Response