Cashfree PG Node SDK

The Cashfree PG Node SDK offers a convenient solution to access Cashfree PG APIs from a server-side JavaScript applications.

Documentation

Cashfree's PG API Documentation - https://docs.cashfree.com/reference/pg-new-apis-endpoint

Learn and understand payment gateway workflows at Cashfree Payments here

Try out our interactive guides at Cashfree Dev Studio !

Getting Started

Installation

1npm i cashfree-pg

Configuration

Version >=5

1import { Cashfree } from "cashfree-pg"; 
2
3var cashfree = new Cashfree(Cashfree.SANDBOX, "<x-client-id>", "<x-client-secret>")

Generate your API keys (x-client-id , x-client-secret) from Cashfree Merchant Dashboard

Basic Usage

Create Order

1var request = {
2    "order_amount": 1,
3    "order_currency": "INR",
4    "order_id": "order_34692745",
5    "customer_details": {
6        "customer_id": "walterwNrcMi",
7        "customer_phone": "9999999999"
8    },
9    "order_meta": {
10        "return_url": "https://www.cashfree.com/devstudio/preview/pg/web/checkout?order_id={order_id}"
11    }
12};
13Cashfree.PGCreateOrder(request).then((response) => {
14    console.log('Order Created successfully:',response.data)
15}).catch((error) => {
16    console.error('Error:', error.response.data.message);
17});

Get Order

1Cashfree.PGFetchOrder("<order_id>").then((response) => {
2    console.log('Order fetched successfully:', response.data);
3}).catch((error) => {
4    console.error('Error:', error.response.data.message);
5});

Version <5

1import { Cashfree } from "cashfree-pg"; 
2
3Cashfree.XClientId = "<x-client-id>";
4Cashfree.XClientSecret = "<x-client-secret>";
5Cashfree.XEnvironment = Cashfree.Environment.SANDBOX;

Generate your API keys (x-client-id , x-client-secret) from Cashfree Merchant Dashboard

Basic Usage

Create Order

1var request = {
2    "order_amount": 1,
3    "order_currency": "INR",
4    "order_id": "order_34692745",
5    "customer_details": {
6        "customer_id": "walterwNrcMi",
7        "customer_phone": "9999999999"
8    },
9    "order_meta": {
10        "return_url": "https://www.cashfree.com/devstudio/preview/pg/web/checkout?order_id={order_id}"
11    }
12};
13Cashfree.PGCreateOrder("2023-08-01", request).then((response) => {
14    console.log('Order Created successfully:',response.data)
15}).catch((error) => {
16    console.error('Error:', error.response.data.message);
17});

Get Order

1Cashfree.PGFetchOrder("2023-08-01", "<order_id>").then((response) => {
2    console.log('Order fetched successfully:', response.data);
3}).catch((error) => {
4    console.error('Error:', error.response.data.message);
5});

Validate Webhook

1app.post('/webhook', function (req, res) {
2    try {
3        Cashfree.PGVerifyWebhookSignature(req.headers["x-webhook-signature"], req.rawBody, req.headers["x-webhook-timestamp"]))
4    } catch (err) {
5        console.log(err.message)
6    }
7})

Supported Resources

• Order

• Payment

• Refund

• Token Vault

• Eligiblity

• PaymentLink

• Settlements

• Offers

• Reconciliation

Licence

Apache Licensed. See LICENSE.md for more details