Help Guides

Stripe Setup Guide/Tutorial

We no longer provide support for Stripe Direct Debit issues. Card payments with Stripe are working perfectly without issues but direct debit has been problematic with Stripe's API holding payments as "pending" and not providing any support to resolve matters with our users. We therefore recommend using GoCardless for Direct Debits. You can still set up stripe if you want to take card payments.
Use the "Step Complete" button to track your progress.
  1. Create a Stripe account at https://stripe.com
    Please Note: We cannot offer assistance in creating a Stripe account. Please contact stripe support for help on getting started.
  2. Log into Stripe and switch to "test mode" (new Stripe accounts are already in test mode) » Click "Developers" on the left menu » Then API keys
  3. On IBEAMS, go to Settings (Left Menu or from the top right under your name) and click on "Payment Gateways"
  4. Enter the keys here. Note: Live keys are for live payments and Test keys are for testing.
  5. Click the Test keys and Set up Webhooks automatically for the live mode.. also for Test Mode if you're testing and wait for confirmation.
  6. It is important you specify your parent portal URL on the settings page to authorise card payment sessions by URL.

How to add all payments to their invoices automatically as the payment is received?

There is no longer a need to do this yourself. Step 5 above has already connected your payments received to the system so receipts are sent and payments are entered to their invoices.

Parents will only see the card option if the following conditions are met:

  1. Stripe gateway is enabled on settings
  2. The parent portal URL matches your actual parent portal URL
  3. The Live API keys are specified on settings
  4. The parent portal is running on HTTPS
  5. You have set a company name on Stripe and activated Stripe (most users tend to forgot this step)

Parents will only see the direct debit option if:

  • Stripe is set up
  • Direct debit is enabled from the Payment Gateway page in Settings

How to test the integration:

  1. Add a test student if you don't have a test student for testing in the database.
  2. Add yourself as a contact here if you are not added as a contact already.
  3. Search your name on the contacts page and in the result, switch "Tester" to for your account.
  4. Ensure test mode is on on the settings page (this will only apply to you)
  5. Create an invoice for the test student and login to parent portal to pay the invoice
  6. Use the test card, 4111 1111 1111 1111, expiry should be set in the future (any date), and the CVV (3 digits), name, address, postcode can be anything at all.
  7. Upon completion, check that the invoice is paid.
Important final note: Once you have successfully done this, remember to add the endpoint in the same way for live mode on Stripe (See number 5. above)
« Back to Card/Direct Debit
© 2024 - IBEUK | IBEAMS