Everything you need to integrate Sir Chargly and start charging convenience fees
Complete walkthrough from Stripe connection to your first charge - API keys, test customers, payment collection, refunds, and chargebacks
Read docsComplete guide to integrating Sir Chargly with SDK installation, authentication, endpoints, webhooks, and production deployment
Read docsComplete SDK reference with all methods, parameters, examples, and TypeScript types for the @sirchargly/sdk package
Read docsTest your integration with pre-configured customers for different regional compliance scenarios without exposing regulations
Read docsHands-on testing with live API demos - calculate fees and create charges right in the docs with real API calls
Read docsStep-by-step walkthrough of the merchant onboarding wizard from signup to first integration
Read docsComprehensive testing procedures and solutions to common issues
Read docsOur API is designed to be simple and intuitive. Get up and running with just a few lines of code.
View Getting Started Guideconst 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'
});Can't find what you're looking for? Our support team is here to help.