@cashfreepayments/cashfree-sdk

Cashfree libraries are released in Beta. This is work in progress and we are continuously working on improving various aspects of it. It is released as a learning aid and an example kit for the API integrators.

This is not recommended by Cashfree for direct use in production code. Please report any bugs to Cashfree at [e-mail].

cashfree-sdk-nodejs

The official Cashfree SDK for JavaScript, available for Node.js backends. Node version 10.9.0 was used for this SDK.

Get started quickly using Cashfree with the Cashfree SDK for JavaScript in Node.js. The SDK helps take the complexity out of coding by providing JavaScript objects for Cashfree services including Payouts, Payment Gateway, Marketplace and Autocollect. The single, downloadable package includes the Cashfree JavaScript Library and documentation.

API Documentation

Please refer to the Cashfree Docs for the complete API reference.

Installation

In Node.js

The preferred way to install the Cashfree SDK for Node.js is to use the npm package manager for Node.js. Simply type the following into a terminal window:

npm i @cashfreepayments/cashfree-sdk

Getting Started

Pre-requisites

• A Cashfree Merchant Account
• API keys for different products. You can generate them from your Dashboard

IP Whitelisting and dynamic IPs

Your IP has to be whitelisted to hit Cashfree's server. Or if you have a dynamic IP please pass in the public key parameter during the init method as shown below. For more information please go here.

Usage

Payouts

The package needs to be configured with your account's secret key which is available in your Cashfree Dashboard.

In case of static IP (Your IP is whitelisted)

const { Payouts } = require('@cashfreepayments/cashfree-sdk');

// Instantiate Cashfree Payouts
const payoutsInstance = new Payouts({
  env: 'TEST',
  clientId: '<CLIENT_ID>',
  clientSecret: '<CLIENT_SECRET>',
});

In case of dynamic IP you will need a public key to generate a signature(which will be done by sdk itself)

const { Payouts } = require('@cashfreepayments/cashfree-sdk');

// Instantiate Cashfree Payouts
const payoutsInstance = new Payouts({
  env: 'TEST',
  clientId: '<CLIENT_ID>',
  clientSecret: '<CLIENT_SECRET>',
  pathToPublicKey: '/path/to/your/public/key/file.pem',
  //"publicKey": "ALTERNATIVE TO SPECIFYING PATH (DIRECTLY PASTE PublicKey)"
});

Option	Default	Description
env	TEST	Environment to be initialized. Can be set to TEST or PRODUCTION
clientId	``	clientId which can be generated on cashfree dashboard.
clientSecret	``	clientSecret which can be found alongside generated ClientId.
pathToPublicKey	``	Either specify the path to your .pem public key file or use publicKey Param and pass the key there.
publicKey	``	Pass your Public Key to this parameter as an alternative to pathToPublicKey.

WebHook Verification

To verify the webhook received from Cashfree for different events and accept the webhook only when it returns true.

Usage

Pass the webhook received along with the payload type.

Payouts.verifySignature(webhookPostDataJson, signature, clientSecret); // returns true or false

Using Promises

Every method returns a promise which can be used:

payoutsInstance.beneficiary
  .add({
    beneId: 'JOHN18012',
    name: 'john doe',
    email: '[e-mail]',
    phone: '9876543210',
    bankAccount: '00001111222233',
    ifsc: 'HDFC0000001',
    address1: 'ABC Street',
    city: 'Bangalore',
    state: 'Karnataka',
    pincode: '560001',
  })
  .then(function (response) {
    console.log(response);
  });

Using Async/Await

async function addBeneficiary() {
  try {
    const response = await payoutsInstance.beneficiary.add({
      beneId: 'JOHN18012',
      name: 'john doe',
      email: '[e-mail]',
      phone: '9876543210',
      bankAccount: '00001111222233',
      ifsc: 'HDFC0000001',
      address1: 'ABC Street',
      city: 'Bangalore',
      state: 'Karnataka',
      pincode: '560001',
    });

    console.log(response);
  } catch (e) {
    console.error(e);
  }
}

• For more information about the APIs go to Payouts.
• Complete list of APIs

Payment Gateway

• Documentation and API

TODO

• Market Place

• Autocollect