# @blindpay/node 中文文档

规范地址：https://npmcn.com/package/%40blindpay/node/

版本：6\.0\.0
npm 元数据更新时间：2026-10-28T00:49:20.546Z
中文译文更新时间：2026-11-08T06:48:29.414Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40blindpay/node
原文对照：https://npmcn.com/package/%40blindpay/node/?lang=original
项目主页：https://blindpay.com/
源码仓库：https://github.com/blindpaylabs/blindpay-node

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

- 包体积（解压后）：17.6 MB，217 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.\*
- 运行依赖：1 个
- peer 依赖：@types/node \>=18\.x\.x
- 首次发布：2025-09-27T19:42:40.938Z
- 最新版本发布：2026-10-28T00:49:20.173Z
- 近 30 天下载量：3089（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 32 个）

## 中文简介

Blindpay API的官方节点.js SDK - 全球支付的稳定币API

## 安装

```sh
npm install @blindpay/node
```

也可以使用：`pnpm add @blindpay/node`、`yarn add @blindpay/node`、`bun add @blindpay/node`

## README

# 盲页节点.js SDK

官方节点Js SDK为 [盲页](https://blindpay.com/) - 全球支付稳定币API.

## 安装

```bash
npm install @blindpay/node
# or
yarn add @blindpay/node
# or
pnpm add @blindpay/node
# or
bun add @blindpay/node
```

## 认证

要启动, 您既需要您的 API 密钥, 也需要您的实例 ID, 您可以从 BlindPay 仪表板获取您的 API 密钥和实例 ID [https://app.blindpay.com/instances/{instanceId}/api-keys (英语)](https://app.blindpay.com/instances/%7BinstanceId%7D/api-keys)

```typescript
import { BlindPay } from '@blindpay/node';

const blindpay = new BlindPay({
    apiKey: 'your-api-key-here',
    instanceId: 'your-instance-id-here'
  })
```

> \[注\]  
> 所有 api 呼叫将使用提供的 api 密钥和实例 ID

## 快速启动

### 检查可用的栏杆

```typescript
async function getAvailableRails() {
    const blindpay = new BlindPay({
      apiKey: 'your-api-key-here',
      instanceId: 'your-instance-id-here'
    });

    const { data, error } = await blindpay.available.getRails();
    
    if (error) {
        throw new Error(error.message)
    }
    
    console.log('Rails: ', data)
 }

 getAvailableRails()
```

## 答复格式

所有API方法返回一致的响应格式

### 成功对策

```typescript
{
  data: /* your data */ ,
  error: null
}
```

### 错误反应

```typescript
{
  data: null,
  error: {
    message: "Error message"
  }
}
```

## 处理错误

此 SDK 使用一致的错误处理模式 。 总是检查错误 :

```typescript
const { data, error } = await blindpay.payins.list();

if (error) {
  // error.code is a stable code (e.g. PAYOUTS_INSUFFICIENT_BALANCE); error.description is
  // safe to show to end users; include error.trace_id when contacting support.
  console.error('API Error:', error.code ?? error.message);
  return;
}

console.log('Success:', data); // fully typed
```

## 安全复试(能力)

创建、更新或删除某种东西的每一种方法都需要一个可选的最后参数。 通过一个 `idempotencyKey` 并用相同的密钥和相同的输入重试可以重放原始的响应而不是两次行动,例如,超时让您无法确定是否创建了付款。 钥匙保存24小时.

```typescript
import { randomUUID } from 'node:crypto';

const idempotencyKey = randomUUID(); // reuse it only to retry this same call

const { data, error } = await blindpay.payouts.createEvm(
  { quote_id: 'qu_000000000000', sender_wallet_address: '0x...' },
  { idempotencyKey }
);
```

## 网络呼号

`constructWebhookEvent` 验证Svix的签名并返回其输入的有效载荷 `webhook_event`它会扔出一个 `BlindPayError` 当验证失败时。 传出生请求正文,不是重序对象.

```typescript
const event = blindpay.constructWebhookEvent({
  secret: process.env.BLINDPAY_WEBHOOK_SECRET as string,
  headers: {
    id: req.headers['svix-id'] as string,
    timestamp: req.headers['svix-timestamp'] as string,
    signature: req.headers['svix-signature'] as string,
  },
  payload: rawBody,
});

switch (event.webhook_event) {
  case 'tos.accept':
    console.log('ToS accepted:', event.tos_id);
    break;
  case 'customer.update':
    console.log('KYC status:', event.kyc_status);
    break;
}
```

`verifyWebhookSignature` 仅需要布尔值时仍然可用.

详细的API文件,访问:

-   [BlindPay API 文档](https://blindpay.com/docs/getting-started/overview)
-   [API 参考](https://api.blindpay.com/reference)

## 支助

-   电子邮件: [alves@blindpay.com (英语)](mailto:alves@blindpay.com)
-   问题: [GitHub 问题](https://github.com/blindpaylabs/blindpay-node/issues)

## 许可证

这个项目根据麻省理工学院许可证颁发——见 [自由主义](https://npmcn.com/package/%40blindpay/node/LICENSE) 详细文件.

由美国制造 [盲页](https://blindpay.com/) 团队

## 常见问题

### @blindpay/node 是什么？

Blindpay API的官方节点\.js SDK - 全球支付的稳定币API

### 如何安装 @blindpay/node？

在项目目录运行 npm install @blindpay/node，或使用 pnpm add / yarn add / bun add。

### @blindpay/node 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @blindpay/node 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @blindpay/node 需要什么版本的 Node\.js？

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

### @blindpay/node 可以商用吗？

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

### @blindpay/node 的下载量有多少？

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

### @blindpay/node 还在维护吗？

最新版本 6\.0\.0 发布于 2026/10/28（11 天前）；至今共发布 44 个版本，其中过去 12 个月发布了 32 个；首次发布于 2025/09/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。