Documentation

Everything you need to integrate Sir Chargly and start charging convenience fees

⌘K

Start building in minutes

Our API is designed to be simple and intuitive. Get up and running with just a few lines of code.

View Getting Started Guide
example.js
const SirChargly = require('@sirchargly/sdk');
// Use your secret key: sk_dev_sirchargly_...
const sc = new SirChargly(process.env.SIRCHARGLY_SECRET_KEY);

// Calculate fee estimate
const estimate = await sc.estimates.create({
  amount: 10000,
  currency: 'usd',
  regionCode: 'US-CA',
  paymentMethod: 'visa_credit'
});

// Create charge with fee
const charge = await sc.charges.create({
  amount: 10000,
  currency: 'usd',
  customer: 'cus_abc123',
  paymentMethod: 'pm_card_visa'
});

Need help?

Can't find what you're looking for? Our support team is here to help.