BigCommerce
Last updated: April 23, 2025
To start using BigCommerce's Checkout.com plugin, you must first set up and test your integration in the Test environment, and then move your integration to the Live environment.
To use the Checkout.com plugin, your BigCommerce store must use Optimized One-Page Checkout.
Before you configure the plugin, you must create a public and private key.
- Sign in to the Test environment in the Dashboard.
- Select the Developers icon in the top navigation bar and open the Keys tab.
- Select Create a new key.
- Under Type of key, select Public API key.
- Give the API key a description. This will help you identify what it's used for.
- Disable the Allow any processing channel setting.
- Select the processing channel you want to use for BigCommerce payments from the list.
- Select Create key.
- Copy your public API key. You'll need it to configure the plugin.
Information
You can view your public API key in the Dashboard at any time.
- Sign in to the Test environment in the Dashboard.
- Select the Developers icon in the top navigation bar and open the Keys tab.
- Select Create a new key.
- Under Type of key, select Secret API key.
- Give the API key a description. This will help you identify what it's used for.
- Under Scopes, select Default.
- Disable the Allow any processing channel setting.
- Select the processing channel you want to use for BigCommerce payments from the list.
- Select Create key.
- Copy your private API key securely. You'll need it to configure the plugin.
Information
For security, you cannot view the private API key again after you've left the Create a new key page. Ensure you copy its value securely before you exit or close the window.
In your BigCommerce dashboard:
- Go to Settings > Payments, and select Set up next to the Checkout.com option in the list of online payment methods.
- In the Checkout.com settings page, configure your plugin using the following options:
- Display Name: Enter an alphanumeric value to describe the plugin.
- API Private Key: Enter the private API key you generated in the Dashboard, prefixed with
Bearer. For example,Bearer <SECRET_KEY>. - API Public Key: Enter the public key you created in the Dashboard.
- Transaction Type: Select Authorize and capture for auto captures, or Authorize only, for manual captures.
- Test Mode: Enabling this option marks all transactions as tests and routes the transactions to the test environment.
- Enable 3D Secure: Select this option to enable 3D Secure fraud protection with Checkout.com.
- Stored Credit Cards: Select Enable stored credit cards with Checkout.com to store your customer's credit card details.
- Displayed Cards: Select the credit card brands that you want to show next to the payment method during checkout.
- Select Save changes.