@abacatepay/sdk

中文文档
3.0.0发布于 2026/10/12Apache-2.0TypeScriptES Module近 30 天下载 5251

与 AbacatePay 合并的基因组 SDK

中文使用文档
文档目录10 节
  1. 英斯特拉桑
  2. 乌索·巴西克
  3. 克里亚多·乌马·科布兰萨
  4. Procure por algons 客户端
  5. 太平洋岛国
  6. 抽查透明
  7. 调试 e 超时
  8. MRR público(信任的MRR)
  9. 版本纪念书
  10. 错误的悲剧

自动支付 SDK

官方的SDK da 免费付费 通过 临九 (原始内容存档于2013-10-12). de forma simples, segura e tollmente tipada.

欧 @abacatepay/sdk 额.. 包装版本ado de alto nível aPI da AbacatePay, focado em(英语:Focado em) 数字化, (中文(简体) ), 先输入脚本 电子 塞古兰察省。 。 。 .

AbacatePay Open Source

Você poke ver 文档 ação completa do SDK 翻译 互联网档案馆的存檔,存档日期2013-10-02 亚基。 。 。 .

英斯特拉桑

使用 com o sue 软件包管理器 偏爱托

bun add @abacatepay/sdk
# ou
pnpm add @abacatepay/sdk
# ou
npm install @abacatepay/sdk

乌索·巴西克

import { AbacatePay } from '@abacatepay/sdk';

const abacate = AbacatePay({ secret });

Nunca使用 Sua API 关键 protamente no código. Sempre 使用 variáveis 环境。 。 。 .

克里亚多·乌马·科布兰萨

const checkout = await abacate.checkouts.create({
    items: [
        {
            id: 'prod_123',
            quantity: 1,
        },
    ],
});

Procure por algons 客户端

const customers = await abacate.customers.list({
    limit: 25,
    email: 'maria',
});

太平洋岛国

Toda Listagem da v2 usa (英语) 光标{\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}反戈 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}反戈 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}再做一次 pagination: { hasMore, next, before }。 。 。 . Páler a próxima página, 羡慕语 pagination.next 科莫语name after 爱丽瑟 null. Não defencea só de hasMore。 。 。 .

let after: string | undefined;

do {
    const page = await abacate.checkouts.list({ limit: 100, after });

    if (!page.success) break;

    for (const checkout of page.data) console.log(checkout.id, checkout.status);

    after = page.pagination.next ?? undefined;
} while (after);

托达斯作为列表também aceitam before, (中文(简体) ), startDate 电子 endDate (单位:千美元)YYYY-MM-DD{\fn华文楷体\fs16\1che0e0e0}请检查date=中的日期值 (帮助).

抽查透明

(原始内容存档于2017-03-26) (英语). Ottraão é sordizado no navegador pelo AbacatePay.js, que gera um token (单位:千美元)ctok_...维罗·乌尼科,válido por 60 segundos e criado para um valor(英语:amount) (中文(简体) ). 没有seu后端 cobre com card.create重头戏 cardToken (原始内容存档于2018-09-25) (英语). permane, que você pode guardar para cobrar o mesmo bartão de novo.

import { TransparentMethod } from '@abacatepay/types/v2';

const charge = await abacate.card.create({
    amount: 15000,
    token: 'ctok_...', // ou o cardToken de uma cobrança anterior, nunca os dois
    installmentCount: 3, // opcional, de 1 a 12 (mínimo de R$10 por parcela)
    customer: {
        name: 'Maria Silva',
        email: '[email protected]',
        taxId: '529.982.247-25',
        cellphone: '11999999999',
    },
    metadata: { orderId: 'pedido_123' }, // os valores precisam ser strings
});

if (charge.success) {
    console.log(charge.data.id, charge.data.status, charge.data.cardToken);
}

// Consulte ou liste qualquer cobrança transparente (PIX, Boleto ou cartão); reembolse PIX ou cartão
await abacate.transparents.get(charge.data!.id);
await abacate.transparents.list({ method: TransparentMethod.Card });
await abacate.transparents.refund(charge.data!.id, 'Pedido cancelado');

调试 e 超时

请求 GET são repetidas automente em timeout e em moros timorários (408, 425, 429 e 5xx). (原始内容存档于2013-10-29) (英语). Requisi'es que criam, enviam ou reemplersam dinheiro (英语)POST(中文(简体) ) 第429页:se uma cobrança de cartão, saque ou PIX der timeout, ela pode ter sido processada, então conference de antes de tentar de novo. 中国植物物种信息数据库. (原始内容存档于2018-09-29). O Timeout paderão é 30 segundos.

const abacate = AbacatePay({
    secret,
    rest: { timeout: 60_000, retry: { max: 5 } },
});

MRR público(信任的MRR)

旋转 mrr.* {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}是的 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}是的 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}是的 {\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}是的 mrr_ e e sess sord não funciona nas outras rotas. 中国植物物种信息数据库. 使用 um 客户端分隔 :

const mrr = AbacatePay({ secret: process.env.ABACATEPAY_MRR_TOKEN });

const { data } = await mrr.mrr.byDay({ startDate: '2026-01-01', endDate: '2026-01-31' });

版本纪念书

O pacote e focado 100% 纳 页:1 da API (英语:import { AbacatePay } from '@abacatepay/sdk') (中文(简体) ).

一分一秒,一分一秒 /v1马斯・埃斯塔 继续(sem novos recentos) apenas para quem ainda não migrou, e emite um aviso no core ao ser usada. 互联网档案馆的存檔,存档日期2013-12-02., p.

/** @deprecated Migre para a v2 (`@abacatepay/sdk`) */
import { AbacatePay } from '@abacatepay/sdk/v1'

const client = AbacatePay({ secret });
const { data, error, success } = await client.withdraw.create({
    method: 'PIX',
    externalId: 'trx_abc123',
    ...
});

错误的悲剧

(原始内容存档于2018-03-26). Nenhuma chamada do SDK lança exceção. Toda chamada 解决 com o mesmo 格式化 { data, error, success } 普罗普里(Própria API da AbacatePay) 重整旗鼓——包容性的falhas de rede/timeout são normalizadas para sesse formato pelo @abacatepay/rest。 。 。 .

const { data, error, success } = await abacate.subscriptions.create({ ... });

if (!success) {
    console.error(error);

    return;
}

console.log(data);

飞来飞去,飞来飞去
开源,德·维尔达德.

版本与发布记录

@abacatepay/sdk 共发布 8 个版本,首次发布于 2026/01/18;过去 12 个月发布了 8 个版本。

版本发布日期距今
3.0.0latest2026/10/1224 天前
2.0.32026/07/283 个月前
2.0.22026/07/283 个月前
2.0.12026/07/283 个月前
2.0.02026/07/273 个月前
1.2.02026/01/279 个月前

关于 @abacatepay/sdk 的常见问题

@abacatepay/sdk 是什么?

与 AbacatePay 合并的基因组 SDK

如何安装 @abacatepay/sdk?

在项目目录运行 npm install @abacatepay/sdk,或使用 pnpm add / yarn add / bun add。

@abacatepay/sdk 支持 TypeScript 吗?

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

@abacatepay/sdk 支持 ESM 还是 CommonJS?

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

@abacatepay/sdk 需要什么版本的 Node.js?

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

@abacatepay/sdk 可以商用吗?

@abacatepay/sdk 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@abacatepay/sdk 的下载量有多少?

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

@abacatepay/sdk 还在维护吗?

最新版本 3.0.0 发布于 2026/10/12(24 天前);至今共发布 8 个版本,其中过去 12 个月发布了 8 个;首次发布于 2026/01/18。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。