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 — Commission Module

client.commission.* — commission config CRUD. Direct paymentSystem calls.

list(params)

const configs = await client.commission.list({ paymentMethod: 'DMT', txnType: 'VALIDATION' });

get(configId)

const config = await client.commission.get('cfg-uuid');

create(body)

await client.commission.create({
  aggregatorId:  'fc84ec36-f74f-4eee-9c46-3b1111fd88c1',
  vendorId:      'f0195939-0e56-4988-9fd4-5f797322b4a7',
  paymentMethod: 'DMT',
  provider:      'NSDL',
  txnType:       'VALIDATION',
  chargeType:    'FIXED',
  chargeValue:   5,
  isDefault:     true,
});

update(configId, body)

await client.commission.update('cfg-uuid', { chargeValue: 4 });

delete(configId)

await client.commission.delete('cfg-uuid');

txnType Reference

txnTypeWhen applied
REGISTRATIONDMT remitter registration
VALIDATIONDMT account verification (NSDL penny-drop)
TRANSFERIMPS/NEFT fund transfer
NONENo charge for this operation

See Commission Model for cascade logic and GL entry details.

Prev
Vendor
Next
Crypto Utilities