BucksBox Developer DocsBucksBox Developer Docs
Getting Started
Merchant API
Partner API
SDK
GitHub
Getting Started
Merchant API
Partner API
SDK
GitHub
  • Quick Start
  • Configuration
  • Auth
  • DMT
  • AEPS
  • QR
  • Vendor
  • Commission
  • Crypto Utilities

SDK — Vendor Module

client.vendor.* — profile, balance, merchants, and transactions. Direct paymentSystem calls.

Profile

await client.vendor.getProfile();
await client.vendor.updateProfile({ name: 'My Company', address: '...' });

Balance & Statement

await client.vendor.getBalance();

await client.vendor.getWalletStatement({
  page: 1, limit: 20, dateFrom: '2026-07-01', dateTo: '2026-07-04',
});

Dashboard

await client.vendor.getDashboard();
// Returns summary: total transactions, volumes, success rates, wallet balance

Merchants

// List
await client.vendor.listMerchants({ page: 1, limit: 20, search: 'shop' });

// Get one
await client.vendor.getMerchant('M-uuid');

// Create
await client.vendor.createMerchant({
  name: 'Shop A', mobile: '9876543210', email: 'shop@example.com',
  address: '123 MG Road', pincode: '400001',
});

// Update
await client.vendor.updateMerchant('M-uuid', { name: 'Shop A (Branch 2)' });

Transactions

await client.vendor.listTransactions({
  page: 1, limit: 20, type: 'DMT', status: '00', dateFrom: '2026-07-01',
});

await client.vendor.getTransaction('TXN-uuid');

Commission

await client.vendor.listCommissionConfigs({ paymentMethod: 'DMT' });
await client.vendor.createCommissionConfig({ ... });        // see Commission guide
await client.vendor.updateCommissionConfig('cfg-uuid', { chargeValue: 4 });
await client.vendor.deleteCommissionConfig('cfg-uuid');
Prev
QR
Next
Commission