@inverz/promptpay
v1.0.0
Published
Thai PromptPay and Bill Payment QR codes for React: EMVCo payload builder, parser and CRC check, React-free core for servers
Readme
@inverz/promptpay
สร้าง QR พร้อมเพย์ และ QR ชำระบิล (Bill Payment) ตามมาตรฐาน Thai QR Payment (EMVCo) สำหรับ React รับเงินเข้าเบอร์มือถือ เลขบัตรประชาชน / เลขผู้เสียภาษี หรือ e-Wallet กำหนดยอดหรือให้ผู้จ่ายกรอกเอง อ่านและตรวจ payload กลับได้ และสร้างรูป SVG ฝั่ง server โดยไม่ต้องมี React
PromptPay and Bill Payment QR codes for React (Thai QR Payment / EMVCo), with a payload parser, CRC check and a React-free core for servers.
ติดตั้ง
npm i @inverz/promptpayimport "@inverz/promptpay/style.css"; // ไม่บังคับ
import { PromptPayQR, BillPaymentQR } from "@inverz/promptpay";PromptPayQR
<PromptPayQR target="0812345678" amount={150} name="ร้านกาแฟใจดี" />targetรับเบอร์มือถือ (081-234-5678,+66 81 234 5678), เลขบัตรประชาชน / เลขผู้เสียภาษี 13 หลัก (ตรวจหลักสุดท้ายให้) หรือเลข e-Wallet 15 หลัก- ไม่ใส่
amountจะได้ QR ที่ใช้ซ้ำได้ ผู้จ่ายกรอกยอดเอง ใส่amountจะได้ QR สำหรับยอดนั้น - ถ้าข้อมูลไม่ถูกต้อง จะแสดงกล่องแจ้งแทน QR และ
onPayloadได้null
| prop | ค่าเริ่มต้น | คำอธิบาย |
|---|---|---|
| target | | เบอร์มือถือ / เลข 13 หลัก / e-Wallet 15 หลัก |
| amount | | ยอดเงิน (บาท) ตัวเลขหรือข้อความ เช่น "1,500.50" |
| name | | ชื่อผู้รับหรือร้านที่แสดงใต้ QR |
| showTarget | true | แสดงปลายทางแบบซ่อนเลข 081-xxx-5678 |
| card | true | false แสดงเฉพาะตัว QR |
| size | 220 | ขนาด QR (px) |
| level | "M" | ระดับแก้ข้อผิดพลาด L M Q H |
| locale | "th" | "en" ข้อความภาษาอังกฤษ |
| onPayload | | (payload: string \| null) => void |
BillPaymentQR
ใช้เมื่อต้องรู้ว่าออเดอร์ไหนจ่ายแล้ว ธนาคารจะแจ้งกลับระบบพร้อม ref1 / ref2 ต้องสมัครบริการ Bill Payment กับธนาคารหรือผู้ให้บริการชำระเงินเพื่อได้ Biller ID ก่อน
<BillPaymentQR billerId="010556012345601" ref1="INV2026001" ref2="A1" amount={1500} />billerId15 หลักref1(บังคับ) และref2ใช้ได้เฉพาะ A–Z และ 0–9 ไม่เกิน 20 ตัว ใช้cleanRef(value)แปลงค่าที่ผู้ใช้พิมพ์ให้ตรงรูปแบบ
QRCode
สร้าง QR จากข้อความอะไรก็ได้ วาดเป็น SVG
<QRCode value="https://example.com" size={160} />ฟังก์ชัน (ใช้ฝั่ง server ได้)
@inverz/promptpay/core ไม่ดึง React
import { promptPayPayload, billPaymentPayload, parsePayload, qrSvg } from "@inverz/promptpay/core";
const payload = promptPayPayload("0812345678", { amount: 250 });
const svg = qrSvg(payload, { size: 240 }); // "<svg …>" แนบในอีเมลหรือ PDF ได้
parsePayload(payload);
// { valid: true, type: "phone", target: "0812345678", amount: 250, reusable: false, … }| ฟังก์ชัน | คำอธิบาย |
|---|---|
| promptPayPayload(target, { amount }) | payload พร้อมเพย์ ข้อมูลผิดจะ throw |
| billPaymentPayload({ billerId, ref1, ref2, amount }) | payload ชำระบิล |
| parsePayload(payload) | อ่านกลับ พร้อม valid จากการตรวจ CRC (ถ้ามีคนแก้ยอดหรือพิมพ์ผิดจะได้ false) |
| promptPayType(target) | "phone" / "id" / "ewallet" / null |
| isPromptPayTarget(target) | ใช้รับเงินพร้อมเพย์ได้ไหม |
| maskTarget(target) | "081-xxx-5678" |
| cleanRef(value) | แปลงเป็น ref ที่ Bill Payment รับได้ |
| qrSvg(payload, { size, margin, level, color, background }) | รูป QR เป็นข้อความ SVG |
| qrMatrix(payload), qrPath(matrix) | ข้อมูล QR สำหรับวาดเอง |
| crc16(text), tlv(id, value) | ตัวช่วยระดับล่าง |
ข้อควรรู้
- QR ที่สร้างเป็นการโอนเงินจริง ก่อนใช้งานจริงให้ลองสแกนด้วยแอปธนาคารที่ลูกค้าใช้บ่อย
- แพ็กเกจนี้สร้าง QR อย่างเดียว ไม่ได้ตรวจว่าเงินเข้าแล้ว ถ้าต้องการยืนยันการจ่ายอัตโนมัติให้ใช้ Bill Payment กับบริการแจ้งเตือนของธนาคาร
- QR มีพื้นขาวเสมอ แม้ในธีมมืด เพื่อให้ทุกแอปสแกนได้
- ปรับสีกรอบด้วย CSS variables
--tpp-brand,--tpp-surface,--tpp-border,--tpp-text,--tpp-radius
PromptPay และ Thai QR Payment เป็นเครื่องหมายของเจ้าของ แพ็กเกจนี้ไม่ได้เกี่ยวข้องกับธนาคารแห่งประเทศไทยหรือสมาคมธนาคารไทย
License
MIT © 2026 Inverz Solutions Co.,Ltd.
ใช้ qrcode-generator (MIT) วาด QR
