API reference
The tables below list every method available in the SDK, grouped by feature.
Call syntax
- Node.js:
client.group.method(body) - Java:
client.group.method(dto) - C#:
await client.Group.MethodAsync(dto) - PHP:
$client->group->method(...params)
Input and output parameters are exactly the same as in the API docs — the SDK only handles authentication (signature, timestamp, headers) for you.
bank — Virtual accounts & QR codes
| SDK Method | API Endpoint | Docs |
|---|---|---|
generateVietQr(body) | POST /v1/bank/generate-viet-qr | Generate static VietQR |
generateDynamicQr(body) | POST /v1/bank/generate-dynamic-qr | Generate dynamic QR |
deleteDynamicQr(body) | POST /v1/bank/delete-dynamic-qr | Delete dynamic QR |
getStatusDynamicQr(body) | POST /v1/bank/get-status-dynamic-qr | Dynamic QR status |
getBanks() | GET /v1/bank/get-banks | List of banks |
getVaPaging(body) | POST /v1/bank/get-va-paging | List of VAs |
createVa(body) | POST /v1/bank/create-va | Create VA |
confirmVa(body) | POST /v1/bank/confirm-va | Confirm VA |
deleteVa(query) | POST /v1/bank/delete-va | Delete VA |
confirmDeleteVa(body) | POST /v1/bank/confirm-delete-va | Confirm VA deletion |
registerNotify(body) | POST /v1/bank/register-notify | Register for balance notifications |
confirmRegisterNotify(body) | POST /v1/bank/confirm-register-notify | Confirm notification registration |
merchant — Merchant management
| SDK Method | API Endpoint | Docs |
|---|---|---|
create(body) | POST /v1/merchant/create | Create Merchant |
getPaging(body) | POST /v1/merchant/get-paging | List of Merchants |
delete(query) | DELETE /v1/merchant/delete | Delete Merchant |
getPagingConfig(body) | POST /v1/merchant/get-paging-config | List configurations |
createOrUpdateConfig(body) | POST /v1/merchant/create-or-update-config | Create / Update configuration |
deleteConfig(body) | POST /v1/merchant/delete-config | Delete configuration |
configAccountBusiness(body) | POST /v1/merchant/config-account-business | Configure business account |
deleteConfigAccountBusiness(body) | POST /v1/merchant/delete-config-account-business | Delete business account configuration |
shop — Shop management
| SDK Method | API Endpoint | Docs |
|---|---|---|
createOrUpdate(body) | POST /v1/shop/create-or-update | Create/Update Shop |
getPaging(body) | POST /v1/shop/get-paging | List of Shops |
device — TingeeBox devices
| SDK Method | API Endpoint | Docs |
|---|---|---|
readSecurityCode(body) | POST /v1/device/read-security-code | Read out security code |
showQrCode(body) | POST /v1/device/show-qr-code | Show QR (TingeeBox 3LS) |
showDynamicQrCode(body) | POST /v1/device/show-dynamic-qr-code | Show QR Code (dynamic QR) |
showStaticQrCode(body) | POST /v1/device/show-static-qr-code | Show QR Code (static QR) |
generateAndShowDynamicQrCode(body) | POST /v1/device/generate-and-show-dynamic-qr-code | Generate & show dynamic QR |
addDeviceToShop(body) | POST /v1/device/add-device-to-shop | Add device to shop |
updateShopDeviceLinkStatus(body) | POST /v1/device/update-shop-device-link-status | Update status |
getPaging(body) | POST /v1/device/get-paging | List of devices |
getDevicesLinkToShopOrVa(body) | POST /v1/device/get-devices-link-to-shop-or-va | Devices by Shop/VA |
readAmountLinkToMerchant(body) | POST /v1/device/read-amount-link-to-merchant | Read amount |
reset(query) | DELETE /v1/device/reset | Reset device |
deepLink — Payment Deep Link
| SDK Method | API Endpoint | Docs |
|---|---|---|
generate(body) | POST /v1/deep-link/generate | Generate Deep Link |
directDebit — Direct Debit (automatic debit)
| SDK Method | API Endpoint | Docs |
|---|---|---|
register(body) | POST /v1/direct-debit/register | Register link |
paymentBill(body) | POST /v1/direct-debit/payment-bill | Debit |
deleteSubscription(body) | DELETE /v1/direct-debit/delete-subscription | Cancel link |
refund(body) | POST /v1/direct-debit/refund | Refund |
editConfirmPaymentMethod(body) | PUT /v1/direct-debit/edit-confirm-payment-method | Edit payment method |
getSubscriptionStatus(query) | GET /v1/direct-debit/get-subscription-status | Link status |
getTransactionStatus(query) | GET /v1/direct-debit/get-transaction-status | Transaction status |
getPagingTransactions(query) | GET /v1/direct-debit/get-paging-transactions | Transaction history |
transaction — Transactions
| SDK Method | API Endpoint | Docs |
|---|---|---|
getPaging(body) | POST /v1/transaction/get-paging | Transaction history |
Helpers
The SDK ships with Bank Constants, Enums and Response Helpers — see Helpers & Constants.