> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dimepayments.com/llms.txt
> Use this file to discover all available pages before exploring further.

# WooCommerce Setup Guide

> Install and configure the Dime Payments gateway plugin for WooCommerce to accept card and ACH payments at checkout.

## Before you begin

You'll need:

* A **WordPress** site running version 6.0 or newer, with **WooCommerce** version 7.0 or newer installed and active
* **PHP 7.4 or newer** (your hosting provider can confirm this)
* An active **Dime Payments merchant account**
* Your **Merchant ID** and **API Token** (see Step 1 below)
* An **SSL certificate** (HTTPS) on your site -- required for secure checkout and standard on any store accepting payments

***

## Step 1 -- Get your credentials

You'll need two values from your Dime Payments account:

* **Merchant ID** -- your unique account identifier
* **API Token** -- authorizes your store to communicate with Dime Payments

There are two token types:

| Token             | When to use                         |
| ----------------- | ----------------------------------- |
| **Sandbox token** | Testing only -- no real money moves |
| **Live token**    | Real transactions                   |

Find both in your **Dime Payments merchant dashboard** under **API Keys**. If you don't see them, contact your account manager and they'll get them to you.

<Warning>
  Keep your API tokens private. Treat them like a password -- never share them publicly or commit them to a version-controlled repository.
</Warning>

***

## Step 2 -- Install the plugin

1. Request the dime payments woo commerce `.zip` file from your dime payments representative.
2. In your WordPress admin, go to **Plugins → Add New → Upload Plugin**
3. Click **Choose File**, select the Dime Payments plugin `.zip` file provided to you, and click **Install Now**
4. Once installation finishes, click **Activate Plugin**

<Note>
  If WooCommerce isn't already installed, WordPress will prompt you to install it first. The Dime Payments gateway requires WooCommerce to be active.
</Note>

***

## Step 3 -- Configure the gateway

1. Go to **WooCommerce → Settings → Payments**
2. Find **Dime Payments** in the list and click **Manage** (or **Set up**)
3. Fill in the following settings:

| Setting                             | What to enter                                                         |
| ----------------------------------- | --------------------------------------------------------------------- |
| **Enable Dime Payments Gateway**    | Check this to turn the payment method on                              |
| **Sandbox / Test mode**             | On while testing; off when accepting real payments                    |
| **Title**                           | The name customers see at checkout (e.g. "Credit Card / Bank")        |
| **Description**                     | Optional text shown under the title at checkout                       |
| **Merchant ID**                     | Your Dime Payments Merchant ID                                        |
| **Sandbox API Token**               | Your test token -- used only while Sandbox mode is on                 |
| **API Token**                       | Your live token -- used when Sandbox mode is off                      |
| **Enable Billing Field Validation** | Leave enabled so WooCommerce validates billing details before payment |

4. Click **Save changes**

<Warning>
  If your Merchant ID or API Token is missing or incorrect, or if your site isn't on HTTPS, you'll see a warning in the admin settings. Resolve those before going live.
</Warning>

***

## Step 4 -- Test in sandbox mode

With **Sandbox / Test mode** enabled and your **Sandbox API Token** saved:

1. Add a product to your cart and go to **Checkout**
2. Select **Dime Payments** as the payment method -- a secure card form will appear
3. Enter test payment details:

| Field       | Test value                |
| ----------- | ------------------------- |
| Card number | `4111 1111 1111 1111`     |
| Expiry      | Any future date (MM/YYYY) |
| CVV         | Any 3 digits              |
| ZIP         | Any 5 digits              |

4. Place the order -- you should land on the **Order received** page, and the order will appear in **WooCommerce → Orders** marked as paid via Dime Payments

<Note>
  No real money moves in Sandbox mode. Contact your Dime Payments account manager for additional sandbox test values, including ACH test details.
</Note>

***

## Step 5 -- Go live

When you're satisfied with testing:

1. Go to **WooCommerce → Settings → Payments → Dime Payments → Manage**
2. Turn off **Sandbox / Test mode**
3. Confirm your **live API Token** is entered
4. Click **Save changes**

Your store is now accepting real payments through Dime Payments.

***

## How checkout works

When a customer selects Dime Payments at checkout:

1. A secure payment form hosted by Dime Payments loads on your checkout page
2. The customer enters their card or bank details and places the order
3. Payment is processed, the order is marked paid, and the customer sees your normal order confirmation

Card and bank details are entered directly into the Dime Payments hosted form -- they are **never stored on or handled by your website**, keeping your PCI scope minimal.

**Supported payment methods and features:**

* Credit and debit card payments (Visa, Mastercard, Amex, Discover)
* ACH bank transfer payments
* Both the WooCommerce **Checkout block** and classic checkout
* **Refunds** directly from the WooCommerce order screen
* WooCommerce **High-Performance Order Storage (HPOS)**

***

## Issuing refunds

1. Open the order in **WooCommerce → Orders**
2. Click **Refund**
3. Enter the amount to refund and confirm

The refund is sent to Dime Payments and processed against the original transaction.

***

## Troubleshooting

<AccordionGroup>
  <Accordion title="The payment form doesn't appear at checkout">
    Confirm the gateway is **enabled**, your **Merchant ID** and the correct **API Token** are saved, and your site is on **HTTPS**. Check for any admin notice on the WooCommerce settings page.
  </Accordion>

  <Accordion title="'Account not ready' or verification warning">
    Your Merchant ID or API Token may be incorrect. Re-enter them carefully, and confirm with your Dime Payments account manager that your account is active.
  </Accordion>

  <Accordion title="Payments work in sandbox but not live (or vice versa)">
    Check that the **Sandbox / Test mode** toggle matches the token you're using. Sandbox mode must be on when using your sandbox token; off when using your live token.
  </Accordion>

  <Accordion title="Still stuck?">
    Contact Dime Payments support with your Merchant ID and a description of the issue, including any error message shown at checkout.
  </Accordion>
</AccordionGroup>
