Skip to main content
Version: Next

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 MethodAPI EndpointDocs
generateVietQr(body)POST /v1/bank/generate-viet-qrTạo VietQR tĩnh
generateDynamicQr(body)POST /v1/bank/generate-dynamic-qrTạo QR động
deleteDynamicQr(body)POST /v1/bank/delete-dynamic-qrXóa QR động
getStatusDynamicQr(body)POST /v1/bank/get-status-dynamic-qrTrạng thái QR động
getBanks()GET /v1/bank/get-banksDanh sách ngân hàng
getVaPaging(body)POST /v1/bank/get-va-pagingDanh sách VA
createVa(body)POST /v1/bank/create-vaTạo VA
confirmVa(body)POST /v1/bank/confirm-vaXác nhận VA
deleteVa(query)POST /v1/bank/delete-vaXóa VA
confirmDeleteVa(body)POST /v1/bank/confirm-delete-vaXá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-notifyXN ĐK biến động

merchant — Quản lý Merchant

SDK MethodAPI EndpointDocs
create(body)POST /v1/merchant/createTạo Merchant
getPaging(body)POST /v1/merchant/get-pagingDanh sách Merchant
delete(query)DELETE /v1/merchant/deleteXóa Merchant
getPagingConfig(body)POST /v1/merchant/get-paging-configLấy danh sách cấu hình
createOrUpdateConfig(body)POST /v1/merchant/create-or-update-configTạo / Cập nhật cấu hình
deleteConfig(body)POST /v1/merchant/delete-configXóa cấu hình
configAccountBusiness(body)POST /v1/merchant/config-account-businessCấu hình tài khoản DN
deleteConfigAccountBusiness(body)POST /v1/merchant/delete-config-account-businessXóa cấu hình tài khoản DN

shop — Quản lý cửa hàng

SDK MethodAPI EndpointDocs
createOrUpdate(body)POST /v1/shop/create-or-updateTạo/Cập nhật Shop
getPaging(body)POST /v1/shop/get-pagingDanh sách Shop

device — Thiết bị TingeeBox

SDK MethodAPI EndpointDocs
readSecurityCode(body)POST /v1/device/read-security-codeĐọc mã bảo mật
showQrCode(body)POST /v1/device/show-qr-codeHiển thị QR (TingeeBox 3LS)
showDynamicQrCode(body)POST /v1/device/show-dynamic-qr-codeHiển thị QR Code (QR động)
showStaticQrCode(body)POST /v1/device/show-static-qr-codeHiển thị QR Code (QR tĩnh)
generateAndShowDynamicQrCode(body)POST /v1/device/generate-and-show-dynamic-qr-codeTạo & hiển thị QR động
addDeviceToShop(body)POST /v1/device/add-device-to-shopThêm thiết bị vào shop
updateShopDeviceLinkStatus(body)POST /v1/device/update-shop-device-link-statusCập nhật trạng thái
getPaging(body)POST /v1/device/get-pagingD/sách thiết bị
getDevicesLinkToShopOrVa(body)POST /v1/device/get-devices-link-to-shop-or-vaThiết bị theo Shop/VA
readAmountLinkToMerchant(body)POST /v1/device/read-amount-link-to-merchantĐọc số tiền
reset(query)DELETE /v1/device/resetReset thiết bị

SDK MethodAPI EndpointDocs
generate(body)POST /v1/deep-link/generateTạo Deep Link

directDebit — Trích nợ tự động

SDK MethodAPI EndpointDocs
register(body)POST /v1/direct-debit/registerĐăng ký liên kết
paymentBill(body)POST /v1/direct-debit/payment-billTrích nợ
deleteSubscription(body)DELETE /v1/direct-debit/delete-subscriptionHủy liên kết
refund(body)POST /v1/direct-debit/refundHoàn tiền
editConfirmPaymentMethod(body)PUT /v1/direct-debit/edit-confirm-payment-methodSửa phương thức
getSubscriptionStatus(query)GET /v1/direct-debit/get-subscription-statusTrạng thái liên kết
getTransactionStatus(query)GET /v1/direct-debit/get-transaction-statusTrạng thái giao dịch
getPagingTransactions(query)GET /v1/direct-debit/get-paging-transactionsLịch sử giao dịch

transaction — Giao dịch

SDK MethodAPI EndpointDocs
getPaging(body)POST /v1/transaction/get-pagingLị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.