> ## Documentation Index
> Fetch the complete documentation index at: https://doc-test-my.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Integration Steps

> Step-by-step guide to integrate Razorpay Payment Gateway with WooCommerce. Install Razorpay WooCommerce plugin and start accepting payments on WordPress.

Integrate Razorpay Payment Gateway with your WooCommerce website using our official WooCommerce plugin. This step-by-step guide covers installation, configuration, testing and going live with Razorpay on WordPress WooCommerce stores.

Follow the steps given below to integrate Razorpay Payment Gateway with your WooCommerce website.

<CardGroup cols={3}>
  <Card title="1. Build Integration" href="/docs/payments/payment-gateway/ecommerce-plugins/woocommerce/integration-steps#1-build-integration">
    Install and configure the WordPress plugin.
  </Card>

  <Card title="2. Test Integration" href="/docs/payments/payment-gateway/ecommerce-plugins/woocommerce/integration-steps#2-test-integration">
    Test the integration by making a test payment.
  </Card>

  <Card title="3. Go-Live Checklist" href="/docs/payments/payment-gateway/ecommerce-plugins/woocommerce/integration-steps#3-go-live-checklist">
    Check the go-live checklist.
  </Card>
</CardGroup>

## 1. Build Integration

Follow the steps given below:

<AccordionGroup>
  <Accordion title="1 Install Plugin">
    There are two methods to install our WooCommerce plugin:

    <Tabs>
      <Tab title="Using WordPress Plugin Directory">
        1. [Download the plugin](https://wordpress.org/plugins/woo-razorpay/).
        2. Install it from the WordPress Plugin Directory.
      </Tab>

      <Tab title="Manual Installation">
        1. Download the [latest Source code zip file](https://github.com/razorpay/razorpay-woocommerce/releases/latest) from the Releases section in GitHub.
        2. Unzip and upload the contents of the extension to your `/wp-content/plugins/` directory.
      </Tab>
    </Tabs>
  </Accordion>

  <Accordion title="2 Configure WooCommerce">
    Before you start:

    * Ensure you have created a Razorpay account and your KYC is approved.
    * You must have activated your business after the business activation email from Razorpay.
    * You have [generated the API keys](/docs/api/authentication#generate-api-keys) from the Dashboard (Under Account & Settings → API Keys).

    To configure WooCommerce:

    1. Log in to your [WordPress account](https://wordpress.com/log-in) and activate the Razorpay plugin in the **WordPress Plugin Manager**.
    2. Log in to your [WooCommerce account](https://woocommerce.com/), navigate to **Settings** and click the **Checkout/Payment Gateways** tab.
    3. Click **Razorpay** to edit the settings.
    4. Enable the Payment Method, name it Credit Card/Debit Card/FPX. This is shown on the Payment page your customer sees.

    <Info>
      **Handy Tips**

      If you cannot see the Razorpay payment option during WooCommerce checkout, update the plugin to the [latest](https://github.com/razorpay/razorpay-woocommerce/releases/latest) version.

      <img src="https://curlec.com/docs/build/browser/assets/images/Woocommerce-payment-error.jpg" alt="Payments option error" width="800" />
    </Info>

    5. Add in your \[KEY\_ID] and \[KEY\_SECRET] generated from the Razorpay Dashboard.
    6. Set the **Payment Action** to **Authorize and Capture** to auto-capture payments. If you want to capture payments manually from the Dashboard after manual verification, set the Payment Method to **Authorize**.

    <Warning>
      **Watch Out: Uncaptured payments are automatically refunded after 5 days**

      If you set **Payment Action** to `Authorize`, payments are held but not settled. Any payment that is not captured within **5 days** of authorisation is automatically refunded to the customer — the merchant receives nothing.

      To prevent this, set **Payment Action** to **Authorize and Capture** for automatic capture, or manually capture payments from the Dashboard before the 5-day window closes. Review your capture settings in Dashboard → **Account & Settings** → **Payment Capture**.
    </Warning>
  </Accordion>
</AccordionGroup>

<Info>
  **Configure Webhooks**

  Webhook is [auto-configured](/docs/payments/payment-gateway/ecommerce-plugins/woocommerce/troubleshooting-faqs#1-how-are-webhooks-aut-configured) when you enter and save the API key ID and secret on the plugin settings page. You need to verify if webhooks are enabled on your Razorpay [Dashboard](/docs/payments/payment-gateway/ecommerce-plugins/woocommerce/troubleshooting-faqs#3-how-can-i-verify-if-webhooks-are). However, for versions lower than 3.5.0, you need to [configure webhooks manually](/docs/payments/payment-gateway/ecommerce-plugins/woocommerce/troubleshooting-faqs#2-my-webhooks-are-not-auto-configured-since-i).

  If you regenerate your API keys, re-enter and save the new keys in the plugin settings page to re-trigger webhook auto-configuration.
</Info>

The following webhook events are auto-configured when you save your API keys:

* `payment.authorized`
* `payment.captured`
* `payment.failed`
* `order.paid`

Verify these are enabled in your Razorpay Dashboard under **Account & Settings** → **Webhooks**.

## 2. Test Integration

After the integration is complete, a **Pay** button will appear on your web page/app. You need to click the button and make a test transaction to ensure that the integration is working as expected. You can start accepting actual payments from your customers once the test is successful.

You can make test payments using one of the payment methods configured at the Checkout.

* No money is deducted from the customer's account as this is a simulated transaction.
* Ensure you have entered the API keys generated in the test mode in the Checkout code.

<AccordionGroup>
  <Accordion title="Supported Payment Methods">
    After the integration is complete, a **Pay** button appears on your webpage/app.

    Click the button and make a test transaction to ensure the integration is working as expected. You can start accepting actual payments from your customers once the test transaction is successful.

    <Warning>
      **Watch Out!**

      This is a mock payment page that uses your test API keys, test card and payment details.

      * Ensure you have entered only your [Test Mode API keys](/docs/payments/dashboard/account-settings/api-keys#generate-api-keys) in the Checkout code.
      * Test mode features a mock bank page with **Success** and **Failure** buttons to replicate the live payment experience.
      * No real money is deducted due to the usage of test API keys. This is a simulated transaction.
    </Warning>

    Following are all the payment modes that the customer can use to complete the payment on the Checkout. Some of them are available by default, while others may require approval from us. Raise a request from the Dashboard to enable such payment methods.

    | Payment Method                                                 | Code     | Availability |
    | -------------------------------------------------------------- | -------- | ------------ |
    | [Debit and Credit Cards](/docs/payments/payment-methods/cards) | `card`   | ✓            |
    | [FPX](/docs/payments/payment-methods/fpx)                      | `fpx`    | ✓            |
    | [Wallets](/docs/payments/payment-methods/wallets)              | `wallet` | ✓            |

    You can make test payments using one of the payment methods configured at the Checkout.

    <AccordionGroup>
      <Accordion title="FPX">
        You can select any of the listed banks. After choosing a bank, Razorpay Curlec will redirect to a mock page where you can make the payment a `success` or a `failure`. Since this is Test Mode, we will not redirect you to the bank login portals.
      </Accordion>

      <Accordion title="Wallet">
        You can select any of the listed wallets. After choosing a wallet, you will be redirected to a mock page where you can make the payment `success` or a `failure`. Since this is Test Mode, we will not redirect you to the wallet login portals.

        <Warning>
          **Watch Out!**

          iOS integration for Touch'n Go wallet is currently unavailable. We will be adding support for it soon.
        </Warning>
      </Accordion>

      <Accordion title="Cards">
        You can use one of the following test cards to test transactions for your integration in Test Mode.

        | Card Network | Card Number         | CVV & Expiry Date                       |
        | ------------ | ------------------- | --------------------------------------- |
        | Mastercard   | 5272 0088 0623 5704 | Use a random CVV and any future date ^^ |
        | Visa         | 4842 7930 0208 6571 |                                         |

        Check the following lists:

        * [Supported Card Networks](/docs/payments/payment-methods/cards).
        * [Cards Error Codes](/docs/errors/payments/cards).
      </Accordion>
    </AccordionGroup>
  </Accordion>

  <Accordion title="Verify Payment Status">
    You can track the payment status from the Dashboard or by polling APIs.

    <Tabs>
      <Tab title="Verify Payment Status From Dashboard">
        1. Log in to the Razorpay Dashboard and navigate to **Transactions** → **Payments**.
        2. Check if a `payment_ID` has been generated and note the status. In case of a successful payment, the status is marked as `captured`.

                   <img class="click-zoom" src="https://curlec.com/docs/build/browser/assets/images/my-testpayment.jpg" width="800" alt="Payment details on Dashboard" />
      </Tab>

      <Tab title="Poll APIs">
        [Poll Payment APIs](/docs/api/payments#fetch-multiple-payments) to check the payment status.
      </Tab>
    </Tabs>
  </Accordion>
</AccordionGroup>

You can also test your **WooCommerce** Integration in the Test Mode using your Test Mode API keys:

1. Go to WooCommerce → Settings → Payments → Razorpay.
2. Replace your Live API keys with Test Mode keys from the Razorpay Dashboard (Test Mode).
3. Complete a test transaction.
4. Switch back to Live keys before going live.

## 3. Go-live Checklist

Follow these steps before taking the integration live:

<AccordionGroup>
  <Accordion title="1 Accept Live Payments">
    Perform an end-to-end simulation of funds flow in the Test Mode. Once confident that the integration is working as expected, switch to the Live Mode and start accepting payments from customers.

    <Warning>
      **Watch Out!**

      Ensure you are switching your test API keys with API keys generated in Live Mode.
    </Warning>

    To generate API Keys in Live Mode on your Razorpay Dashboard:

    1. Log in to the Razorpay Dashboard and switch to **Live Mode** on the menu.
    2. Navigate to **Account & Settings** → **API Keys** → **Generate Key** to generate the API Key for Live Mode.
    3. Download the keys and save them securely.
    4. Replace the Test API Key with the Live Key in the Checkout code and start accepting actual payments.

    <br />
  </Accordion>

  <Accordion title="2 Payment Capture">
    After payment is `authorized`, you need to capture it to settle the amount to your bank account as per the settlement schedule. Payments that are not captured are auto-refunded after a fixed time.

    <Warning>
      **Watch Out**

      * You should deliver the products or services to your customers only after the payment is captured. Razorpay automatically refunds all the uncaptured payments.
      * You can track the payment status using our [Fetch a Payment API](/docs/api/payments#fetch-a-payment) or webhooks.
    </Warning>

    <Tabs>
      <Tab title="Auto-capture Payments (Recommended)">
        Authorized payments can be automatically captured. You can auto-capture all payments [using global settings](/docs/payments/payments/capture-settings#auto-capture-all-payments) on the Razorpay Dashboard. Know more about [capture settings for payments](/docs/payments/payments/capture-settings).

        <Warning>
          **Watch Out!**

          Payment capture settings work only if you have integrated with Orders API on your server side. Know more about the [Orders API](/docs/api/orders/create).
        </Warning>
      </Tab>

      <Tab title="Manually Capture Payments">
        Each authorized payment can also be captured individually. You can manually capture payments using [Payment Capture API](/docs/api/payments/capture) or [Dashboard](/docs/payments/payments/dashboard#manually-capture-payments). Know more about [capture settings for payments](/docs/payments/payments/capture-settings).
      </Tab>
    </Tabs>
  </Accordion>
</AccordionGroup>