@adonis-agora/payments

中文文档
0.25.1发布于 2026/11/02MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 4756

Billing library for AdonisJS — 18 payment gateways behind one driver contract, with a Cashier-style subscription billing layer: Billable mixin, Lucid stores, idempotent webhook processing and an optional Durable-backed dispatcher. Part of the Agora ecosys

原始使用文档
文档目录4 节
  1. Install
  2. Use
  3. Documentation
  4. License

@adonis-agora/payments

npm version npm downloads CI license

Payments and billing for AdonisJS — 18 gateways behind one driver contract, a Cashier-style subscription layer, idempotent webhook processing and invoice emission. Part of the Agora ecosystem.

Gateways: Asaas, AbacatePay, Woovi, Pagar.me, PagBank, Efí, InfinitePay, Mercado Pago · Stripe, Adyen, PayPal, Mollie, Razorpay, Square · Paddle, Lemon Squeezy, Polar, Dodo Payments.

Install

node ace add @adonis-agora/payments

Use

Configure gateways in config/payments.ts and route each payment method to one:

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' },
})

Then charge through the routed driver:

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

const payments = getPayments()

const customer = await payments.driver('pix').createCustomer({
  name: 'Jane Doe',
  email: '[email protected]',
  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

Documentation

Gateways, webhooks, subscriptions and billing, invoices, testing and production notes: https://davidecarvalho.github.io/agora/docs/payments**

License

MIT

版本与发布记录

@adonis-agora/payments 共发布 37 个版本,首次发布于 2026/08/27;过去 12 个月发布了 37 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.25.1latest2026/11/023 天前
0.25.02026/11/014 天前
0.24.02026/11/015 天前
0.23.12026/11/015 天前
0.23.02026/11/015 天前
0.22.12026/10/289 天前

关于 @adonis-agora/payments 的常见问题

@adonis-agora/payments 是什么?

Billing library for AdonisJS — 18 payment gateways behind one driver contract, with a Cashier-style subscription billing layer: Billable mixin, Lucid stores, idempotent webhook processing and an optional Durable-backed dispatcher. Part of the Agora ecosys

如何安装 @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 和提交记录判断。