Skip to content

Latest commit

 

History

History
189 lines (162 loc) · 5.11 KB

Offers.md

File metadata and controls

189 lines (162 loc) · 5.11 KB
Raw

Offers

Method HTTP request Description
PGCreateOffer Post /offers Create Offer
PGFetchOffer Get /offers/{offer_id} Get Offer by ID

PGCreateOffer

PGCreateOffer(x_api_version: string, CreateOfferRequest: CreateOfferRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OfferEntity, any>>

Create Offer (Docs)

Example

const request = {
    "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": {
      "payment_method": {
        "card": {
          "type": [
            "cc"
          ],
          "bank_name": "hdfc bank",
          "scheme_name": [
            "visa"
          ]
        }
      },
      "min_amount": 15,
      "max_allowed": 100
    }
  }

Cashfree.PGCreateOffer("2022-09-01", request).then((response) => {
    console.log('Offer creation successful:', response.data);
})
.catch((error) => {
    console.error('Error while creating offers:', error);
});

Parameters

Name Type Description Notes
xApiVersion string* API version to be used. Format is in YYYY-MM-DD [default to "2022-09-01"]
createOfferRequest CreateOfferRequest* Request body to create an offer at Cashfree
xRequestId string Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

Response

{
  "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
  }
}

PGFetchOffer

PGFetchOffer(x_api_version: string, offer_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OfferEntity, any>>

Get Offer by ID (Docs)

Example

Cashfree.PGFetchOffer("2022-09-01", "afbc424a-a21c-4e77-8b3d-5ac0d9b91974").then((response) => {
    console.log('Offer Fetch successful:', response.data);
})
.catch((error) => {
    console.error('Error while fetching offer:', error);
});

Parameters

Name Type Description Notes
offerId string The offer ID for which you want to view the offer details.
xApiVersion string API version to be used. Format is in YYYY-MM-DD [default to "2022-09-01"]
xRequestId string Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

Response

{
  "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
  }
}