Tham chiếu API
Bảng dưới đây liệt kê toàn bộ methods có sẵn trong SDK, nhóm theo tính năng.
Cú pháp gọi
- Node.js:
client.group.method(body) - Java:
client.group.method(dto) - C#:
await client.Group.MethodAsync(dto) - PHP:
$client->group->method(...params)
Tham số đầu vào/đầu ra giống hoàn toàn với API docs — SDK chỉ tự động xử lý xác thực (signature, timestamp, headers).
bank — Tài khoản ảo & QR Code
| SDK Method | API Endpoint | Docs |
|---|---|---|
generateVietQr(body) | POST /v1/bank/generate-viet-qr | Tạo VietQR tĩnh |
generateDynamicQr(body) | POST /v1/bank/generate-dynamic-qr | Tạo QR động |
deleteDynamicQr(body) | POST /v1/bank/delete-dynamic-qr | Xóa QR động |
getStatusDynamicQr(body) | POST /v1/bank/get-status-dynamic-qr | Trạng thái QR động |
getBanks() | GET /v1/bank/get-banks | Danh sách ngân hàng |
getVaPaging(body) | POST /v1/bank/get-va-paging | Danh sách VA |
createVa(body) | POST /v1/bank/create-va | Tạo VA |
confirmVa(body) | POST /v1/bank/confirm-va | Xác nhận VA |
deleteVa(query) | POST /v1/bank/delete-va | Xóa VA |
confirmDeleteVa(body) | POST /v1/bank/confirm-delete-va | Xác nhận xóa VA |
registerNotify(body) | POST /v1/bank/register-notify | ĐK biến động số dư |
confirmRegisterNotify(body) | POST /v1/bank/confirm-register-notify | XN ĐK biến động |
merchant — Quản lý Merchant
| SDK Method | API Endpoint | Docs |
|---|---|---|
create(body) | POST /v1/merchant/create | Tạo Merchant |
getPaging(body) | POST /v1/merchant/get-paging | Danh sách Merchant |
delete(query) | DELETE /v1/merchant/delete | Xóa Merchant |
getPagingConfig(body) | POST /v1/merchant/get-paging-config | Lấy danh sách cấu hình |
createOrUpdateConfig(body) | POST /v1/merchant/create-or-update-config | Tạo / Cập nhật cấu hình |
deleteConfig(body) | POST /v1/merchant/delete-config | Xóa cấu hình |
configAccountBusiness(body) | POST /v1/merchant/config-account-business | Cấu hình tài khoản DN |
deleteConfigAccountBusiness(body) | POST /v1/merchant/delete-config-account-business | Xóa cấu hình tài khoản DN |
shop — Quản lý cửa hàng
| SDK Method | API Endpoint | Docs |
|---|---|---|
createOrUpdate(body) | POST /v1/shop/create-or-update | Tạo/Cập nhật Shop |
getPaging(body) | POST /v1/shop/get-paging | Danh sách Shop |
device — Thiết bị TingeeBox
| SDK Method | API Endpoint | Docs |
|---|---|---|
readSecurityCode(body) | POST /v1/device/read-security-code | Đọc mã bảo mật |
showQrCode(body) | POST /v1/device/show-qr-code | Hiển thị QR (TingeeBox 3LS) |
showDynamicQrCode(body) | POST /v1/device/show-dynamic-qr-code | Hiển thị QR Code (QR động) |
showStaticQrCode(body) | POST /v1/device/show-static-qr-code | Hiển thị QR Code (QR tĩnh) |
generateAndShowDynamicQrCode(body) | POST /v1/device/generate-and-show-dynamic-qr-code | Tạo & hiển thị QR động |
addDeviceToShop(body) | POST /v1/device/add-device-to-shop | Thêm thiết bị vào shop |
updateShopDeviceLinkStatus(body) | POST /v1/device/update-shop-device-link-status | Cập nhật trạng thái |
getPaging(body) | POST /v1/device/get-paging | D/sách thiết bị |
getDevicesLinkToShopOrVa(body) | POST /v1/device/get-devices-link-to-shop-or-va | Thiết bị theo Shop/VA |
readAmountLinkToMerchant(body) | POST /v1/device/read-amount-link-to-merchant | Đọc số tiền |
reset(query) | DELETE /v1/device/reset | Reset thiết bị |
deepLink — Deep Link thanh toán
| SDK Method | API Endpoint | Docs |
|---|---|---|
generate(body) | POST /v1/deep-link/generate | Tạo Deep Link |
directDebit — Trích nợ tự động
| SDK Method | API Endpoint | Docs |
|---|---|---|
register(body) | POST /v1/direct-debit/register | Đăng ký liên kết |
paymentBill(body) | POST /v1/direct-debit/payment-bill | Trích nợ |
deleteSubscription(body) | DELETE /v1/direct-debit/delete-subscription | Hủy liên kết |
refund(body) | POST /v1/direct-debit/refund | Hoàn tiền |
editConfirmPaymentMethod(body) | PUT /v1/direct-debit/edit-confirm-payment-method | Sửa phương thức |
getSubscriptionStatus(query) | GET /v1/direct-debit/get-subscription-status | Trạng thái liên kết |
getTransactionStatus(query) | GET /v1/direct-debit/get-transaction-status | Trạng thái giao dịch |
getPagingTransactions(query) | GET /v1/direct-debit/get-paging-transactions | Lịch sử giao dịch |
transaction — Giao dịch
| SDK Method | API Endpoint | Docs |
|---|---|---|
getPaging(body) | POST /v1/transaction/get-paging | Lịch sử giao dịch |
Hàm hỗ trợ
SDK cung cấp sẵn Bank Constants, Enums và Response Helpers — xem tại Hàm hỗ trợ & Constants.