# @fayz-ai/plugin-payments 中文文档

规范地址：https://npmcn.com/package/%40fayz-ai/plugin-payments/

版本：0\.9\.49
npm 元数据更新时间：2026-11-11T14:54:08.166Z
中文译文更新时间：2026-11-14T12:15:56.945Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fayz-ai/plugin-payments
原文对照：https://npmcn.com/package/%40fayz-ai/plugin-payments/?lang=original

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

- 包体积（解压后）：35.4 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2026-07-13T15:27:57.787Z
- 最新版本发布：2026-11-11T14:54:07.992Z
- 近 30 天下载量：5199（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：60（近 12 个月 60 个）

## 中文简介

\[实验\]Fayz SDK——支付插件(Pix充电供应商+网站表面)

## 安装

```sh
npm install @fayz-ai/plugin-payments
```

也可以使用：`pnpm add @fayz-ai/plugin-payments`、`yarn add @fayz-ai/plugin-payments`、`bun add @fayz-ai/plugin-payments`

## README

# @fayz-ai/plugin - 付款

> 一个Pix充电供应商(和网站支付表面),用于Fayz应用和商店前端.

[![npm](https://img.shields.io/npm/v/@fayz-ai/plugin-payments.svg)](https://www.npmjs.com/package/@fayz-ai/plugin-payments) [![license](https://img.shields.io/npm/l/@fayz-ai/plugin-payments.svg)](https://github.com/FayaLabs/fayz-sdk/blob/main/LICENSE)

**状态 :** 早期 /β — 预1.0. 船舶 一个工作 Pix **模拟** 提供者外加回放钩和公用支付表面;真正的网关(Supabase / MercadoPago)被推迟而尚未执行——应用程序运行在模拟器上直到网关被接通. API在1.0前可能会有变化.

收钱是每个商业建设都无法伪造的一件事,在巴西,这意味着Pix. `plugin-payments` 给Fayz应用程序一个单曲 `PaymentProvider` pix充电的抽象化——创建充电,获得QR / 复制版代码,调查其状态——在SDK使用的同一安全模拟/真实解析器后. 在模拟器上构建和演示今天的整个取出流量; 稍后在真正的网关中互换而不触及UI.

## 里面的东西

-   **付款提供者** —— 说 `createSafePaymentProvider()` 解析配置时的真实网关, 否则 `createMockPaymentProvider()`· ; `PaymentProvider` 编号 : `PixCharge` 编号 : `CreateChargeInput` 编号 : `ChargeStatus` 类型从 `@fayz-ai/core`
-   **工作模拟** ——生成 Pix BR 代码,在可配置延迟(默认为 6s)后自动支付,在窗口(默认为 5min)后到期,所以状态投票是现实的
-   **公共支付** (单位:千美元)`@fayz-ai/plugin-payments/public`(b) —— `createPublicPaymentPlugin(options)` 返回时 `{ manifest, Provider, paymentProvider }`附加时 `usePixCharge`, (中文(简体) ), `useChargeStatus`,以及 `PaymentProviderContext` 编号 : `usePaymentContext`
-   **递延实际供应商** —— 说 `createSupabasePaymentProvider()` 是一个被扔到Supabase/MercadoPago网关登陆的树枝

## 安装

```bash
npm install @fayz-ai/plugin-payments
```

运行时间 : `@fayz-ai/core`编辑 `./public` 副路径额外需求 `react` 编号 : `react-dom`。 。 。 .

## 使用量

```ts
// Headless: a charge provider anywhere
import { createSafePaymentProvider } from '@fayz-ai/plugin-payments'

const payments = createSafePaymentProvider()
const charge = await payments.createCharge({ amount: 49.9, currency: 'BRL', orderId: 'abc' })
// charge.pixCopyPaste, charge.pixQrCode, then poll payments.getChargeStatus(charge.chargeId)
```

```tsx
// Website surface: the payment plugin bundle
import { createPublicPaymentPlugin } from '@fayz-ai/plugin-payments/public'

const paymentPlugin = createPublicPaymentPlugin({ currency: 'BRL' })
// wrap your checkout tree in <paymentPlugin.Provider> and use usePixCharge()/useChargeStatus()
```

## 费兹SDK的一部分

财相接相. 将仓库前置/检查出厂面和对装入 `@fayz-ai/plugin-orders` 财务报告和审定财务报表 `@fayz-ai/plugin-shop`; 边作曲 `@fayz-ai/plugin-blog` 网站正在建设.

## 常见问题

### @fayz-ai/plugin-payments 是什么？

\[实验\]Fayz SDK——支付插件\(Pix充电供应商\+网站表面\)

### 如何安装 @fayz-ai/plugin-payments？

在项目目录运行 npm install @fayz-ai/plugin-payments，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0 \|\| ^19\.0\.0）、react-dom（^18\.0\.0 \|\| ^19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @fayz-ai/plugin-payments 支持 TypeScript 吗？

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

### @fayz-ai/plugin-payments 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @fayz-ai/plugin-payments 可以商用吗？

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

### @fayz-ai/plugin-payments 的下载量有多少？

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

### @fayz-ai/plugin-payments 还在维护吗？

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