@kaash/scanner-sdk
v0.1.2
Published
Kaash Scanner SDK — accept Kaash Wallet QR payments via handheld barcode scanner from any POS
Maintainers
Readme
@kaash/scanner-sdk
Official SDK for accepting Kaash Wallet QR payments from any POS using a handheld USB/BT 2D barcode scanner.
Standalone package — no other @kaash/* dependencies. Calls the Kaash Payment API directly.
Sibling of
@kaash/terminal-sdk(NFC). Same backend, separate package & repo.
Flow
Customer Kaash Wallet (shows QR)
→ Handheld QR scanner (USB / Bluetooth)
→ POS software + @kaash/scanner-sdk
→ Kaash Payment APIInstall
npm install @kaash/scanner-sdkRequires Node.js 18+. Any HID keyboard-wedge 2D scanner works.
Quick start (KashPay button)
import { KaashScanner } from '@kaash/scanner-sdk';
const kaash = KaashScanner.create({
apiKey: 'pk_live_xxx',
apiUrl: 'https://api.tenstream.app',
});
await kaash.initialize();
const result = await kaash.pay({
amount: 25,
currency: 'USD',
transactionId: 'POS-001',
onWaitingForScan: () => showScreen('Scan customer wallet QR'),
});
if (result.status === 'APPROVED') {
printReceipt(result.reference);
}While pay() waits:
kaash.pushScan(rawString)from your POS wedge handler, orscanner: { listenStdin: true }on desktop.
Already have the scan string?
import { KaashScanner, parsePayPayload } from '@kaash/scanner-sdk';
const payToken = parsePayPayload(rawFromScanner);
await kaash.pay({ amount: 25, payToken, transactionId: 'POS-001' });Docs
See SCANNER-SDK.md.
