{"id":46140798,"url":"https://github.com/joselay/aba-payway","last_synced_at":"2026-03-07T11:01:08.471Z","repository":{"id":341351394,"uuid":"1169739828","full_name":"Joselay/aba-payway","owner":"Joselay","description":"TypeScript SDK for ABA PayWay — Cambodia's payment gateway. Zero dependencies, full TypeScript support, ESM/CJS.","archived":false,"fork":false,"pushed_at":"2026-03-03T14:43:23.000Z","size":196,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-04T12:28:50.975Z","etag":null,"topics":["aba","aba-bank","aba-payway","cambodia","checkout","fintech","khqr","nodejs","payment-gateway","payway","qr-payment","sdk","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/aba-payway","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Joselay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-01T06:06:41.000Z","updated_at":"2026-03-03T14:43:27.000Z","dependencies_parsed_at":"2026-03-05T09:00:45.854Z","dependency_job_id":null,"html_url":"https://github.com/Joselay/aba-payway","commit_stats":null,"previous_names":["joselay/aba-payway"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/Joselay/aba-payway","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joselay%2Faba-payway","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joselay%2Faba-payway/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joselay%2Faba-payway/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joselay%2Faba-payway/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Joselay","download_url":"https://codeload.github.com/Joselay/aba-payway/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Joselay%2Faba-payway/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30117467,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T08:19:04.902Z","status":"ssl_error","status_checked_at":"2026-03-05T08:17:37.148Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aba","aba-bank","aba-payway","cambodia","checkout","fintech","khqr","nodejs","payment-gateway","payway","qr-payment","sdk","typescript"],"created_at":"2026-03-02T06:07:09.595Z","updated_at":"2026-03-05T09:00:51.795Z","avatar_url":"https://github.com/Joselay.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aba-payway\n\n[![npm version](https://img.shields.io/npm/v/aba-payway)](https://www.npmjs.com/package/aba-payway)\n[![CI](https://github.com/Joselay/aba-payway/actions/workflows/ci.yml/badge.svg)](https://github.com/Joselay/aba-payway/actions)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n[![npm downloads](https://img.shields.io/npm/dm/aba-payway)](https://www.npmjs.com/package/aba-payway)\n[![Zero Dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)](https://www.npmjs.com/package/aba-payway)\n\nType-safe TypeScript SDK for [ABA PayWay](https://www.payway.com.kh/) — Cambodia's #1 payment gateway.\n\n\u003e **Unofficial community SDK.** Not affiliated with ABA Bank.\n\n## Why aba-payway?\n\nABA PayWay's official SDK is a raw REST API with no official Node.js/TypeScript client. That means you're left dealing with manual HMAC hashing, snake_case field ordering, base64 encoding, and zero type safety. This SDK handles all of that for you.\n\n| | `aba-payway` | Rolling your own |\n|---|---|---|\n| Type safety | Full TypeScript with strict types | None — guess the field names |\n| Hash computation | Automatic, correct field ordering | Manual HMAC-SHA512, easy to get wrong |\n| Base64 encoding | Automatic for items, URLs, payout | Do it yourself, hope you didn't miss one |\n| Dependencies | **Zero** — only Node.js built-ins | Probably `axios` + `crypto-js` + glue code |\n| API coverage | 15+ methods | Build each one from scratch |\n| Runtime support | Node.js, Bun, Deno, Cloudflare Workers | Whatever you tested |\n\n## Features\n\n- **Zero runtime dependencies** — uses Node.js built-in `crypto` and native `fetch`\n- **Full TypeScript support** with strict types and autocomplete\n- **Dual ESM + CJS output** — works everywhere\n- **15+ API methods** — checkout, QR payments, refunds, pre-auth, payouts, and more\n- **Runs anywhere** — Node.js, Bun, Deno, Next.js, Express, Hono, Cloudflare Workers\n- **Tested against ABA's sandbox** — not just unit tests, real API integration tests\n\n## Installation\n\n```bash\n# bun\nbun add aba-payway\n\n# npm\nnpm install aba-payway\n\n# pnpm\npnpm add aba-payway\n```\n\n## Quick Start\n\n```typescript\nimport { PayWay } from 'aba-payway'\n\nconst payway = new PayWay({\n  merchantId: 'your_merchant_id',\n  apiKey: 'your_api_key',\n})\n\n// Generate checkout params (synchronous — no API call)\nconst params = payway.createTransaction({\n  transactionId: 'order-001',\n  amount: 10.00,\n  items: 'Product A',\n  returnUrl: 'https://yoursite.com/callback',\n})\n\n// Send `params` to your frontend, populate ABA's hidden form,\n// and call AbaPayway.checkout() to open the payment dialog.\n// See examples/ for more snippets and framework integrations.\n```\n\n## API Reference\n\n### `new PayWay(config)`\n\n| Parameter | Type | Required | Default | Description |\n|---|---|---|---|---|\n| `merchantId` | `string` | Yes | — | Your ABA PayWay merchant ID |\n| `apiKey` | `string` | Yes | — | Your ABA PayWay API key |\n| `environment` | `'sandbox' \\| 'production'` | No | `'sandbox'` | Target environment |\n| `baseUrl` | `string` | No | — | Override the base URL directly (takes priority over `environment`) |\n\n### `payway.createTransaction(options)`\n\nGenerate checkout parameters for a payment. **Synchronous** — computes the HMAC hash and returns form params without making any API calls.\n\nReturns `CheckoutParams` — snake_case form parameters to submit via ABA's checkout JS SDK.\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| `transactionId` | `string` | Yes | Unique transaction ID (max 20 chars) |\n| `amount` | `number` | Yes | Purchase amount |\n| `currency` | `'USD' \\| 'KHR'` | No | Default: `'USD'` |\n| `paymentOption` | `PaymentOption` | No | `cards`, `abapay_khqr`, `abapay_khqr_deeplink`, `alipay`, `wechat`, `google_pay` |\n| `firstName` | `string` | No | Buyer's first name |\n| `lastName` | `string` | No | Buyer's last name |\n| `email` | `string` | No | Buyer's email |\n| `phone` | `string` | No | Buyer's phone |\n| `items` | `string \\| ItemEntry[]` | No | Item description — string or `{ name, quantity, price }[]` |\n| `returnUrl` | `string` | No | Callback URL for payment completion |\n| `cancelUrl` | `string` | No | Redirect URL when user closes payment |\n| `continueSuccessUrl` | `string` | No | Redirect URL after success |\n| `type` | `'purchase' \\| 'pre-auth'` | No | Default: `'purchase'` |\n| `shipping` | `number` | No | Shipping fee |\n| `viewType` | `string` | No | `'hosted_view'` or `'popup'` |\n| `lifetime` | `number` | No | Payment lifetime in minutes (3–43200) |\n| `skipSuccessPage` | `number` | No | `0` (don't skip) or `1` (skip) |\n| `payout` | `string` | No | Payout details (JSON string) |\n| `returnDeeplink` | `string` | No | Mobile app deeplink |\n| `googlePayToken` | `string` | No | Required if `paymentOption` is `'google_pay'` |\n\n\u003e `items`, `returnUrl`, `returnDeeplink`, and `payout` are automatically base64-encoded by the SDK.\n\n### `payway.checkTransaction(transactionId)`\n\nCheck the status of a transaction.\n\n```typescript\nconst result = await payway.checkTransaction('order-001')\nconsole.log(result.status.code)          // '00' = success\nconsole.log(result.data?.payment_status) // 'APPROVED' | 'DECLINED' | 'PENDING' | ...\n```\n\n### `payway.listTransactions(options?)`\n\nList transactions with optional filters. Max 3-day date range.\n\n```typescript\nconst list = await payway.listTransactions({\n  fromDate: '2026-03-01 00:00:00',\n  toDate: '2026-03-03 23:59:59',\n  status: 'APPROVED',\n  page: 1,\n  pagination: 20,\n})\n```\n\n| Parameter | Type | Description |\n|---|---|---|\n| `fromDate` | `string` | Start date: `'YYYY-MM-DD HH:mm:ss'` |\n| `toDate` | `string` | End date: `'YYYY-MM-DD HH:mm:ss'` |\n| `fromAmount` | `number` | Minimum amount filter |\n| `toAmount` | `number` | Maximum amount filter |\n| `status` | `string` | Comma-separated: `APPROVED`, `DECLINED`, `PENDING`, `PRE-AUTH`, `CANCELLED`, `REFUNDED` |\n| `page` | `number` | Page number (default: `1`) |\n| `pagination` | `number` | Records per page (default: `40`, max: `1000`) |\n\n### `payway.getTransactionDetails(transactionId)`\n\nGet detailed information about a transaction, including its operation history.\n\n```typescript\nconst details = await payway.getTransactionDetails('order-001')\nconsole.log(details.data?.payment_status)            // 'APPROVED'\nconsole.log(details.data?.transaction_operations)     // [{ status, amount, ... }]\n```\n\n### `payway.closeTransaction(transactionId)`\n\nClose (cancel) a pending transaction. The payment status becomes `CANCELLED`.\n\n```typescript\nconst result = await payway.closeTransaction('order-001')\nconsole.log(result.status.code) // '00' = success\n```\n\n### `payway.getExchangeRate()`\n\nFetch the latest exchange rates from ABA Bank for 12 currencies.\n\n```typescript\nconst rates = await payway.getExchangeRate()\nconsole.log(rates.exchange_rates.eur) // { sell: '...', buy: '...' }\n```\n\n### `payway.generateQR(options)`\n\nGenerate a dynamic QR code for payment via ABA KHQR, WeChat Pay, or Alipay.\n\n```typescript\nconst qr = await payway.generateQR({\n  transactionId: 'qr-001',\n  amount: 10.00,\n  paymentOption: 'abapay_khqr',\n  qrImageTemplate: 'template1',\n  lifetime: 30,\n})\nconsole.log(qr.qrString)         // QR content string\nconsole.log(qr.abapay_deeplink)  // ABA Mobile deep link\n```\n\n| Parameter | Type | Required | Description |\n|---|---|---|---|\n| `transactionId` | `string` | Yes | Unique transaction ID (max 20 chars) |\n| `amount` | `number` | Yes | Payment amount (min: 100 KHR or 0.01 USD) |\n| `paymentOption` | `QRPaymentOption` | Yes | `abapay_khqr`, `wechat` (USD only), `alipay` (USD only) |\n| `qrImageTemplate` | `string` | Yes | QR image template name |\n| `currency` | `'USD' \\| 'KHR'` | No | Default: `'USD'` |\n| `lifetime` | `number` | No | Lifetime in minutes (3–43200) |\n| `firstName` | `string` | No | Payer's first name |\n| `lastName` | `string` | No | Payer's last name |\n| `email` | `string` | No | Payer's email |\n| `phone` | `string` | No | Payer's phone |\n| `purchaseType` | `'purchase' \\| 'pre-auth'` | No | Default: `'purchase'` |\n| `items` | `string` | No | Item description (auto base64-encoded) |\n| `callbackUrl` | `string` | No | Payment callback URL (auto base64-encoded) |\n| `returnDeeplink` | `string` | No | Mobile deeplink (auto base64-encoded) |\n| `payout` | `string` | No | Payout JSON string (auto base64-encoded) |\n\n### `payway.getTransactionsByRef(merchantRef)`\n\nGet transactions by merchant reference. Returns up to the last 50 transactions.\n\n```typescript\nconst txns = await payway.getTransactionsByRef('REF-001')\nfor (const txn of txns.data) {\n  console.log(txn.transaction_id, txn.payment_status)\n}\n\n## Error Handling\n\n```typescript\nimport { PayWay, PayWayAPIError, PayWayConfigError } from 'aba-payway'\n```\n\n| Error Class | When Thrown |\n|---|---|\n| `PayWayConfigError` | Missing or invalid constructor config |\n| `PayWayAPIError` | ABA API returns non-2xx response (has `statusCode` and `responseBody` properties) |\n| `PayWayError` | Base error class |\n| `PayWayHashError` | Hash generation failure |\n\n## Framework Examples\n\n### Next.js (App Router)\n\n```typescript\n// app/api/pay/route.ts\nimport { PayWay } from 'aba-payway'\n\nconst payway = new PayWay({\n  merchantId: process.env.PAYWAY_MERCHANT_ID!,\n  apiKey: process.env.PAYWAY_API_KEY!,\n  environment: process.env.NODE_ENV === 'production' ? 'production' : 'sandbox',\n})\n\nexport async function POST(request: Request) {\n  const { orderId, amount } = await request.json()\n\n  const params = payway.createTransaction({\n    transactionId: orderId,\n    amount,\n    items: 'Order payment',\n    returnUrl: `${process.env.NEXT_PUBLIC_URL}/api/pay/callback`,\n  })\n\n  return Response.json(params)\n}\n```\n\n### Express\n\n```typescript\nimport express from 'express'\nimport { PayWay } from 'aba-payway'\n\nconst app = express()\napp.use(express.json())\n\nconst payway = new PayWay({\n  merchantId: process.env.PAYWAY_MERCHANT_ID!,\n  apiKey: process.env.PAYWAY_API_KEY!,\n})\n\napp.post('/pay', (req, res) =\u003e {\n  const params = payway.createTransaction({\n    transactionId: req.body.orderId,\n    amount: req.body.amount,\n    items: 'Order payment',\n    returnUrl: 'https://yoursite.com/callback',\n  })\n  res.json(params)\n})\n```\n\n## Sandbox Test Cards\n\n| Card | Number | Expiry | CVV | Result |\n|---|---|---|---|---|\n| Mastercard | `5156 8399 3770 6777` | `01/30` | `993` | Approved |\n| Visa | `4286 0900 0000 0206` | `04/30` | `777` | Approved |\n| Mastercard | `5156 8302 7256 1029` | `04/30` | `777` | Declined |\n| Visa | `4156 8399 3770 6777` | `01/30` | `993` | Declined |\n\n## Documentation\n\nFor the full ABA PayWay API documentation, see [aba-payway-docs](https://github.com/Joselay/aba-payway-docs).\n\n## Contributing\n\nFound a bug or have a feature request? [Open an issue](https://github.com/Joselay/aba-payway/issues) — all feedback is welcome.\n\nPull requests are also welcome. Please make sure tests pass before submitting:\n\n```bash\nbun run test\nbun run typecheck\nbun run lint\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoselay%2Faba-payway","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoselay%2Faba-payway","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoselay%2Faba-payway/lists"}