Stripe
Takes card payments online through the workspace's own Stripe account. Customers pay invoices, shop orders, event tickets and course places on Stripe's secure page, the money settles straight into your account, and refunds go back the same way.
| At a glance | |
|---|---|
| Type | Add-on module |
| Group | Bill |
| Price | Free (Stripe charges its own fees on your account) |
| Provides | Take payments online, Generate payment links |
| Needs | The Payments module |
| Offered to | Every industry pack |
| Permission | Manage add-ons (addons.manage) to switch it on; Manage settings to connect the account |
What it does
Stripe is a payment gateway add-on module of Payments. While it is on and connected, Payments can:
- take card payment online on an invoice's pay page (the shared receipt link and the customer portal), at the online shop's checkout, for event tickets, for course places and at the self-order kiosk. The customer pays on Stripe's own checkout page and comes back;
- let staff Collect online on an invoice, with a Stripe page to send the customer;
- send money back through Stripe when a payment is refunded, and refund by itself a payment that arrived after its bill was already settled;
- make pay-now links, sent by text or WhatsApp (they need an SMS or WhatsApp add-on module as well);
- pay Subscriptions renewal bills automatically: the customer saves a card once on Stripe's own page (nothing is charged then), and each renewal bill is charged to it by itself.
Stripe takes payments in the workspace's own currency, where Stripe records it the way the workspace does (most two-decimal currencies, and the zero-decimal ones such as JPY). The card says when it cannot.
Switching it on
- Switch on Payments first (Workspace → Modules). Stripe needs it, so the switch is refused while Payments is off.
- Set the filter to Add-on modules. Stripe is under Bill.
- Open its ⋮ menu, choose Enable, and press Enable in the dialog. There is nothing to fill in there.
- Choose Connect under Settings → Payments on its ⋮ menu and connect your account (below).
Connecting your Stripe account
Settings → Payments, provider Stripe - cards:
| Field | What to enter |
|---|---|
| Stripe secret key | A restricted key (rk_live_…) with only Checkout Sessions and Refunds set to Write is the safest choice; for automatic subscription payments it also needs Customers, PaymentIntents and PaymentMethods set to Write, and SetupIntents to Read. A secret key (sk_live_…) works too. _test_ keys are test mode. Write-only. |
| Webhook signing secret | whsec_…, shown on the webhook endpoint in your Stripe dashboard. Only its last four characters are ever shown again. |
| Accept payments through this gateway | Tick it to take payments. Needs the key. |
The webhook. Copy the Webhook address from the card and add it in your Stripe dashboard as a webhook endpoint, with the API version and the events the card lists. Without it a payment is recorded only when the customer comes back from Stripe's page.
One gateway takes payments at a time. To move to another, switch this one's Accept payments off first.
Turning it off
Turn off on the ⋮ menu asks first. New online payments through Stripe stop at once, and Stripe leaves Settings → Payments. Payments already under way are still recorded when Stripe confirms them, refunds of earlier payments still go back through it, and the key stays saved for when it is switched on again. While Stripe is on, Payments cannot be switched off.
Ready-made automations
None of its own. The moments around a payment (one that fails, a pay-now link to send) are the Payments module's ready-made automations.
In the desktop and mobile apps
Not carried. The apps take payment at the counter.