> For the complete documentation index, see [llms.txt](https://docs.sensepass.com/sensepay/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sensepass.com/sensepay/platforms/bigcommerce.md).

# BigCommerce

The SensePass app for BigCommerce adds the payment methods of your SensePass location to your BigCommerce checkout, for example credit card, Google Pay, Apple Pay, ACH and Truemed - Pay with HSA/FSA. You choose how payments are taken (capture at checkout or authorization), the order of the payment options, and how the checkout looks.

### Before you begin

* A SensePass merchant API key. You create merchant API keys in SensePass Partners (Developer > Merchant API).
* A SensePass location with the payment methods you want to offer.
* Admin access to your BigCommerce store.

### Install the app

1. In the BigCommerce marketplace, search for **SensePass** and click **Install** (direct link: <https://www.bigcommerce.com/apps/sensepass/>).
2. Select the check box and click **Confirm**.
3. In the SensePass app, click **Let's begin**.
4. Enter your SensePass **API key**.
5. Select the environment: **Production** for your live store, **Sandbox** for testing only.
6. Confirm the settings. The **Checkout settings** screen opens.

### Configure checkout settings

In BigCommerce, go to **Apps** and open the SensePass app. The **Checkout settings** screen shows the settings on the left and a live **Preview** of the checkout on the right.

| Setting                         | What it does                                                                                                                                                               |
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Location**                    | The SensePass location that processes the payments. Its payment methods are listed under **SensePass option order**.                                                       |
| **Method type**                 | **Capture**: the funds are captured at checkout. **Authorization**: the funds are held and captured later.                                                                 |
| **Capture mode**                | Shown only when **Method type** is **Authorization**: **Manual capture** or **Automatic capture**. The default is **Manual capture**. See **Choose a capture mode** below. |
| **Theme**                       | The layout of the payment options at checkout (**Vertical**).                                                                                                              |
| **Payment options shown first** | Which payment options appear first at checkout, for example **SensePass options**.                                                                                         |
| **SDK version**                 | The version of the SensePass checkout used by your store.                                                                                                                  |
| **SensePass option order**      | The payment methods enabled for the location. Use the up and down arrows to set their order at checkout. The preview follows this order.                                   |

Click **Save**. Your checkout shows the payment options as configured.

* The settings apply to every payment method on the location, including Truemed - Pay with HSA/FSA.
* A change applies to new orders only. Orders that are already authorized keep the capture mode they were created with.

#### Choose a capture mode

When **Method type** is **Authorization**, select a **Capture mode**. The right side of the screen shows the **Resulting transaction flow** and the **Order in BigCommerce after checkout**.

| Capture mode          | What happens                                                                                      | Payment status in BigCommerce | Order status in BigCommerce | Your action       |
| --------------------- | ------------------------------------------------------------------------------------------------- | ----------------------------- | --------------------------- | ----------------- |
| **Manual capture**    | The transaction stays Authorized until you capture it from BigCommerce or the Merchant Dashboard. | Authorized                    | Awaiting Payment            | Capture the order |
| **Automatic capture** | The funds are captured right after the authorization is approved, for the full authorized amount. | Captured                      | Awaiting Fulfillment        | None              |

Capture mode is a new setting. If you do not see it yet, your store uses **Manual capture**.

When to use each mode:

| Business scenario                                            | Recommended mode                                     |
| ------------------------------------------------------------ | ---------------------------------------------------- |
| Goods shipped after an inventory check or preparation        | Manual: charge only when the order is ready to ship  |
| Orders that may change or be canceled before shipping        | Manual: cancel the authorization with no refund fees |
| Immediate fulfillment, services or digital goods             | Automatic                                            |
| Truemed orders, when you want the funds collected right away | Automatic                                            |

### Order statuses

Each order has a SensePass transaction status and a BigCommerce order status. The tables below show how they change for a Truemed - Pay with HSA/FSA order. Truemed is an asynchronous payment: after the customer places the order, the order waits until Truemed approves the payment.

#### Method type: Capture

| Step                                                               | SensePass status | BigCommerce order status     |
| ------------------------------------------------------------------ | ---------------- | ---------------------------- |
| The customer enters the Truemed details and clicks **Place order** | Pending          | Manual Verification Required |
| Truemed approves the transaction                                   | Payment approved | Awaiting Fulfillment         |

#### Method type: Authorization, Manual capture

| Step                                                                     | SensePass status                                                          | BigCommerce order status     |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------- | ---------------------------- |
| The customer enters the Truemed details and clicks **Place order**       | Pending                                                                   | Manual Verification Required |
| Truemed approves the transaction                                         | Authorize Approved                                                        | Awaiting Payment             |
| You capture the order by changing its status to **Awaiting Fulfillment** | A payment transaction is created from the authorization: Payment approved | Awaiting Fulfillment         |

#### Method type: Authorization, Automatic capture

| Step                                                               | SensePass status                                                                              | BigCommerce order status     |
| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- | ---------------------------- |
| The customer enters the Truemed details and clicks **Place order** | Pending                                                                                       | Manual Verification Required |
| Truemed approves the transaction                                   | Authorize Approved, and a payment transaction is created from the authorization automatically | Awaiting Fulfillment         |

### Capture an authorized order (Manual capture)

1. Open the order in BigCommerce and check that the order status is **Awaiting Payment**.
2. Change the order status to **Awaiting Fulfillment**.
3. Check the capture result in the order notes. After a successful capture, the payment status is **Captured**.

### If an automatic capture fails

The transaction stays Authorized, a note is added to the BigCommerce order and you are notified. Capture the order manually (see above) or from the Merchant Dashboard.

### Cancel an order

* An authorized order that was not captured yet can be canceled with no refund fees.
* Canceling an order after it was captured is processed as a refund, according to your location's refund policy.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sensepass.com/sensepay/platforms/bigcommerce.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
