Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@cashfreepayments/cashfree-js

cashfree20.4kMIT1.0.5

cashfree.js loader

cashfree, payment gateway, cashfreejs, cashfree.js

readme

Cashfree.js ES Module

Use Cashfree.js as an ES module.

Installation

Use npm to install the Cashfree.js module:

npm install @cashfreepayments/cashfree-js

Usage

load

This function returns a Promise that resolves with a newly created Cashfree object once Cashfree.js has loaded. If you call load in a server environment it will resolve to null.

import {load} from '@cashfreepayments/cashfree-js';

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

For more information on how to use Cashfree.js, please refer to the Cashfree.js API reference or learn to accept a payment with Cashfree.

If you have deployed a Content Security Policy, make sure to [include Cashfree.js in your directives].

  • connect-src, https://api.cashfree.com
  • frame-src, https://sdk.cashfree.com, https://api.cashfree.com, https://sandbox.cashfree.com https://payments.cashfree.com, https://payments-test.cashfree.com
  • script-src, https://sdk.cashfree.com

Cashfree.js Documentation