Prerequisites

1. Make sure you have created Cashfree Account and API keys are generated.
2. You have created an order.

1. Include JS SDK in your client code

To integrate the Cashfree Checkout, you must include our JavaScript SDK within your JS file.

You can do this by

1. Including the Script Tag. Import the URL in the snippet below to your HTML file.

<script src="https://sdk.cashfree.com/js/v3/cashfree.js"></script>

2. Install from npm

npm install @cashfreepayments/cashfree-js

Try Cashfree DevStudio

Try Now

2. Initialise the SDK

You need to initialise the variable using the Cashfree() function. There are two modes applicable for this - "sandbox" or "production". Sandbox is used for test environment, whereas production is used for production mode.

const cashfree = Cashfree({
    mode:"sandbox" //or production
});

3. Open Cashfree Checkout

To open the checkout, you can use cashfree.checkout()method.
This method can take in following parameters -

• paymentSessionId(required)- This is received in the response of Create Order API.

• redirectTarget(optional) - This lets you decide how to open the Cashfree Checkout. Values allowed and their descriptions are mentioned in the table below.

  Value	Description
  _blank	Opens the payment link in a new window or tab.
  _self(default)	Opens the payment link in the same frame as it was clicked.

Open Cashfree Checkout in following way

let checkoutOptions = {
    paymentSessionId: "your-payment-session-id",
    redirectTarget: "_self" //optional (_self or _blank)
}

cashfree.checkout(checkoutOptions)

Try Cashfree DevStudio

Try Now

Whitelist Domain

❗️

This integration will require whitelisting of your domain used for opening the checkout page. Any other domain used to open the checkout page will be blocked by Cashfree. You can request for domain whitelisting via Developers > Whitelisting from your merchant dashboard.

You can check the step-by-step process of whitelist request here.