Quickstart

Learn how to get started with your Cashfree integration.

Integrate easily with Cashfree by using one of Cashfree's libraries or by directly calling our APIs. Follow these minimal steps to get started:

  1. ​Credentials: Get your required credentials for Cashfree to authenticate and verify your account.

  2. ​Setup: Install and initialize our libraries to get communicating with Cashfree.

  3. ​Call: Use multiple methods supported by the libraries to start interacting with us. Take a look at our sample integration kits to know what you can achieve with Cashfree integration.

Credentials

Cashfree authenticates requests based on your credentials. For payouts, these are your clientId and clientSecret.

All Cashfree payouts APIs require an auth bearer token to identify and authenticate the merchant. The libraries internally store this token on their initialization. For using our APIs, you need to call the authenticate API to obtain the token.

Go here to find out how to get your credentials.

Setup

Download Cashfree's libraries to start integrating and using Cashfree's services. By running the following command from your terminal.

Node
Python
Node
npm install https://github.com/cashfree/cashfree-sdk-nodejs
Python
pip3 install git+https://github.com/cashfree/cashfree-sdk-python.git

For Java, add the following code to your pom.xml for maven projects and build.gradle for your Gradle project.

pom.xml
build.gradle
pom.xml
<dependency>
<groupId>com.cashfree</groupId>
<artifactId>cashfreelibjava</artifactId>
<version>0.0.1</version>
</dependency>
build.gradle
compile 'com.cashfree:cashfreelibjava:0.0.1'

Go here to find out more about our libraries, including their specific initialization based on our products.

Call

Cashfree has multiple integration kits that showcase how to use our libraries and APIs. Some kits are plug and play, while others require a certain amount of setup. Go through their README files to get a better understanding of how to use them.

Next steps

Read on to get started with your Cashfree integration: