Back to Documentation

Sir Chargly - User Onboarding Guide

Welcome to Sir Chargly! This guide will walk you through the complete onboarding process to get you up and running with convenience fee processing.

Overview

The onboarding wizard takes approximately 5 minutes and consists of 6 steps:

  • Welcome - Introduction and overview
  • Connect Stripe - Link your Stripe account
  • Analyze Earnings - View your earning potential
  • Configure Fees - Set up your convenience fee structure
  • Generate API Keys - Create your first API key
  • Get Started - Integration guide and code examples

  • Step 1: Welcome

    When you first sign up, you'll see the welcome screen that explains:

  • Keep More Revenue - Add compliant convenience fees and keep the majority
  • Boost Your Bottom Line - Turn processing costs into profit centers
  • Stay Compliant - Automated regional compliance with card network rules
  • Quick Integration - Simple API that works with existing Stripe setup
  • What to do: Click "Let's Get Started →" to begin


    Step 2: Connect Your Stripe Account

    Why This Is Needed

    Sir Chargly needs access to your Stripe account to:

  • Analyze your transaction history (last 30 days)
  • Calculate your earning potential
  • Apply convenience fees to charges
  • Process payments on your behalf
  • What We Access

  • Transaction History - Last 30 days to calculate potential earnings
  • Customer Data - To apply convenience fees to charges
  • Payment Processing - To add fees to transactions
  • Security

  • We use Stripe's official OAuth process
  • Your credentials are never shared with us
  • You can revoke access anytime from your Stripe dashboard
  • All connections are encrypted and secure
  • Steps

  • Click "Connect with Stripe"
  • You'll be redirected to Stripe's authorization page
  • Review the permissions and click "Connect"
  • You'll be redirected back to Sir Chargly
  • Already Connected? If your Stripe account is already linked, you'll see a confirmation and can skip to the next step.


    Step 3: Analyze Your Earnings

    This is the exciting part! Based on your last 30 days of transaction data, we'll show you:

    Big Picture Number

    A large, animated number showing your additional monthly revenue potential by adding convenience fees with Sir Chargly.

    Example: +$1,247

    Comparison View

    Two side-by-side cards showing:

  • Current Earnings - What you make now without convenience fees
  • With Sir Chargly - What you could make with convenience fees
  • Percentage Increase - How much more revenue you'd generate
  • Visual Chart

    An animated bar chart comparing:

  • Your current 30-day earnings (gray bar)
  • Your potential earnings with convenience fees (green bar)
  • Transaction Stats

  • Average Transaction Size - Your typical transaction amount
  • Total Transactions - Number of transactions in the last 30 days
  • What If I Don't Have Transaction Data?

    If you don't have any transactions in the last 30 days, you'll see a message and can continue with default fee configurations.

    What to do: Review your potential earnings and click "Configure My Fees →"


    Step 4: Configure Your Convenience Fees

    This step lets you set up your fee structure with real-time revenue projections.

    Interactive Sliders

    Percentage Fee (0% - 5%)

  • Drag the slider to set your percentage fee
  • Common range: 2.5% - 3.5%
  • Updates your projected revenue in real-time
  • Flat Fee ($0 - $2)

  • Drag the slider to set your flat fee per transaction
  • Common range: $0.30 - $0.50
  • Updates your projected revenue in real-time
  • Live Revenue Projection

    As you adjust the sliders, you'll see a large animated number showing your projected monthly revenue based on your 30-day transaction history.

    Example Calculation

    A breakdown showing how fees apply to a $100 transaction:

  • Base Amount: $100.00
  • Percentage (2.9%): $2.90
  • Flat Fee: $0.30
  • Total Convenience Fee: $3.20
  • Best Practices

  • Start Conservative - Begin with 2.5% + $0.30 to test customer acceptance
  • Monitor Feedback - Watch for customer complaints or cart abandonment
  • Optimize Over Time - Adjust based on data after 30-60 days
  • Stay Compliant - Fees should reflect actual processing costs
  • What to do: Adjust the sliders to your desired fee structure and click "Save & Continue →"


    Step 5: Generate Your First API Key

    Security is critical! This step creates your first API key for integration.

    What You'll Get

    Publishable Key (starts with pk_dev_)

  • Use in your client-side code
  • Safe to expose in frontend JavaScript
  • Used to initialize the Sir Chargly SDK
  • Secret Key (starts with sk_dev_)

  • Use in your server-side code only
  • NEVER expose in client-side code or public repositories
  • Used to authenticate API requests
  • Development Environment

    Your first key is automatically created for the development environment:

  • No real charges will be processed
  • Perfect for testing and integration
  • Separate from production data
  • Security Warning

    ⚠️ CRITICAL: This is the only time you'll see the secret key!

  • Copy both keys immediately
  • Store them securely (use environment variables)
  • Never commit keys to version control
  • Create new keys if compromised
  • How to Copy Keys

  • Click the copy icon next to each key
  • Store in your .env.local file:
  • ```bash

    SIRCHARGLEY_PUBLISHABLE_KEY=pk_dev_sirchargly_...

    SIRCHARGLEY_SECRET_KEY=sk_dev_sirchargly_...

    ```

  • Add .env.local to your .gitignore
  • What to do: Copy both keys to a secure location and click "I've Saved My Keys →"


    Step 6: Get Started - Integration Guide

    The final step provides everything you need to integrate Sir Chargly.

    Quick Reference

    Your API keys are shown again for quick reference:

  • Publishable Key (partially hidden)
  • Secret Key (partially hidden)
  • Click copy icons to copy again
  • Installation

    npm install @sirchargly/sdk
    

    Client-Side Integration

    Initialize Sir Chargly in your frontend:

    import { SirChargly } from '@sirchargly/sdk';
    
    // Initialize with your publishable key
    const chargly = new SirChargly('pk_dev_sirchargly_...');
    
    // Create a payment with convenience fee
    async function createPayment(amount: number) {
      const payment = await chargly.payments.create({
        amount: amount,
        currency: 'usd',
        customer: customerId,
      });
    
      // Sir Chargly automatically calculates and adds the fee
      console.log('Total with fee:', payment.totalAmount);
      console.log('Convenience fee:', payment.convenienceFee);
    
      return payment;
    }
    

    Server-Side Integration

    Process payments on your backend:

    import Stripe from 'stripe';
    
    // Initialize Stripe with your secret key
    const stripe = new Stripe('sk_dev_sirchargly_...', {
      apiVersion: '2025-12-15.clover',
    });
    
    // Process the payment
    async function processPayment(paymentIntentId: string) {
      const paymentIntent = await stripe.paymentIntents.retrieve(
        paymentIntentId
      );
    
      // Sir Chargly handles fee calculation and compliance
      return paymentIntent;
    }
    

    Webhook Setup (Optional)

    Handle payment events:

    import { NextRequest, NextResponse } from 'next/server';
    import { headers } from 'next/headers';
    
    export async function POST(req: NextRequest) {
      const body = await req.text();
      const signature = headers().get('stripe-signature');
    
      // Verify webhook signature
      const event = stripe.webhooks.constructEvent(
        body,
        signature!,
        process.env.STRIPE_WEBHOOK_SECRET!
      );
    
      // Handle payment events
      if (event.type === 'payment_intent.succeeded') {
        const paymentIntent = event.data.object;
        console.log('Payment succeeded:', paymentIntent.id);
      }
    
      return NextResponse.json({ received: true });
    }
    

    Next Steps

    Go to Dashboard

  • Monitor transactions in real-time
  • View analytics and revenue reports
  • Adjust fee configurations
  • Manage API keys
  • Read the Docs

  • Explore advanced features
  • Learn best practices
  • See more code examples
  • API reference documentation
  • What to do: Click "Complete Setup & Go to Dashboard →" to finish onboarding


    After Onboarding

    Dashboard Overview

    Your dashboard provides:

  • Real-time Metrics - Transaction volume, revenue, and fees
  • Analytics - Charts and trends over time
  • Reports - Detailed transaction and fee reports
  • API Keys - Manage development and production keys
  • Fee Configuration - Adjust your fee structure anytime
  • Creating Production Keys

    When you're ready to go live:

  • Go to Dashboard → API Keys
  • Click "Add Key"
  • Name it (e.g., "Production - Web App")
  • Select Production environment
  • Copy the keys immediately
  • Update your production environment variables
  • Going Live Checklist

  • [ ] Test thoroughly in development
  • [ ] Create production API keys
  • [ ] Update production environment variables
  • [ ] Configure webhooks for production
  • [ ] Set up monitoring and alerts
  • [ ] Review compliance requirements for your region
  • [ ] Test with small transaction amounts first
  • [ ] Monitor customer feedback
  • Support

    Need help?

  • Documentation: https://docs.sirchargly.com
  • Email Support: support@sirchargly.com
  • Live Chat: Available in your dashboard
  • Status Page: https://status.sirchargly.com

  • Troubleshooting

    Stripe Connection Failed

    Problem: Error connecting to Stripe during onboarding

    Solutions:

  • Verify you have a valid Stripe account
  • Check that you're logged into Stripe in your browser
  • Try connecting again (OAuth tokens can expire)
  • Contact support if the issue persists
  • No Transaction Data

    Problem: Earnings analysis shows "No Transaction Data"

    Solutions:

  • This is normal if you haven't processed transactions yet
  • You can still complete onboarding with default fees
  • The analysis will update once you have transaction history
  • Test transactions in development mode to see it in action
  • Lost API Keys

    Problem: Forgot to copy secret key during onboarding

    Solutions:

  • Secret keys cannot be recovered (security feature)
  • Go to Dashboard → API Keys
  • Delete the old key
  • Create a new key and copy it immediately
  • Update your application with the new key
  • Fee Configuration Questions

    Problem: Unsure what fee percentage to set

    Recommendations:

  • Start with 2.9% + $0.30 (matches Stripe's processing fee)
  • Monitor customer acceptance over 2-4 weeks
  • Adjust up or down based on feedback
  • Check compliance requirements for your region
  • Some states/regions have maximum fee limits
  • Environment Toggle Confusion

    Problem: Seeing test data in dashboard

    Solutions:

  • Check the environment toggle (Dev vs Prod)
  • Development mode shows test/mock data
  • Production mode shows real transaction data
  • The toggle is in the sidebar (top section)

  • Tips for Success

    Best Practices

  • Start in Development
  • - Test all features before going live

    - Use development keys for integration

    - Verify webhook handling works correctly

  • Communicate with Customers
  • - Display fees clearly at checkout

    - Explain that fees help offset processing costs

    - Offer fee-free alternatives if possible (ACH, etc.)

  • Monitor Performance
  • - Track conversion rates after adding fees

    - Watch for cart abandonment spikes

    - Adjust fees if needed based on data

  • Stay Compliant
  • - Review regional compliance requirements

    - Keep fees reasonable (typically 2-4%)

    - Disclose fees before payment

    - Never charge more than actual processing costs

    Common Mistakes to Avoid

    ❌ Exposing secret keys in client-side code

    ❌ Committing API keys to GitHub/version control

    ❌ Setting fees too high (>4% often hurts conversion)

    ❌ Not testing thoroughly before going live

    ❌ Forgetting to update production environment variables

    ❌ Using production keys in development


    Summary

    Congratulations on completing onboarding! You now have:

    ✅ Stripe account connected

    ✅ Earning potential analyzed

    ✅ Convenience fees configured

    ✅ API keys generated

    ✅ Integration guide available

    Next: Start integrating the SDK into your application and test in development mode. When ready, create production keys and go live!

    Welcome to Sir Chargly - let's maximize your revenue together! 🚀

    Ready to start charging convenience fees?

    Create your account and complete onboarding in minutes.

    No credit card required • 5-minute setup