Integrations
Overviewโ
Third-party integrations extend your school management system with powerful capabilities:
- Payment Gateways - Accept online fee payments
- SMS Providers - Send text message notifications
- Email Services - Deliver email notifications at scale
- SSO Providers - Enable single sign-on (Google, Microsoft)
๐ณ Payment Gateway Integrationโ
Enable parents to pay school fees online through secure payment gateways.
Supported Payment Gatewaysโ
Nigeria:
- Paystack (Recommended)
- Flutterwave
- Razorpay
- Stripe (International)
India:
- Razorpay
- Instamojo
- Paytm
Global:
- Stripe
- PayPal
Paystack Integration (Nigeria)โ
Step 1: Create Paystack Account
- Go to paystack.com
- Sign up for a business account
- Complete KYC verification
- Navigate to Settings โ API Keys & Webhooks
Step 2: Get API Keys
- Copy your Public Key (starts with
pk_) - Copy your Secret Key (starts with
sk_) - For testing, use Test Keys first
- For production, use Live Keys after verification
Step 3: Configure in School System
- Log in as School Admin
- Go to Settings โ Payment Settings (or Fees โ Payment Gateway)
- Select Paystack from provider dropdown
- Enter:
- Public Key - Paste your Paystack public key
- Secret Key - Paste your Paystack secret key
- Mode - Select "Test" or "Live"
- Click Save
Step 4: Set Up Webhook
- Copy the Webhook URL shown in your payment settings (e.g.,
https://yourschool.com/api/paystack/webhook) - Go back to Paystack Dashboard โ Settings โ API Keys & Webhooks
- Click Add Webhook
- Paste your webhook URL
- Save webhook
Step 5: Test Payment
- Go to a parent account
- Navigate to Fees โ Pay Fees
- Select an amount and click Pay Online
- Use Paystack test card:
- Card Number: 4084084084084081
- Expiry: Any future date
- CVV: 408
- PIN: 0000
- Verify payment shows as successful in admin dashboard
Paystack Fees:
- 1.5% + โฆ100 capped at โฆ2,000 per transaction
- No setup fees or monthly charges
For detailed Paystack API docs, visit: paystack.com/docs
Flutterwave Integration (Nigeria)โ
Step 1: Create Flutterwave Account
- Go to flutterwave.com
- Sign up and complete verification
- Go to Settings โ API Keys
Step 2: Get API Credentials
- Copy Public Key
- Copy Secret Key
- Copy Encryption Key
Step 3: Configure in School System
- Go to Settings โ Payment Settings
- Select Flutterwave
- Enter:
- Public Key
- Secret Key
- Encryption Key
- Mode - Test or Live
- Click Save
Step 4: Webhook Setup
- Copy webhook URL from payment settings
- In Flutterwave Dashboard โ Settings โ Webhooks
- Add your webhook URL
- Save
Test Cards:
- Card: 5531886652142950
- CVV: 564
- Expiry: Any future date
- OTP: 12345
Flutterwave Fees:
- 1.4% local cards
- 3.8% international cards
- No hidden charges
Razorpay Integration (India)โ
Step 1: Create Razorpay Account
- Go to razorpay.com
- Sign up and complete KYC
- Navigate to Settings โ API Keys
Step 2: Generate API Keys
- Click Generate Test Keys (for testing)
- Click Generate Live Keys (for production, after activation)
- Copy Key ID and Key Secret
Step 3: Configure in School System
- Go to Settings โ Payment Settings
- Select Razorpay
- Enter:
- Key ID
- Key Secret
- Mode - Test or Live
- Click Save
Step 4: Webhook Configuration
- Copy webhook URL from settings
- Go to Razorpay Dashboard โ Settings โ Webhooks
- Click Add New Webhook
- Enter webhook URL
- Select events:
payment.captured,payment.failed - Save
Test Details:
- Use any card details for test mode
- Razorpay provides a test card number generator
Razorpay Fees:
- 2% per transaction (negotiable for schools)
- No setup or annual fees
Stripe Integration (International)โ
Step 1: Create Stripe Account
- Go to stripe.com
- Sign up and complete verification
- Go to Developers โ API Keys
Step 2: Get API Keys
- Copy Publishable Key (starts with
pk_) - Copy Secret Key (starts with
sk_) - Use test keys for testing, live keys for production
Step 3: Configure in School System
- Go to Settings โ Payment Settings
- Select Stripe
- Enter:
- Publishable Key
- Secret Key
- Mode - Test or Live
- Click Save
Step 4: Webhook Setup
- Copy webhook URL
- Go to Stripe Dashboard โ Developers โ Webhooks
- Click Add Endpoint
- Paste webhook URL
- Select events:
payment_intent.succeeded,payment_intent.payment_failed - Save
Test Card:
- Number: 4242 4242 4242 4242
- Expiry: Any future date
- CVC: Any 3 digits
Stripe Fees:
- 2.9% + $0.30 per transaction (US)
- Varies by country
๐ฑ SMS Gateway Integrationโ
Send text message notifications for attendance alerts, fee reminders, and important announcements.
Supported SMS Providersโ
Nigeria:
- Termii (Recommended)
- Africa's Talking
India:
- Msg91
- TextLocal
Global:
- Twilio
- Nexmo (Vonage)
Termii Integration (Nigeria)โ
Step 1: Create Termii Account
- Go to termii.com
- Sign up for business account
- Complete verification
- Navigate to API Settings
Step 2: Get API Credentials
- Copy your API Key
- Note your Sender ID (e.g., "YourSchool")
- Fund your account (buy SMS credits)
Step 3: Register Sender ID
- Go to Sender ID section
- Submit your school name as sender ID
- Wait for approval (usually 24-48 hours)
Step 4: Configure in School System
- Go to Settings โ SMS Settings
- Select Termii from provider dropdown
- Enter:
- API Key
- Sender ID (approved sender ID)
- Click Save
Step 5: Test SMS
- Click Send Test SMS
- Enter a Nigerian mobile number (format: 2348012345678)
- Click Send
- Verify SMS received
Termii Pricing:
- โฆ2.50 - โฆ4.00 per SMS (varies by volume)
- Bulk discounts available
- No monthly fees
Use a clear, recognizable sender ID like your school name. Avoid generic names. This improves delivery rates and trust.
Twilio Integration (Global)โ
Step 1: Create Twilio Account
- Go to twilio.com
- Sign up (free trial includes credits)
- Verify your phone number
- Go to Console Dashboard
Step 2: Get Credentials
- Copy Account SID
- Copy Auth Token
- Get a Twilio Phone Number (or use Messaging Service SID)
Step 3: Configure in School System
- Go to Settings โ SMS Settings
- Select Twilio
- Enter:
- Account SID
- Auth Token
- From Number (your Twilio phone number with country code, e.g., +234XXXXXXXXXX)
- Click Save
Step 4: Test
- Send test SMS
- Check delivery in Twilio Console โ Messaging โ Logs
Twilio Pricing:
- $0.0075 per SMS (US)
- Varies by destination country
- $1/month per phone number
Msg91 Integration (India)โ
Step 1: Create Msg91 Account
- Go to msg91.com
- Sign up and verify
- Go to API section
Step 2: Get API Key
- Copy your Auth Key
- Note your Sender ID
- Create a Template (required by TRAI regulations)
Step 3: Create Message Templates
- Go to SMS โ Templates
- Create templates for:
- Attendance alert
- Fee reminder
- Exam notification
- Submit for DLT approval
- Wait for approval (24-48 hours)
Step 4: Configure in School System
- Go to Settings โ SMS Settings
- Select Msg91
- Enter:
- Auth Key
- Sender ID
- Template IDs (for different message types)
- Click Save
Msg91 Pricing:
- โน0.15 - โน0.25 per SMS
- Volume discounts available
Indian SMS regulations require all messages to use pre-approved templates. Ensure templates are approved before going live.
๐ง Email Service Provider Integrationโ
For high-volume email sending (newsletters, bulk notifications), use dedicated email services instead of regular SMTP.
Supported Email Providersโ
- SendGrid (Recommended for bulk)
- Mailgun
- Amazon SES
- Mailchimp (for newsletters)
SendGrid Integrationโ
Step 1: Create SendGrid Account
- Go to sendgrid.com
- Sign up (free tier: 100 emails/day)
- Complete sender verification
- Go to Settings โ API Keys
Step 2: Create API Key
- Click Create API Key
- Name it (e.g., "School System")
- Select Full Access or Restricted Access (choose Mail Send permissions)
- Copy the API Key (you won't see it again!)
Step 3: Verify Sender Domain
- Go to Settings โ Sender Authentication
- Click Verify a Single Sender (for quick start) or
- Authenticate Your Domain (for production - recommended)
- Follow verification steps
Step 4: Configure in School System
- Go to Settings โ Email Settings
- Select SendGrid or configure as SMTP:
- Mail Host: smtp.sendgrid.net
- Mail Port: 587
- Mail Username: apikey
- Mail Password: [Your SendGrid API Key]
- Mail Encryption: TLS
- Mail From Address: noreply@yourschool.com
- Mail From Name: Your School Name
- Click Save
Step 5: Test
- Send test email
- Check delivery in SendGrid Dashboard โ Activity
SendGrid Pricing:
- Free: 100 emails/day
- Essentials: $19.95/month (50,000 emails)
- Pro: $89.95/month (100,000 emails)
Authenticate your domain (not just single sender) to improve deliverability and avoid spam filters. This requires adding DNS records.
Mailgun Integrationโ
Step 1: Create Mailgun Account
- Go to mailgun.com
- Sign up (free tier: 5,000 emails/month for 3 months)
- Add and verify your domain
Step 2: Get SMTP Credentials
- Go to Sending โ Domain Settings
- Select your domain
- Note SMTP credentials:
- SMTP Hostname: smtp.mailgun.org
- Port: 587 (TLS) or 465 (SSL)
- Username: postmaster@yourdomain.com
- Password: (shown in dashboard)
Step 3: Configure in School System
- Go to Settings โ Email Settings
- Enter Mailgun SMTP details
- Save and test
Mailgun Pricing:
- Free: 5,000 emails/month (first 3 months)
- Foundation: $35/month (50,000 emails)
- Growth: $80/month (100,000 emails)
Amazon SES Integrationโ
Step 1: Create AWS Account
- Go to aws.amazon.com
- Sign up and navigate to SES (Simple Email Service)
- Verify email addresses or domain
Step 2: Create SMTP Credentials
- In SES Console โ SMTP Settings
- Click Create My SMTP Credentials
- Download credentials (username and password)
Step 3: Request Production Access
- By default, SES is in sandbox mode (can only send to verified emails)
- Request production access via Account Dashboard
- Wait for approval (usually 24 hours)
Step 4: Configure in School System
- Go to Settings โ Email Settings
- Enter:
- Mail Host: email-smtp.[region].amazonaws.com (e.g., email-smtp.us-east-1.amazonaws.com)
- Mail Port: 587
- Mail Username: [SMTP username from step 2]
- Mail Password: [SMTP password from step 2]
- Mail Encryption: TLS
- Save and test
Amazon SES Pricing:
- $0.10 per 1,000 emails
- Very cost-effective for high volumes
- Free tier: 62,000 emails/month if sending from EC2
๐ Troubleshooting Integrationsโ
Payment Gateway Issuesโ
Problem: Payments not processing
Solutions:
- Check API keys - Ensure correct public and secret keys
- Verify mode - Test keys in test mode, live keys in live mode
- Check webhook URL - Must be publicly accessible (not localhost)
- Review gateway logs - Check provider dashboard for error messages
- Verify KYC - Account must be fully verified for live mode
- Check currency - Ensure currency matches gateway support (e.g., NGN for Paystack)
SMS Not Deliveringโ
Problem: SMS not received
Solutions:
- Check balance - Ensure SMS provider account has sufficient credits
- Verify sender ID - Must be approved by provider
- Check number format - Include country code (e.g., +234 for Nigeria)
- DLT compliance (India) - Message must match approved template
- Review logs - Check SMS provider dashboard for failed deliveries
- Network issues - Recipient's network may be down
Email Delivery Issuesโ
Problem: Emails going to spam or not delivered
Solutions:
- Authenticate domain - Set up SPF, DKIM, DMARC records
- Use dedicated email service - Don't use Gmail for bulk sending
- Warm up IP - Gradually increase sending volume
- Clean email list - Remove bounced/invalid addresses
- Avoid spam words - Don't use "FREE", "WINNER", excessive caps in subject
- Include unsubscribe link - Required for bulk emails
๐ Related Featuresโ
- Notification Settings - Configuring FCM, SMTP, SMS
- Fee Management - Online fee payment workflows
- School Admin Guide - System settings and configuration
Summary Checklistโ
Payment Gateway Setup:
- โ Create account with payment provider
- โ Complete KYC verification
- โ Get API keys (public and secret)
- โ Configure in school system
- โ Set up webhook URL
- โ Test with test cards/credentials
- โ Switch to live mode after testing
SMS Gateway Setup:
- โ Create account with SMS provider
- โ Register and get sender ID approved
- โ Fund account with credits
- โ Get API key/credentials
- โ Create message templates (if required)
- โ Configure in school system
- โ Send test SMS
Email Service Setup:
- โ Create account with email provider
- โ Verify sender domain/email
- โ Get SMTP credentials or API key
- โ Configure in school system
- โ Set up SPF/DKIM records
- โ Send test email
- โ Monitor deliverability
Third-party integrations unlock powerful capabilities for your school. Take time to set them up correctly, and they'll serve you reliably for years! ๐โจ