The below is a general guide for each gateway available within MINIBC. The instructions below assume you’re logged into both your gateway with the proper permission and your BigCommerce account with access to the MINIBC application.
Setup - Authorize.net
Setup - Braintree by PayPal
Setup - Stripe
Setup - NMI
Setup - USAePay
If you don’t see the gateway you require assistance with please contact our support team or your Project Manager.
Setup - Authorize.net
For MINIBC to work with Authorize.net, we require that the Customer information Manager (CIM) feature be enabled. To setup the gateway within MINIBC the following fields are required:
API Login ID
Transaction Key
Public Client Key
Account ID
Signature Key
Locating Items:
- API Login ID: This can be found under Account -> API Credentials & Keys.
- Transaction Key: This can be found under Account -> API Credentials & Keys. Note that if you have an existing key for an in-use store, it is recommended to continue using that key as you risk deactivating the existing key and causing issues with that store.
- Public Client Key: This can be found under Account -> Manage Public Client Key.
- Account ID: This can be found under your Profile, under the Accounts title. You'll see a value that begins with acct_ and that is the value you need to place in this field.
- Signing Key: This can be found under Account -> API Credentials & Keys. Note that if you have an existing key for an in-use store, it is recommended to continue using that key as you risk deactivating the existing key and causing issues with that store.
After all items have been located and added to MINIBC (and BigCommerce where needed) you can reach out to our support team or your Project Manager to move forward.
Setup - Braintree by PayPal
For MINIBC to work with Braintree, we require that you have a Braintree Direct account. This account type enables API access which is required by MINIBC. To setup the gateway within MINIBC the following fields are required:
Merchant ID
Merchant Account ID
Public Key
Private Key
Locating Items:
- Merchant ID: This can be found by clicking the “gear” in the upper right and navigating to Business. The merchant id can be found near the top of the page.
- Merchant Account ID: This can be found by clicking the “gear” in the upper right and navigating to Business. The merchant account id can be found in the middle of the page; it will be beside the area with the credit card logos and currency display.
- Public Key: This can be found by clicking the “gear” in the upper right and navigating to API. Once on the API page the public key should be visible.
- Private Key: This can be found by clicking the “gear” in the upper right and navigating to API. Once on the API page the private key requires you to click “view” and then copy the key. The Private Key is longer than the Public Key.
After all items have been located and added to MINIBC (and BigCommerce where needed) you can reach out to our support team or your Project Manager to move forward.
Setup - Stripe
To setup the gateway within MINIBC the following fields are required:
Publishable Key
Account ID
Secret Key
Signing Secret
Locating Items:
- Publishable Key: Click on Developers and then choose API keys from the left navigation. This key starts with “pk_live” or “pk_test” depending on which environment you’re setting up. The publishable key should be variable and can be copied into MINIBC.
- Secret Key: Click on Developers and then choose API keys from the left navigation. The secret key will be hidden and need to be revealed. This key starts with “sk_live” or “sk_test” depending on which environment you’re setting up. Copy the revealed key into MINIBC.
- Account ID: Click on the "Gear" icon and choose Profile from the drop-down. At the bottom of the Profile page is section titled Accounts. Below this title is a table, within that table, you want to find the "ID" column and the value that begins with acct_, copy this value into MINIBC.
- Signing Secret: See below.
Setting Up Webhook Notifications and Signing Secret:
Stripe allows MINIBC to receive webhook notifications of specific events that can impact orders and tokenized cards. Follow the below guide to set up these notifications.
- In MINIBC location your Webhook Notification URL and have that handy.
- In Stripe, navigate to Developers -> Webhooks
- Choose Add EndPoint
- Within the end-point creation screen:
- Enter the MINIBC Webhook Notification URL into the Endpoint URL
- Add a description if you so choose.
- For “Listen to” select “Events on your account”
- Then under “Select Events” choose/enable the following:
charge.captured
charge.expired
charge.failed
charge.pending
charge.refund.updated
charge.refunded
charge.succeeded
charge.updated
payment_intent.succeeded
payment_method.card_automatically_updated
payment_method.detached
payment_method.updated
Once chosen, you can click “Create”.
- On the webhook panel, choose the webhook that was just created. Under Signing secret, click to review the code. It should start with “whsec_” copy this code into MINIBC.
After all items have been located and added to MINIBC (and BigCommerce where needed) you can reach out to our support team or your Project Manager to move forward.
Setup - NMI
To setup the gateway within MINIBC the following fields are required:
Username
Password
Processor ID
API Key
Locating Items:
-
Username & Password: This is the username and password you use to login to your account. You have the option of creating MINIBC its own user or providing your current login credentials. Note that if/when you update your password, this password needs to be updated within MINIBC as well.
-
Processor ID: If you’re running a single processor you’ll need to check with your NMI agent or customer support to gather this value. If you’re running multiple processors you can find (or choose) a processor by navigating to Options -> Settings -> Transaction Routing and gathering your preferred Processor ID.
-
API Key: This can be found/created by navigating using the side menu; Options -> Settings -> Security Keys. If not already created, choose the “Add a New Private Key” and complete the form. You can name the API key (MINIBC or similar) for easy identification and also assign it to the main account holder or the “MINIBC” user if you choose to create one. For Key Permission choose “API” during the process. Once created, copy the API key into MINIBC.
After all items have been located and added to MINIBC (and BigCommerce where needed) you can reach out to our support team or your Project Manager to move forward.
Setup - USAePay
To setup the gateway within MINIBC the following fields are required:
Source Key
PIN
Locating Items:
-
Source Key: This item can be found/created under, Settings -> API Keys. WIthin this panel you can either create a new API key set (and name it as needed); or access an existing API key and copy the key already created. Copy the API Key from the panel and add this to MINIBC.
-
PIN: This item can be found within the API details panel. It should be the item above the API Key you copied in the above step. Copy this PIN from the panel and add this to MINIBC.
After all items have been located and added to MINIBC (and BigCommerce where needed) you can reach out to our support team or your Project Manager to move forward.