Where to find it
In the admin, click the Settings gear in the top bar. In the Settings sidebar, under Payments, select Gateways. To open the screen, your role needs at least View only for Gateways, in the Settings card on the role’s Permissions tab. To add, edit, or delete gateways, it needs Full access for Gateways. To allow only some actions, open the Gateways area on the role and turn on the switches you want: Set up new payment gateways (add), Edit payment gateway configuration (edit), and Remove payment gateways (delete). The area’s button then shows Custom. To add or edit a gateway, your role also needs at least View only for Payment Integrations and Business Entities, in the Commerce card, and for Company Countries, in the Settings card. With View only, you can see the table, but Add Payment Gateway and the row’s three-dot menu don’t appear, and clicking a row doesn’t open it. See Roles.What’s on the screen
The top bar holds the Add Payment Gateway button. Two alerts can appear above the Credit Card Processing card:- No usable test gateway lists countries that have test mode turned on but no usable test gateway. It warns that card payments will be blocked if company test mode is on. To fix it, assign a usable test gateway in Payment Routing, or turn off test mode for those countries. See What does the No test gateway badge mean?
- Test mode status unavailable appears when the check for countries without a test gateway fails. Click Retry to check again.
Click a row to edit that gateway. The three-dot menu at the end of each row has Edit and Delete.
Add a payment gateway
1
Open the form
Click Add Payment Gateway. The Add Payment Gateway panel opens.
2
Name the gateway
Enter a Display Name. The admin dashboard and storefront show this name. Enter a Reporting Name. CSV exports, event logs, and integrations use this name. Each Reporting Name must be unique among your company’s payment accounts. Both names are required.
3
Choose the gateway
Select a Gateway. You can’t change it after you create the gateway. To use a different one later, add a new gateway.For an NMI gateway, a Processor menu also appears. It’s optional. If you switch from an NMI gateway to a different gateway, the form clears Display Name, Reporting Name, and Entity.
4
Choose countries
Under Available Countries, select at least one country. The list shows your company’s countries, which you manage on Countries.
5
Fill in the gateway's fields
Enter the credentials and any other fields that appear for the gateway. See Fields that depend on the gateway.
6
Set test mode
Turn on Test Only if this is a test gateway. The Type column then shows Sandbox instead of Production.
7
Choose whether it's active
Active is off by default for a new gateway. Turn it on to make the gateway eligible for payment routing. Inactive gateways are skipped by payment routing.A country can’t have an active test gateway and an active live gateway at the same time. If saving fails because a gateway of the other kind is already active in one of the same countries, turn that gateway off first, or remove the overlapping country.
8
Choose transaction types
Under Transaction type eligibility, check the kinds of payments this gateway may process. All three are checked for a new gateway. Keep at least one checked. See Transaction types.
9
Save
Click Add Gateway. A message confirms that the payment account was created, and the gateway appears in the table.
Fields that depend on the gateway
Transaction types
Transaction type eligibility sets which kinds of payments the gateway is allowed to process.
The Purchase Type column in the table shows the checked types as CIT, MIT, and MOTO badges.
Edit a payment gateway
1
Open the gateway
Click the gateway’s row, or open the three-dot menu at the end of the row and click Edit. The Edit Payment Gateway panel opens.
2
Make your changes
Change the fields you need. You can’t change the Gateway.Some saved credentials, such as keys and passwords, appear masked. Clicking a masked field clears it. Leave it empty to keep the saved value, or enter the whole new value to replace it. Saved values for Domain Verification File, Merchant Certificate, and Merchant Key don’t appear. Leave those fields blank to keep them, or enter a new value to replace them.
3
Save
Click Save Changes.
- $0 Verification, for gateways that support it. When it’s on, the gateway uses its native $0 verification instead of a $1 authorization and void when a card is added. Gateways that require an entitlement for it, such as Braintree, fall back to the $1 method when it isn’t available.
- Stripe Connect, for Stripe gateways. See Connect a Stripe gateway.
- 3DS Acquirer Settings, for gateways that support 3DS. See 3DS acquirer settings.
3DS acquirer settings
For a gateway that supports 3DS, the Edit Payment Gateway panel ends with a collapsed 3DS Acquirer Settings section. Click its heading to open it.- Merchant Info (from Entity) shows the Legal Name, Country Code, MCC, and Website used for this gateway. You can’t edit them here. Without an Entity, they come from your company settings. To use different merchant info for this gateway, select an Entity.
- Acquirer Country Code takes a three-letter country code, such as
USA. - Visa (Acquirer) and Mastercard (Acquirer) each have BIN and Merchant ID.
- Amex (Acquirer) and Discover (Acquirer) each have BIN, Merchant ID, Requestor ID, and Requestor Name.
Connect a Stripe gateway
For a saved Stripe gateway, the Edit Payment Gateway panel has a Stripe Connect section. It shows the connection status, such as Authorization pending, Connected — verification in progress, Onboarding incomplete — requirements due, Connected — charges enabled, or Disconnected by merchant. Once there’s a Stripe account, it also shows the account ID, marked live or test. If the gateway isn’t connected to Stripe yet, the section says so.1
Open the gateway
Click the Stripe gateway’s row. The Edit Payment Gateway panel opens.
2
Start the connection
Click Connect existing Stripe account to connect a Stripe account you already have, or Set up a new Stripe account to create one through Stripe. Stripe opens in the same tab, so changes you haven’t saved in the panel are lost.
3
Finish in Stripe
Complete the steps Stripe shows you.
4
Check the status
When Stripe sends you back to the admin, open Gateways in Settings again and click the gateway’s row. The Stripe Connect section shows the new status. Click Refresh status to check it again. If the account is connected but onboarding isn’t finished, click Resume onboarding to continue in Stripe.
Delete a payment gateway
1
Choose Delete
Open the three-dot menu at the end of the gateway’s row and click Delete.
2
Confirm
In the Delete payment gateway? dialog, click Delete. This can’t be undone.
Frequently asked questions
Why won't the gateway save without a transaction type?
Why won't the gateway save without a transaction type?
Every gateway needs at least one transaction type. If none is checked, saving shows Select at least one transaction type for this gateway. Under Transaction type eligibility, check at least one type, and then save again.
Why did saving say the countries changed?
Why did saving say the countries changed?
The gateway’s countries changed after you opened the panel, so your save didn’t go through.
- If the message ends with We reloaded it; please re-apply your changes., the panel now shows the current countries. Make your changes again and save.
- If it ends with Reload and try again., reload the page, open the gateway, and make your changes again.
What if the panel can't load a gateway's countries?
What if the panel can't load a gateway's countries?
Under Available Countries, the panel shows Couldn’t load this account’s countries. You can’t save the gateway until they load. Click Retry, and save after the countries appear.