JavaScript SDK

npm install @dime-technology/dime-js-sdk

import { Client } from '@dime-technology/dime-js-sdk';

const dime = new Client('your-api-token');

const txn = await dime.transactions.chargeCard('YOUR_SID', {
  amount: 49.99,
  token: 'tok_abc123',
});

console.log(txn.transactionStatus); // "Success"

import { Client, Config } from '@dime-technology/dime-js-sdk';

// Simple setup
const dime = new Client('your-api-token');

// Full control
const dime = new Client(new Config({
  token: 'your-api-token',
  baseUrl: 'https://app.dimepayments.com',
  timeout: 30000,
  maxRetries: 2,
}));

// Look up (or create) the items a line can reference
const item = await dime.invoices.createItem('YOUR_SID', {
  name: 'Consulting',
  price: 125,
  tax_deductible: false,
});

// Create a draft invoice
const invoice = await dime.invoices.create('YOUR_SID', {
  customer_uuid: customer.uuid,
  customer_name: 'Jane Doe',
  customer_email: 'jane@example.com',
  payment_terms: 'net_15', // due_on_receipt | net_15 | net_30 | net_60
  lines: [{ item_id: item.id, name: 'Consulting', quantity: 2, unit_price: 125 }],
});

// Email it, or activate the pay link without emailing
await dime.invoices.send('YOUR_SID', invoice.id);
await dime.invoices.markSent('YOUR_SID', invoice.id);

// Share the public pay link
const { publicUrl } = await dime.invoices.getLink('YOUR_SID', invoice.id);

// Take a merchant-initiated payment. payment_type is required; omit amount to
// pay the full balance.
await dime.invoices.pay('YOUR_SID', invoice.id, {
  payment_type: 'cc', // cc | ach
  token: 'tok_abc123',
  amount: 125,
});

const template = await dime.recurringInvoices.create('YOUR_SID', {
  customer_uuid: customer.uuid,
  payment_terms: 'net_30',
  recurring_frequency: 'Monthly', // Weekly | Biweekly | FirstFifteenth | Monthly | Yearly
  recurring_start_date: '2026-09-01',
  lines: [{ item_id: item.id, name: 'Retainer', quantity: 1, unit_price: 500 }],
});

await dime.recurringInvoices.cancel('YOUR_SID', template.id);

// Disputes on the merchant, and the documents that answer one
const chargebacks = await dime.chargebacks.list('YOUR_SID', { representment_status: 'New' });
await dime.documents.upload('YOUR_SID', 'RetrievalRequest', [file], chargebacks.data[0].transactionInfoId);

// Held funds (affiliate keys only). The idempotency key makes a retry safe.
const balance = await dime.funds.balance('YOUR_SID');
const result = await dime.funds.release('YOUR_SID', 'payout-2026-10-06', { amount: balance.releasable });
if (result.release.status !== 'released') {
  // 'failed' (declined, nothing moved) or 'unknown' (check again before retrying)
}

const txn = await dime.transactions.chargeCardToken(
  'YOUR_SID',
  { amount: '49.99', token: 'abc123def456' /* ... */ },
  { idempotencyKey: 'order-1234-charge' },
)

// Place a hold
const auth = await dime.transactions.authorize('YOUR_SID', {
  amount: 100.50,
  token: 'tok_abc123',
  phone: '+17701234567',
});

// Capture all of it, or pass a smaller amount as the third argument
await dime.transactions.capture('YOUR_SID', auth.transactionNumber, 87.25);

// Or release the hold without charging
await dime.transactions.void('YOUR_SID', 'CC', auth.transactionNumber);

const status = await dime.merchants.applicationStatus('YOUR_SID');

if (status.boarded) {
  // The merchant can take payments
}

// Enroll a customer in a published plan. Charges the first period.
const result = await dime.subscriptionPlans.subscribe(
  'YOUR_SID',
  planId,
  customer.uuid,
  paymentMethodId,
);

await dime.subscriptions.pause('YOUR_SID', subscriptionId);
await dime.subscriptions.resume('YOUR_SID', subscriptionId);
await dime.subscriptions.cancel('YOUR_SID', subscriptionId);

import { DimeException, ValidationException } from '@dime-technology/dime-js-sdk';

try {
  await dime.transactions.chargeCard('YOUR_SID', { amount: 0 });
} catch (e) {
  if (e instanceof ValidationException) {
    console.log(e.getErrors());
  }
}