@bayarkit/core

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

One interface for Malaysian payment gateways, and a checked way to confirm a payment.

原始使用文档
文档目录3 节
  1. Need help installing?
  2. Bahasa Melayu
  3. Perlukan bantuan memasang?

@bayarkit/core

The interface every bayarkit gateway adapter implements, and confirmPayment: the one path to marking an order paid. Zero runtime dependencies. Bahasa Melayu

npm install @bayarkit/core @bayarkit/<gateway>
  • confirmPayment(gateway, callback, { reference, amount }) — 1. the callback signature must verify; 2. the gateway is asked again (a valid signature can be replayed); 3. its own record must say paid, for this reference, this exact amount (integer sen) and currency. Returns { ok: true, payment } or { ok: false, reason, detail } with reason one of invalid_signature, not_paid, mismatch, gateway_error; it never throws.
  • readCallback(request) — a callback from a Web-standard Request: fields (JSON, url-encoded or multipart) plus the raw body and headers, so both body-signed and header-signed gateways verify. callbackFromFields(fields) for frameworks that already parsed the body.
  • checkoutResponse(payment, label?) — a 303 redirect, or an escaped self-submitting POST page for gateways that take a form; autoPostHtml is the page alone.
  • toSen / toRinggit — exact decimal conversion, never through a float.
  • GatewayError — messages quote the gateway's answer only, never a key.

Adapters: @bayarkit/toyyibpay, @bayarkit/bayarcash, @bayarkit/billplz, @bayarkit/chip, @bayarkit/stripe, @bayarkit/senangpay, @bayarkit/ipay88, @bayarkit/fiuu, @bayarkit/2c2p, @bayarkit/curlec, @bayarkit/hitpay, @bayarkit/gkash, @bayarkit/xendit, @bayarkit/eghl, @bayarkit/paddle, @bayarkit/paypal.

Need help installing?

If you would rather not wire up a payment gateway yourself, Sasa Teguh, the studio that maintains bayarkit, can install it on your site or app and test it against the gateway sandbox before you go live.

Contact page · Email: [email protected] · WhatsApp: 017-762 9379

Bahasa Melayu

Antara muka yang dilaksanakan oleh setiap adapter bayarkit, dan confirmPayment: satu-satunya jalan untuk menanda pesanan dibayar. Sifar kebergantungan masa jalan.

npm install @bayarkit/core @bayarkit/<gateway>
  • confirmPayment(gateway, callback, { reference, amount }) — 1. tandatangan callback mesti sah; 2. gateway ditanya semula (tandatangan yang sah boleh diulang main); 3. rekod gateway sendiri mesti kata dibayar, untuk rujukan ini, jumlah tepat ini (sen integer) dan mata wang ini. Memulangkan { ok: true, payment } atau { ok: false, reason, detail } dengan reason salah satu daripada invalid_signature, not_paid, mismatch, gateway_error; ia tidak pernah melempar ralat.
  • readCallback(request) — callback daripada Request piawai web: medan (JSON, url-encoded atau multipart) serta badan mentah dan pengepala, supaya gateway yang menandatangani badan dan yang menandatangani pengepala kedua-duanya dapat disahkan. callbackFromFields(fields) untuk rangka kerja yang sudah menghurai badan.
  • checkoutResponse(payment, label?) — redirect 303, atau halaman POST yang dihantar sendiri (di-escape) untuk gateway yang menerima borang; autoPostHtml ialah halaman itu sahaja.
  • toSen / toRinggit — penukaran perpuluhan tepat, tidak pernah melalui float.
  • GatewayError — mesej memetik jawapan gateway sahaja, tidak pernah kunci.

Adapter: @bayarkit/toyyibpay, @bayarkit/bayarcash, @bayarkit/billplz, @bayarkit/chip, @bayarkit/stripe, @bayarkit/senangpay, @bayarkit/ipay88, @bayarkit/fiuu, @bayarkit/2c2p, @bayarkit/curlec, @bayarkit/hitpay, @bayarkit/gkash, @bayarkit/xendit, @bayarkit/eghl, @bayarkit/paddle, @bayarkit/paypal.

Dokumentasi penuh: README.ms.md.

Perlukan bantuan memasang?

Jika anda tidak mahu menyambung gateway pembayaran sendiri, Sasa Teguh, studio yang menyelenggara bayarkit, boleh memasangnya di laman atau aplikasi anda dan mengujinya pada sandbox gateway sebelum anda mula menerima bayaran.

Halaman hubungi · E-mel: [email protected] · WhatsApp: 017-762 9379

MIT © Muhammad Aiman

版本与发布记录

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

版本发布日期距今
0.3.1latest2026/11/071 天前
0.3.02026/11/044 天前
0.2.22026/10/2811 天前
0.2.12026/10/2811 天前
0.2.02026/10/2811 天前
0.1.02026/10/2811 天前

关于 @bayarkit/core 的常见问题

@bayarkit/core 是什么?

One interface for Malaysian payment gateways, and a checked way to confirm a payment.

如何安装 @bayarkit/core?

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

@bayarkit/core 支持 TypeScript 吗?

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

@bayarkit/core 支持 ESM 还是 CommonJS?

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

@bayarkit/core 需要什么版本的 Node.js?

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

@bayarkit/core 可以商用吗?

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

@bayarkit/core 的下载量有多少?

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

@bayarkit/core 还在维护吗?

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