# @cashfreepayments/cashfree-sdk 中文文档

规范地址：https://npmcn.com/package/%40cashfreepayments/cashfree-sdk/

版本：0\.1\.7
npm 元数据更新时间：2026-01-08T12:35:56.915Z
中文译文更新时间：2026-11-09T17:25:38.549Z
软件包许可：ISC

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cashfreepayments/cashfree-sdk
原文对照：https://npmcn.com/package/%40cashfreepayments/cashfree-sdk/?lang=original
项目主页：https://github.com/cashfree/cashfree-sdk-nodejs#readme
源码仓库：https://github.com/cashfree/cashfree-sdk-nodejs

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：70.9 kB，27 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=10\.9\.0
- 运行依赖：0 个
- 首次发布：2021-09-28T16:26:14.142Z
- 最新版本发布：2021-09-28T16:40:56.539Z
- 近 30 天下载量：2128（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

现金免费 API 的官方节点 SDK

## 安装

```sh
npm install @cashfreepayments/cashfree-sdk
```

也可以使用：`pnpm add @cashfreepayments/cashfree-sdk`、`yarn add @cashfreepayments/cashfree-sdk`、`bun add @cashfreepayments/cashfree-sdk`

## README

无现金库在 **贝塔**这项工作正在进行中,我们正在不断努力改进各方面的工作。 它作为学习辅助工具以及API集成商的样板包发行.

> 这是无现金公司不建议直接用于生产代码。 请将任何错误报告至 Cashree [技术支持@ cashfree.com](mailto:techsupport@cashfree.com)。 。 。 .

# 现金免费sdk-nodejs

JavaScript的官方无现金SDK,可用于Node.js后端. 节点版本10.9.0被用于此SDK.

在Node.js为JavaScript快速开始使用无现金SDK. SDK通过提供JavaScript对象用于无现金服务,包括Payouts,Paying Gateway,Marketplace和Autocolbox等,帮助消除了编码的复杂性. 可下载的单一软件包包括Cashree JavaScript库和文件.

### API 文档

请参看 [无现金文件](https://docs.cashfree.com/docs/) 用于完整的API参考.

## 安装

### 在节点.js

为Node.js安装无现金SDK的首选方法是使用 [无](http://npmjs.org/) 节点.js的软件包管理器。 简单地将以下输入终端窗口:

```sh
npm i @cashfreepayments/cashfree-sdk
```

## 开始

### 先决条件

-   A 类 [无现金商业账户](https://merchant.cashfree.com/merchant/sign-up)
-   不同产品的API密钥. 你可以从你的Dashboard上生成它们

### IP 白名单和动态IP

你的IP必须被列入白名单才能打出Cashree的服务器. 或者如果您有动态IP,请在init方法期间通过公钥参数如下所示. 欲了解更多情况,请前往 [这里](https://dev.cashfree.com/development/quickstart#ip-whitelisting)。 。 。 .

## 使用量

### 付款

软件包需要配置在您的账户的密钥中, 该密钥可以在您的 Cashfree Dashboard 中可用 .

###### 如果是静态IP( 您的IP 已白名单)

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

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

###### 如果有动态 IP, 您需要公钥来生成签名( 由 sdk 自己完成)

```js
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)"
});
```

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `env` | `TEST` | 环境有待初始化。 可以设定为 `TEST` 或者说 `PRODUCTION` |
| `clientId` | \`\` | `clientId` 可以在无现金仪表板上生成. |
| `clientSecret` | \`\` | `clientSecret` 在生成的同时找到 `ClientId`。 。 。 . |
| `pathToPublicKey` | \`\` | 指定您的路径 `.pem` 公钥文件或使用 `publicKey` 帕拉姆 把钥匙递过去. |
| `publicKey` | \`\` | 将您的公钥传递到此参数作为替代 `pathToPublicKey`。 。 。 . |

## WebHook 验证

校验从 Cashreaty 收到的不同事件的 Webhook, 并仅在返回时接受它 `true`。 。 。 .

### 使用量

将接收的网钩与有效载荷类型一起通过.

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

### 使用承诺

每种方法都返回一个可以使用的许诺:

```js
payoutsInstance.beneficiary
  .add({
    beneId: 'JOHN18012',
    name: 'john doe',
    email: 'johndoe@cashfree.com',
    phone: '9876543210',
    bankAccount: '00001111222233',
    ifsc: 'HDFC0000001',
    address1: 'ABC Street',
    city: 'Bangalore',
    state: 'Karnataka',
    pincode: '560001',
  })
  .then(function (response) {
    console.log(response);
  });
```

### 使用 Async/ 等待

```js
async function addBeneficiary() {
  try {
    const response = await payoutsInstance.beneficiary.add({
      beneId: 'JOHN18012',
      name: 'john doe',
      email: 'johndoe@cashfree.com',
      phone: '9876543210',
      bankAccount: '00001111222233',
      ifsc: 'HDFC0000001',
      address1: 'ABC Street',
      city: 'Bangalore',
      state: 'Karnataka',
      pincode: '560001',
    });

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

-   有关API的更多信息请访问 [付款](https://npmcn.com/package/%40cashfreepayments/cashfree-sdk/lib/payouts)。 。 。 .
-   完整清单 [APIs 密码](https://docs.cashfree.com/docs/payout/guide/#fetch-beneficiary-id)

### 支付网关

-   [文档和API](https://npmcn.com/package/%40cashfreepayments/cashfree-sdk/lib/pg/README.md)

### 开始

-   #### 市场位置
    
-   #### 自动收集

## 常见问题

### @cashfreepayments/cashfree-sdk 是什么？

现金免费 API 的官方节点 SDK注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @cashfreepayments/cashfree-sdk？

在项目目录运行 npm install @cashfreepayments/cashfree-sdk，或使用 pnpm add / yarn add / bun add。

### @cashfreepayments/cashfree-sdk 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cashfreepayments\_\_cashfree-sdk 是否存在。

### @cashfreepayments/cashfree-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cashfreepayments/cashfree-sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=10\.9\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cashfreepayments/cashfree-sdk 可以商用吗？

@cashfreepayments/cashfree-sdk 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cashfreepayments/cashfree-sdk 的下载量有多少？

根据 npm 官方下载统计，@cashfreepayments/cashfree-sdk 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,128 次，日均约 71 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cashfreepayments/cashfree-sdk 还在维护吗？

最新版本 0\.1\.7 发布于 2021/09/29（5 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/09/29。作者已将其标记为弃用，新项目建议寻找替代方案。