# @adonis-agora/payments 中文文档

规范地址：https://npmcn.com/package/%40adonis-agora/payments/

版本：0\.25\.1
npm 元数据更新时间：2026-11-02T13:53:09.355Z
中文译文更新时间：2026-11-06T05:26:41.482Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40adonis-agora/payments
原文对照：https://npmcn.com/package/%40adonis-agora/payments/?lang=original
项目主页：https://davidecarvalho.github.io/agora/docs/payments
源码仓库：https://github.com/DavideCarvalho/adonis-agora-payments

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

- 包体积（解压后）：5.1 MB，453 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：0 个
- peer 依赖：stripe ^17\.0\.0 \|\| ^18\.0\.0 \|\| ^19\.0\.0 \|\| ^20\.0\.0 \|\| ^21\.0\.0 \|\| ^22\.0\.0 \|\| ^23\.0\.0，@adonisjs/core ^7\.3\.0，@adonisjs/lucid ^22\.4\.0，@woovi/node-sdk ^1\.0\.0，@adonis-agora/durable \>=0\.1\.0 \<1\.0\.0
- 首次发布：2026-08-26T22:51:57.323Z
- 最新版本发布：2026-11-02T13:53:09.006Z
- 近 30 天下载量：4756（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 37 个）

## 中文简介

AdonisJS的账单库——一个司机合同后面的18个付款网关,有一个出纳式的订阅收费层: Billable mixin, Lucid stores, idepotent webhook 处理和可选的持久支持调度器. 阿戈拉生态学的一部分

## 安装

```sh
npm install @adonis-agora/payments
```

也可以使用：`pnpm add @adonis-agora/payments`、`yarn add @adonis-agora/payments`、`bun add @adonis-agora/payments`

## README

# `@adonis-agora/payments`

[![npm version](https://img.shields.io/npm/v/@adonis-agora/payments)](https://www.npmjs.com/package/@adonis-agora/payments) [![npm downloads](https://img.shields.io/npm/dm/@adonis-agora/payments)](https://www.npmjs.com/package/@adonis-agora/payments) [![CI](https://github.com/DavideCarvalho/adonis-agora-payments/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/DavideCarvalho/adonis-agora-payments/actions/workflows/ci.yml) [![license](https://img.shields.io/npm/l/@adonis-agora/payments)](https://www.npmjs.com/package/@adonis-agora/payments)

> 付款和账单 **阿多尼斯·贾克** - 一个司机合同背后的18个网关,a 出纳式订阅分层,一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元一元 部分 页:1 [阿戈拉语Name](https://davidecarvalho.github.io/agora/) 生态系统.

**网关 :** Asaas、AbacatePay、Woovi、Pagar.me、PagBank、Efí、InfinitePay、Mercado Pago) 花脸、Adyen、PayPal、Mollie、Razorpay、Square-Paddle、Lemon Squeezy、极地、多多付款.

## 安装

```sh
node ace add @adonis-agora/payments
```

## 使用

配置网关 `config/payments.ts` 并且将每种支付方法都路径为:

```ts
import env from '#start/env'
import { defineConfig, payments } from '@adonis-agora/payments'

export default defineConfig({
  default: 'asaas',
  providers: {
    asaas: payments.asaas({
      apiKey: env.get('PAYMENTS_ASAAS_KEY'),
      webhookToken: env.get('PAYMENTS_ASAAS_WEBHOOK_TOKEN'),
    }),
  },
  methods: { pix: 'asaas', credit_card: 'asaas' },
})
```

然后通过路由驱动器充电:

```ts
import { getPayments } from '@adonis-agora/payments/services/main'

const payments = getPayments()

const customer = await payments.driver('pix').createCustomer({
  name: 'Jane Doe',
  email: 'jane@example.com',
  taxId: '123.456.789-00',
})

const payment = await payments.driver('pix').charge({
  customerId: customer.id,
  amount: 1990, // integer cents: R$ 19,90
  externalReference: order.id, // your own row; comes back on every webhook for this charge
})

// payment.pixCode → the copy-paste BR code to show the customer
```

## 文档

网关、网路、订阅和收费、发票、测试和生产说明: **[https://davidecarvalho.github.io/agora/docs/paying\* 互联网档案馆的存檔,存档日期2013-12-11](https://davidecarvalho.github.io/agora/docs/payments*)\* 联合国**

## 许可证

麻省理工学院

## 常见问题

### @adonis-agora/payments 是什么？

AdonisJS的账单库——一个司机合同后面的18个付款网关,有一个出纳式的订阅收费层: Billable mixin, Lucid stores, idepotent webhook 处理和可选的持久支持调度器\. 阿戈拉生态学的一部分

### 如何安装 @adonis-agora/payments？

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

### @adonis-agora/payments 支持 TypeScript 吗？

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

### @adonis-agora/payments 支持 ESM 还是 CommonJS？

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

### @adonis-agora/payments 需要什么版本的 Node\.js？

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

### @adonis-agora/payments 可以商用吗？

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

### @adonis-agora/payments 的下载量有多少？

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

### @adonis-agora/payments 还在维护吗？

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