Overview
This tutorial on SMS Stripe Integration provides a guide for users on integrating Stripe payment processing within the eSkilled Student Management System (SMS). It covers steps to retrieve Stripe API keys, configure Stripe settings in the SMS, and ensure proper setup for both test and live environments.
Step Tutorial
Part 1 - Retrieve Stripe API Keys
Upon registration with Stripe, you will receive a total of four keys: a publishable and secret key pair for both test and live modes (once the account is activated). These keys can be found on the API Keys page in the Developers Dashboard.
Sample Stripe API Keys Page (make sure to view Live API keys):
1. Log in to your eSkilled SMS with your Administrator account and go to Settings. Under the Payment & Declaration tab, enter/select the following information:
Payment Type: Stripe Stripe Secret Key: Your Stripe Secret Key Stripe Publishable Key: Your Stripe Publishable Key
2. Once done, click on the Update button.
Part 3 - How to Test if your Stripe integration is Working
How to Test if your Stripe integration is Working (in TEST MODE)
1. In your Stripe Dashboard, toggle to enable Test Mode
.
2. Set up Webhooks as per standard Stripe set-up instructions.
3. Using the Stripe test keys, update your Stripe Information in the SMS Settings
4. In your SMS, create a test Program Instance and a Group.
5. Under Financial, set up your Program Fees.
6. Select a payment plan.
NOTE: If you plan to use payment plans with multiple instalments, ensure that you apply a payment rule designed to handle multiple payments. This setup will enable you to verify that subsequent invoices successfully save the card information, in addition to ensuring the initial payment processes correctly.
However, if payments will always be made upfront, use a payment plan with only one payment rule for simplicity.
What to check under your Test Student's Financial tab
- The intial invoice is paid
- Subsequent invoices have the card saved
How to Test if your Stripe integration is working (in LIVE MODE)
Setting Up your SMS and Stripe for Live Mode (Actual Use)
1. In your Stripe Dashboard, disable Test Mode.
2. Set up Webhooks as per standard Stripe set-up instructions.
3. Update your Stripe Information in the SMS using your Stripe live keys.
WARNING: Testing in LIVE MODE WILL CHARGE THE CREDIT/DEBIT CARD USED. PLEASE ONLY USE THIS METHOD FOR TESTING IF ABSOLUTELY NECESSARY.
IT IS IMPORTANT TO ADD ONLY A SMALL AMOUNT (minimum of $1) IN YOUR PAYMENT PLAN WHEN TESTING IN LIVE MODE TO AVOID EXCESS CREDIT CARD CHARGES.
1. In the SMS, create a test Program Instance and a Group.
2. Under Financial, set up your Program Fees. Note: Use a minimum of $1.00 to test
3. Select a payment plan that has multiple payment rules. Note: atleast 2 payments
4. Enrol a test student and pay using an active credit card or debit card.
5. Check the created invoices and if the payment was processed according to your payment plan rules.
What to check under your Test Student's Financial tab
- The intial invoice is paid
- Subsequent invoices have the card saved
IMPORTANT: Once a full test has been carried out, you can then remove the stored card information and/or delete the invoices to avoid getting charged.
Congratulations on completing this tutorial. We hope this
has been helpful to you and your organisation. For any questions or concerns
regarding this function, please reach out to the contact support via email.