@laranex/myanmar-payments
v4.0.0-dev.18
Published
Node.js SDK for Myanmar payment gateways: KBZ Pay, Wave Pay, Wave Pay Mini App, AYA Pay, Yoma MMQR and CyberSource. Typed requests and results, exact amounts, no runtime dependencies.
Maintainers
Readme
Node Myanmar Payments
Node.js SDK for Myanmar payment gateways: KBZ Pay, Wave Pay, Wave Pay Mini App, AYA Pay, Yoma MMQR and CyberSource. Typed requests and results, exact amounts, no runtime dependencies. Built for humans and AI agents.
Every Myanmar payment gateway signs its requests and callbacks its own way, reports its own status codes and has its own rules for amounts. Node Myanmar Payments handles all of that behind one typed API for Node.js and any framework: build the payment data, start the payment, then verify the callback the gateway sends back.
Why Node Myanmar Payments
- Six gateways, one pattern. KBZ Pay (PWA, QR and in-app), Wave Pay, Wave Pay Mini App, AYA Pay, Yoma MMQR and CyberSource, each with its own class and the same three steps.
- One typed result per flow.
RedirectPayment,FormPayment,QrPayment,AppPaymentorMiniAppPaymentholds exactly what the next step needs: a URL to redirect to, an auto-submitting form, a QR code, the signed order for the KBZ Pay mobile SDK or the signed payment for Wave's mini app SDK. See Payment Flows. - Exact amounts, checked against each gateway's rules. An
Amountis kept as decimal text, takes abigintof any size and never passes through a fractionalnumber. Decimals, currency and limits follow each gateway's official documentation and are checked before any request is sent. See Amounts. - Verified callbacks.
handleCallback()checks the gateway's signature without a network call, maps its status onto onePaymentStatusand gives you the acknowledgement the gateway expects. When a callback is late, ask KBZ Pay, AYA Pay or Yoma MMQR withstatus(). See Callbacks & Status. - Errors that say what went wrong. A missing setting, an invalid field, a gateway error and a bad signature each throw their own error class, with a message that names the setting, the field or the gateway's code.
- No runtime dependencies. Requests go through the global
fetch(or anyHttpClientyou pass) and signing usesnode:crypto. ES modules and CommonJS both ship with TypeScript types, and callbacks are read from Node's request or a webRequest, so Express, Fastify, Next.js and Hono all work. NestJS apps use NestJS Myanmar Payments, which wraps this package. - Same behavior in every language. The PHP, Go, Node.js and Python SDKs pass one shared set of test vectors for signing and callback verification, and read the same environment variables, so one
.envfile and one token cache serve them all. - Nothing stored for you. The package keeps no tables and no webhook log. Handling Webhooks shows the recommended flow as code you copy: verify, store, acknowledge, then process each call once.
- Easy to test. Every gateway call goes through the
fetchor client you pass, so your tests fake the responses, replay signed callbacks and never touch the network. See Testing.
Installation
Requires Node.js 20+. No runtime dependencies: it sends the gateway requests with the global
fetchand signs withnode:crypto.
npm install @laranex/myanmar-paymentspnpm add @laranex/myanmar-paymentsyarn add @laranex/myanmar-paymentsDocumentation
The full documentation lives at laranex.vercel.app/node-myanmar-payments:
- Introduction: why the package exists and what it covers
- Installation: requirements, install command and a quick start
- AI Agent Skill: the skill that teaches coding agents to use the package
- Configuration: credentials, environment variables, endpoints, UAT, HTTP client and token cache
- Amounts: exact amounts and each gateway's amount rules
- Payment Flows: redirect, form, QR and in-app payments
- Callbacks & Status: verified callbacks, payment statuses and status checks
- Handling Webhooks: the recommended verify, store, acknowledge, process-once flow
- Framework Integration: Express, Fastify, Next.js and Hono
- Testing: faking gateway calls and replaying signed callbacks in your tests
- KBZ Pay: PWA redirect, QR and in-app payments, status checks and callbacks
- Wave Pay: redirect payments with line items and verified callbacks
- Wave Pay Mini App: access tokens, signed payment payloads for Wave's JavaScript SDK and verified callbacks
- AYA Pay: hosted checkout for AYA Pay, other wallets and cards, with status checks
- Yoma MMQR: QR images, QR renewal, status checks and verified callbacks
- CyberSource: Secure Acceptance card payments through a signed hosted checkout form
- Results: every property of the payment result types
- PaymentCallback & Status: callbacks, status results, acknowledgements and the PaymentStatus values
- Errors: validation, API, signature and configuration errors
License
MIT. See LICENSE.
