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

# Quickstart

> Get CeyPay WordPress Plugin installed and accepting crypto payments in minutes.

export const WooCommerceDownload = ({hideDocs = false}) => {
  const [release, setRelease] = React.useState(null);
  const [isLoading, setIsLoading] = React.useState(true);
  const [error, setError] = React.useState(null);
  React.useEffect(() => {
    fetch('https://api.github.com/repos/CeyPay-io/woocommerce-plugin/releases/latest', {
      headers: {
        'Accept': 'application/vnd.github+json'
      }
    }).then(res => {
      if (!res.ok) throw new Error('Failed to fetch release');
      return res.json();
    }).then(data => {
      setRelease(data);
      setIsLoading(false);
    }).catch(err => {
      setError(err.message);
      setIsLoading(false);
    });
  }, []);
  const getDownloadUrl = () => {
    if (!release) return null;
    const zipAsset = release.assets.find(asset => asset.name.endsWith('.zip') && asset.name.includes('ceypay-payment-gateway'));
    return zipAsset?.browser_download_url || null;
  };
  const downloadUrl = getDownloadUrl();
  const version = release?.tag_name;
  return <div className="not-prose my-6 rounded-xl border border-zinc-200 dark:border-white/10 bg-zinc-50/50 dark:bg-zinc-900/30 p-4 backdrop-blur-sm">
<div className="flex flex-col sm:flex-row sm:items-center sm:justify-between gap-4">
<div className="flex items-center gap-3 min-w-0 flex-1">
<div className="w-10 h-10 flex items-center justify-center rounded-lg bg-[#1C6EF5] shrink-0">
<svg className="w-6 h-6 text-white" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path d="M21.469 6.825c.84 1.537 1.318 3.3 1.318 5.175 0 3.979-2.156 7.456-5.363 9.325l3.295-9.527c.615-1.54.82-2.771.82-3.864 0-.405-.026-.78-.07-1.11m-7.981.105c.647-.03 1.232-.105 1.232-.105.582-.075.514-.93-.067-.899 0 0-1.755.135-2.88.135-1.064 0-2.85-.15-2.85-.15-.585-.03-.661.855-.075.885 0 0 .54.061 1.125.09l1.68 4.605-2.37 7.08L5.354 6.9c.649-.03 1.234-.1 1.234-.1.585-.075.516-.93-.065-.896 0 0-1.746.138-2.874.138-.2 0-.438-.008-.692-.015C4.911 3.15 8.235 1.215 12 1.215c2.809 0 5.365 1.072 7.286 2.833-.046-.003-.091-.009-.141-.009-1.06 0-1.812.923-1.812 1.914 0 .89.513 1.643 1.06 2.531.411.72.89 1.643.89 2.977 0 .915-.354 1.994-.821 3.479l-1.075 3.585-3.9-11.61.001.014zM12 22.784c-1.059 0-2.081-.153-3.048-.437l3.237-9.406 3.315 9.087c.024.053.05.101.078.149-1.12.393-2.325.607-3.582.607M1.211 12c0-1.564.336-3.05.935-4.39L7.29 21.709C3.694 19.96 1.212 16.271 1.211 12M12 0C5.385 0 0 5.385 0 12s5.385 12 12 12 12-5.385 12-12S18.615 0 12 0z" />
</svg>
</div>
<div className="min-w-0 flex-1">
          <div className="flex items-center gap-2 flex-wrap">
            <h3 className="text-sm font-semibold text-zinc-900 dark:text-white m-0">
              WooCommerce Plugin
            </h3>
            {isLoading ? <span className="text-xs px-2 py-0.5 rounded bg-zinc-200 dark:bg-zinc-800 text-zinc-400 animate-pulse">
                ...
              </span> : version && <span className="text-xs px-2 py-0.5 rounded bg-[#1C6EF5]/10 text-[#1C6EF5] dark:text-[#5B9EFF] font-medium border border-[#1C6EF5]/20">
                {version}
              </span>}
          </div>
<p className="text-xs text-zinc-500 dark:text-zinc-400 m-0 truncate">
Accept crypto payments on WooCommerce
</p>
</div>
</div>
      <div className="flex gap-2 w-full sm:w-auto shrink-0">
        {downloadUrl && !isLoading && <a href={downloadUrl} download className={`inline-flex items-center justify-center gap-1.5 h-8 bg-[#1C6EF5] px-3 py-1 text-xs font-medium text-white hover:bg-[#1557C3] rounded-lg no-underline transition-colors ${hideDocs ? 'w-full' : 'flex-1'}`}>
            <svg className="w-3.5 h-3.5" fill="none" viewBox="0 0 24 24" stroke="currentColor">
              <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M4 16v1a3 3 0 003 3h10a3 3 0 003-3v-1m-4-4l-4 4m0 0l-4-4m4 4V4" />
            </svg>
            Download
          </a>}
        {!hideDocs && <a href="/integrations/wordpress/quickstart" className="inline-flex items-center justify-center gap-1.5 h-8 border border-zinc-300 dark:border-white/20 bg-white/50 dark:bg-white/5 px-3 py-1 text-xs font-medium text-zinc-900 dark:text-white hover:bg-white dark:hover:bg-white/10 rounded-lg no-underline transition-colors flex-1">
            <svg className="w-3.5 h-3.5" fill="none" viewBox="0 0 24 24" stroke="currentColor">
              <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M9 12h6m-6 4h6m2 5H7a2 2 0 01-2-2V5a2 2 0 012-2h5.586a1 1 0 01.707.293l5.414 5.414a1 1 0 01.293.707V19a2 2 0 01-2 2z" />
            </svg>
            Docs
          </a>}
</div>
</div>
</div>;
};

<Info>
  This guide will walk you through installing the CeyPay WordPress plugin,
  configuring your credentials, and verifying your setup. You'll be ready to
  accept crypto payments in under 10 minutes.
</Info>

## What You'll Need

<CardGroup cols={3}>
  <Card title="WordPress 5.8+" icon="wordpress">
    With admin access
  </Card>

  <Card title="WooCommerce 7.0+" icon="cart-shopping">
    Installed and active
  </Card>

  <Card title="CeyPay Account" icon="user-check">
    Merchant credentials
  </Card>
</CardGroup>

## Installation

Download the latest version of the CeyPay WooCommerce plugin or install directly from WordPress.

<WooCommerceDownload hideDocs={true} />

Choose one of the following methods to install the CeyPay Payment Gateway plugin.

<Tabs>
  <Tab title="WordPress Dashboard">
    The easiest way to install CeyPay is directly from your WordPress admin panel.

    <Steps>
      <Step title="Navigate to Plugins">
        Log in to your WordPress admin dashboard and go to **Plugins > Add New**.
      </Step>

      <Step title="Search for CeyPay">
        In the search box, type "CeyPay Payment Gateway" and press Enter.
      </Step>

      <Step title="Install the Plugin">
        Click **Install Now** on the CeyPay Payment Gateway plugin card.
      </Step>

      <Step title="Activate">
        Once installed, click **Activate** to enable the plugin.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Manual Upload">
    If you have the plugin ZIP file, you can upload it manually.

    <Steps>
      <Step title="Download the Plugin">
        Download the `ceypay-payment-gateway.zip` file from the official source.
      </Step>

      <Step title="Upload via Dashboard">
        Go to **Plugins > Add New** and click **Upload Plugin** at the top.
      </Step>

      <Step title="Select and Install">
        Choose the ZIP file and click **Install Now**.
      </Step>

      <Step title="Activate">
        Click **Activate** after the installation completes.
      </Step>
    </Steps>
  </Tab>

  <Tab title="FTP/SFTP">
    For advanced users who prefer manual file management.

    <Steps>
      <Step title="Extract the Plugin">
        Extract the `ceypay-payment-gateway.zip` file on your local machine.
      </Step>

      <Step title="Connect to Server">
        Use an FTP/SFTP client to connect to your web server.
      </Step>

      <Step title="Upload Files">
        Upload the `ceypay-payment-gateway` folder to `/wp-content/plugins/`.
      </Step>

      <Step title="Activate">
        Go to **Plugins** in WordPress admin and activate CeyPay Payment Gateway.
      </Step>
    </Steps>
  </Tab>
</Tabs>

## Initial Configuration

<Info>
  After activation, you'll see an admin notice prompting you to complete the
  setup. This only takes a few minutes!
</Info>

<Steps>
  <Step title="Access Payment Settings" icon="gear">
    Navigate to **WooCommerce → Settings → Payments** in your WordPress admin dashboard.
  </Step>

  <Step title="Enable CeyPay" icon="toggle-on">
    Find **CeyPay** in the list of available payment methods. Toggle the switch to **enable** it, then click **Manage** or click the gateway name.
  </Step>

  <Step title="Enter Your Credentials" icon="key">
    Fill in the required fields:

    <ParamField path="Merchant ID" type="string" required>
      Your unique merchant identifier from the CeyPay dashboard. Example: `MERCH-123456`
    </ParamField>

    <ParamField path="Webhook Secret" type="string" required>
      The secret key used to verify webhook signatures. Found in your CeyPay dashboard under **Settings → API Settings**. Keep this secure!
    </ParamField>
  </Step>

  <Step title="Save Changes" icon="floppy-disk">
    Click **Save changes** at the bottom of the page to apply your configuration.
  </Step>
</Steps>

<Check>
  **Success!** Once configured, CeyPay will appear as a payment option on your
  checkout page. Customers can now pay with Bybit, Binance Pay, or KuCoin.
</Check>

## Get Your API Credentials

<Tip>
  Don't have a CeyPay account yet? You can apply for a merchant account in
  minutes and get instant access to test mode credentials.
</Tip>

<Steps>
  <Step title="Create a CeyPay Account" icon="user-plus">
    Visit [merchant.ceypay.io](https://merchant.ceypay.io) and sign up for a
    merchant account. You'll receive test credentials immediately.
  </Step>

  <Step title="Complete Verification" icon="id-card">
    Complete the merchant verification process to unlock production access and
    real payment processing.
  </Step>

  <Step title="Access API Settings" icon="key">
    In your CeyPay dashboard, navigate to **Settings → API Settings** or
    **Integration** section.
  </Step>

  <Step title="Copy Credentials" icon="copy">
    Copy your **Merchant ID** and **Webhook Secret**. Keep these secure—they're
    used to authenticate API requests.
  </Step>
</Steps>

<Note>
  Your webhook secret should be treated like a password. Never share it publicly
  or commit it to version control.
</Note>

## Verify Your Setup

<Tip>
  Always test your integration before going live. Test mode lets you simulate
  the complete payment flow without processing real transactions.
</Tip>

<Steps>
  <Step title="Enable Test Mode" icon="flask">
    In the CeyPay settings (WooCommerce → Settings → Payments → CeyPay), check
    **Enable Test Mode**. This allows you to test without real transactions.
  </Step>

  <Step title="Place a Test Order" icon="cart-plus">
    Add a product to your cart and proceed to checkout. Select **CeyPay** as the
    payment method.
  </Step>

  <Step title="Complete the Flow" icon="mobile">
    After clicking "Place Order", the payment modal should appear with QR codes
    for Bybit, Binance Pay, and KuCoin. In test mode, you'll see a **"Simulate
    Success"** button.
  </Step>

  <Step title="Verify Order Status" icon="circle-check">
    Click the simulate button and confirm the order is marked as
    **"Processing"** or **"Completed"** in WooCommerce → Orders.
  </Step>
</Steps>

<Warning>
  **Remember to disable Test Mode before accepting real payments!** Test Mode is
  only visible to administrators and prevents actual payment processing.
</Warning>

<AccordionGroup>
  <Accordion title="What if the payment modal doesn't appear?" icon="circle-question">
    Check that:

    * JavaScript is enabled in your browser
    * Your theme is not blocking modal overlays
    * There are no JavaScript errors in the browser console (F12 → Console)
    * The plugin is activated and WooCommerce is working properly
  </Accordion>

  <Accordion title="How do I test with real crypto wallets?" icon="wallet">
    Test mode simulates the payment flow without requiring real wallets. To test
    with actual Bybit, Binance Pay, or KuCoin accounts, disable test mode and use
    small amounts. Make sure you're in a test environment before processing real
    payments.
  </Accordion>

  <Accordion title="What happens after a successful test?" icon="check">
    A successful test confirms that:

    * The plugin is installed and activated correctly
    * Your API credentials are valid
    * Webhooks are configured properly (if using real mode)
    * WooCommerce can process orders through CeyPay

    You're ready to accept real crypto payments!
  </Accordion>
</AccordionGroup>

***

## You're All Set! 🎉

<Check>
  Congratulations! You've successfully installed and configured the CeyPay
  WordPress plugin. Your store is now ready to accept cryptocurrency payments
  from Bybit, Binance Pay, and KuCoin.
</Check>

## Next Steps

<CardGroup cols={2}>
  <Card title="Configuration" icon="sliders" href="/integrations/wordpress/configuration">
    Explore all available settings and customize the checkout experience.
  </Card>

  <Card title="Testing Guide" icon="vial" href="/integrations/wordpress/testing">
    Learn how to thoroughly test your integration before going live.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/integrations/wordpress/webhooks">
    Understand how webhooks work and verify they're configured correctly.
  </Card>

  <Card title="Troubleshooting" icon="life-ring" href="/integrations/wordpress/troubleshooting">
    Common issues and solutions to keep your integration running smoothly.
  </Card>
</CardGroup>

## Need Help?

<CardGroup cols={2}>
  <Card title="Contact Support" icon="envelope" href="mailto:support@ceypay.io">
    Our support team is here to help with any questions.
  </Card>

  <Card title="Join Community" icon="users" href="https://t.me/CeyPayio">
    Connect with other merchants on Telegram.
  </Card>
</CardGroup>