SoftyComp Developer Playground

npm install softycomp-node

import { SoftyComp } from 'softycomp-node';

const client = new SoftyComp({
  apiKey: 'your-api-key',
  secretKey: 'your-secret-key',
  sandbox: true,
});

const bill = await client.createBill({
  amount: 299.00,
  customerName: 'John Doe',
  customerEmail: 'john@example.com',
  customerPhone: '0825551234',
  reference: 'INV-001',
  frequency: 'once-off',
  returnUrl: 'https://myapp.com/success',
  cancelUrl: 'https://myapp.com/cancel',
  notifyUrl: 'https://myapp.com/webhook',
});

// Redirect customer to payment page
console.log(bill.paymentUrl);

const bill = await client.createBill({
  amount: 99.00,
  customerName: 'John Doe',
  customerEmail: 'john@example.com',
  customerPhone: '0825551234',
  reference: 'SUB-001',
  description: 'Premium Monthly Subscription',
  frequency: 'monthly',
  commencementDate: '2026-04-01',
  recurringDay: 1,
  returnUrl: 'https://myapp.com/success',
  cancelUrl: 'https://myapp.com/cancel',
  notifyUrl: 'https://myapp.com/webhook',
});

const status = await client.getBillStatus('BILL-REF-123');

if (status.status === 'completed') {
  console.log('Payment received on:', status.paidAt);
}

const mandate = await client.createMobiMandate({
  customerEmail: 'john@example.com',
  customerPhone: '0825551234',
  surname: 'Doe',
  initials: 'J',
  amount: 99.00,
  frequency: 'monthly',
  debitDay: 1,
  description: 'Monthly subscription',
  successUrl: 'https://myapp.com/success',
});

// Redirect customer to sign mandate
console.log(mandate.url);

app.post('/webhook', express.json(), (req, res) => {
  const event = client.parseWebhook(req.body);

  switch (event.type) {
    case 'successful':
      console.log('Payment successful!');
      console.log('Reference:', event.reference);
      console.log('Amount: R' + event.amount);
      break;
    case 'failed':
      console.log('Payment failed:', event.reference);
      break;
  }

  res.status(200).send('OK');
});

// Full refund
const refund = await client.refund({
  transactionId: 'TXN-123',
});

// Partial refund
const refund = await client.refund({
  transactionId: 'TXN-123',
  amount: 50.00,
});

await client.updateBillPresentment({
  reference: 'BILL-REF-123',
  amount: 399.00,
  description: 'Updated description',
  customerName: 'John Doe',
  customerEmail: 'john@example.com',
  customerPhone: '0825551234',
});

await client.setBillToExpiredStatus('BILL-REF-123', 'USER-REF-123');

const audits = await client.listBillPresentmentAudits(
  'BILL-REF-123',
  'USER-REF-123'
);

audits.forEach(audit => {
  console.log(`${audit.timestamp}: ${audit.description}`);
});

const clientId = await client.createClient({
  name: 'John',
  surname: 'Doe',
  email: 'john@example.com',
  phone: '0825551234',
  idNumber: '8001015009087',
});

await client.updateCollectionStatus({
  collectionId: 12345,
  statusTypeId: 2, // 1=Active, 2=Suspended, 6=Cancelled
});

const result = await client.createCreditDistribution({
  amount: 500.00,
  accountNumber: '1234567890',
  branchCode: '123456',
  accountName: 'John Doe',
  reference: 'PAYOUT-001',
});