Payment Gateways
Install, connect, and switch on payment gateway plugins so customers can pay at checkout. Covers credentials, sandbox mode, icons, and the Connect step.
The Payment Gateways tab lists every payment method installed in your billing system and lets you switch each one on or off. Every gateway is delivered as a plugin — there are no processors built into the core product. You add a gateway plugin, enter its credentials and checkout appearance on the Plugins page, and then enable it so customers can pay invoices and orders at checkout.

Where to find it
Open Settings from the admin sidebar, expand the Financial group, and click Payment Gateways. This tab is the on/off control center. The credentials and display details for each gateway are configured separately on the Plugins page (Settings → Integrations → Plugins) — see the steps below.
What's on this tab
- Plugin-Based Payment Gateways banner — an information notice at the top explaining that gateways are managed through plugins: enable a gateway plugin, then configure its credentials to start accepting payments.
- Gateway cards — one card for each installed payment-gateway plugin. Each card shows the gateway's icon, its display name, the version number, and a short description. Plugins you built yourself in the plugin builder also carry a small Visual label.
- Status badges — a card may show a Connected, Failed, or Unknown badge reflecting the last known connection result, alongside an Enabled or Disabled badge for its current state.
- On/off toggle — the switch on the right of each card turns the gateway on or off immediately, with no further confirmation step.
- Empty state — if no payment-gateway plugins are installed, the tab shows a No Payment Gateways Installed message instead of any cards.
This tab is intentionally simple: it only switches gateways on and off. To enter API keys, choose the checkout name and icon, or connect to a provider, you use the gateway's plugin on the Plugins page.
Install a gateway
- Go to the Plugins page (Settings → Integrations → Plugins).
- Add a payment-gateway plugin — either create one with the plugin builder or import a plugin file.
- Once it is installed, the gateway appears both on the Plugins page and on this Payment Gateways tab.
Configure a gateway's credentials and checkout appearance
All of a gateway's settings live on its plugin. To open them:
- Open the Plugins page (Settings → Integrations → Plugins).
- Find the gateway's card and click the Configure button (the gear button in the bottom-right of the card).
- The configuration window opens. It is a single scrolling panel divided into the sections described below.
- Make your changes, then click Save Configuration at the bottom. A green confirmation appears when the settings are stored.
Payment Method Display
This section controls exactly what customers see when they pick this method at checkout.
| Field | What it does |
|---|---|
| Display name | The label shown to customers (for example, “Credit/Debit Card” or “PayPal Wallet”). You must enter a name before you can save. |
| Description | An optional short line of helper text shown under the name at checkout. |
| Icon | Pick Preset to choose from a grid of built-in icons (credit card, wallet, Bitcoin/crypto, bank building, dollar sign, and more, plus brand marks such as PayPal, Visa, and Mastercard), or Custom URL to point at your own image file. A square image around 64×64px works best. |
| Enabled | A checkbox that makes the gateway available to customers. This mirrors the on/off toggle on the Payment Gateways tab. |
| Sandbox Mode | A checkbox that routes transactions through the provider's test environment instead of charging real money. |
A live Preview box shows how the name, description, and icon will look to customers as you type. When Sandbox Mode is on, the preview displays a yellow Test badge.
Setup checklist (PayPal and Stripe)
For the common card and wallet gateways, the configuration window shows a short numbered checklist plus a link that opens the provider's own dashboard in a new tab, so you can copy the keys you need without hunting through their site.
Credentials and API fields
Below the display section, the gateway's plugin defines its own fields — typically API keys, secrets, and connection details. Sensitive fields are masked; use the eye button beside a field to reveal or hide its value. Fields marked with a red asterisk are required.
Some gateways also show a read-only callback URL with a copy button — paste this into the provider's dashboard so they can notify your billing system about completed payments.
Connect and verification
Gateways that support it show a Connect button (for example, “Connect PayPal” or “Connect Stripe”). Clicking it saves your typed credentials, validates them against the provider, and where supported registers the connection automatically.
- On success, a green badge reads Connected as <your account>, often with the environment (live or sandbox) and the time it was last verified.
- If validation fails, a red Last connection attempt failed message explains the error.
- Once connected, the button changes to Reconnect so you can re-run it after changing keys.
The Connect step both validates your keys and can switch Sandbox Mode to match the environment your keys belong to — if you pasted test keys, it keeps the gateway in sandbox and tells you it did so. Always Connect after changing credentials so the verification badge stays accurate.
Outbound API IP
On plans where it applies, the configuration window also shows an Outbound API IP with a copy button. This is the address your billing system uses when it calls the payment provider. Add it to any IP allowlist the provider offers for an extra layer of security.
Enable or disable a gateway
- On the Payment Gateways tab, flip the toggle on the gateway's card. On turns it on; off turns it off.
- Alternatively, use the Enabled checkbox inside the plugin's configuration window and click Save Configuration.
Enabled gateways appear at checkout; disabled gateways do not. There is no separate confirmation step for the card toggle — the change takes effect right away.
Switch from test to live payments
- Open the gateway's Configure window on the Plugins page.
- Replace any test keys with your live credentials in the credential fields.
- Uncheck Sandbox Mode.
- Click Connect to validate, then Save Configuration.
- Make sure the gateway is Enabled so it shows at checkout.
Test thoroughly in Sandbox Mode before going live. A live gateway charges real cards, so confirm the connection badge shows the correct account and environment first. With Sandbox Mode unchecked, the Preview box drops its yellow Test badge so you can see at a glance that the gateway is live.
Tips and notes
- The Payment Gateways tab and the plugin's Enabled checkbox control the same on/off state — changing one updates the other.
- If a card shows a Failed badge, open the plugin's configuration window, re-check the keys, and use Connect to read the exact error message.
- The display name and icon are purely cosmetic for checkout — they do not affect how the payment is processed.
- Customers only ever see gateways that are enabled; while a gateway is in Sandbox Mode it carries a test indicator so you don't mistake test traffic for real revenue.
