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

# eCommerce Payment Links

> Accept online payments in your Odoo store with Compago's secure checkout.

The Compago eCommerce plugin enables your Odoo online store to accept credit and debit card payments through a secure, hosted checkout experience. When customers complete their purchase, they're redirected to Compago's payment page, process their payment, and return seamlessly to your store.

## What You Can Do

With the eCommerce payment plugin, you can:

* **Accept Card Payments Online**: Process credit and debit card transactions for your Odoo eCommerce store
* **Secure Checkout Flow**: Redirect customers to Compago's PCI-compliant payment page
* **Automatic Order Updates**: Payment status is synchronized back to Odoo automatically
* **Multi-Currency Support**: Accept payments in MXN and USD
* **Invoice Integration**: Payments are automatically recorded in your Odoo invoicing system

## Use Cases

This plugin is ideal for:

* Online retail stores selling products through Odoo eCommerce
* Service businesses accepting deposits or full payments online
* B2B companies processing customer invoices with online payment options
* Any business that wants to offer card payments without handling sensitive payment data

## Installation

### Step 1: Download the Plugin

Visit the Odoo App Store and download the Compago eCommerce Payment Provider:

**Download link**: [https://apps.odoo.com/apps/modules/18.0/payment\_compago](https://apps.odoo.com/apps/modules/18.0/payment_compago)

<Note>
  You must have an **Odoo.sh instance** to install custom apps. Self-hosted or community editions may not support third-party payment provider installations.
</Note>

### Step 2: Install the Plugin in Odoo.sh

1. Log in to your **Odoo.sh** dashboard
2. Navigate to your instance
3. Upload and install the `payment_compago` module
4. Restart your instance if required

### Step 3: Activate the Plugin

Once the module is uploaded to your Odoo.sh instance:

1. Open your Odoo instance
2. Go to **Apps** (you may need to enable Developer Mode)
3. Remove the "Apps" filter to show all modules
4. Search for **"Compago"**
5. Click **Activate** on the Compago Payment Provider module

<Tip>
  If you don't see the Compago module, click **Update Apps List** to refresh the module catalog.
</Tip>

## Configuration

### Step 1: Ensure Prerequisites

Before configuring the plugin, verify:

* The **Invoicing** app is installed (it's usually pre-installed in Odoo)
* Your company is configured in **MXN currency**
* You have at least one bank journal configured in **MXN**

<Warning>
  The plugin will not work correctly if your company or journal is not configured in MXN. Verify your currency settings before proceeding.
</Warning>

### Step 2: Configure the Payment Provider

1. Navigate to **Invoicing** → **Configuration** → **Payment Providers**
2. Find **Compago** in the list (it should appear automatically after activating the plugin)
3. Click on the **Compago** provider to open the configuration form

<Note>
  If Compago does not appear in the payment providers list, return to the Apps menu and ensure the plugin is activated.
</Note>

### Step 3: Enable and Authenticate

In the Compago provider configuration form:

1. **Enable the provider**: Toggle the **Enabled** switch to activate Compago

2. **Add your API Key**:
   * Locate the **Credentials** section
   * Paste your Compago API key in the **API Key** field
   * Generate your API key from the [Compago Dashboard](https://app.compago.com) if you haven't already

3. **Select the environment**:
   * Choose **Production** for live transactions
   * Choose **Demo** for testing (if available)
   * Most users should select **Production**

### Step 4: Configure the Journal

Still in the Compago provider form:

1. Scroll to the **Configuration** section
2. Select a **Journal** from the dropdown (typically a Bank journal)
3. Verify the journal is configured in **MXN currency**

<Tip>
  The journal you select will be used to record all Compago payment transactions. Make sure it's set up correctly in your accounting workflow.
</Tip>

4. **Save** the configuration form

### Step 5: Enable the Payment Method

1. Navigate to **Invoicing** → **Configuration** → **Payment Methods**
2. Find **Compago** in the payment methods list
3. Click on it to open the form
4. Toggle **Enable** to activate the payment method
5. **Save** the form

## Testing the Integration

To verify the integration is working:

1. Create a test product in your Odoo eCommerce store
2. Add the product to your cart and proceed to checkout
3. Select **Compago** as the payment method
4. Complete the checkout process
5. You should be redirected to Compago's payment page
6. Enter test card details (or real card details if testing in production)
7. Complete the payment
8. Verify you're redirected back to your Odoo store
9. Check the order status in **Sales** → **Orders** to confirm the payment was recorded

<Warning>
  If testing in production, use a small amount and a real payment method. The transaction will be processed and charged.
</Warning>

## How It Works

Here's the complete payment flow:

1. **Customer Checks Out**: Customer adds items to cart and proceeds to checkout in your Odoo store
2. **Selects Compago**: Customer chooses Compago as the payment method
3. **Redirect to Compago**: Customer is redirected to Compago's secure checkout page
4. **Payment Processing**: Customer enters card details and completes payment on Compago's platform
5. **Payment Confirmation**: Compago processes the transaction and confirms the result
6. **Return to Store**: Customer is redirected back to your Odoo store
7. **Order Updated**: The order status is automatically updated in Odoo based on the payment result

## Video Tutorial

Watch the complete setup and configuration process:

<Note>
  **Video coming soon**: A step-by-step walkthrough showing the installation, configuration, and first test payment.
</Note>

## Troubleshooting

### Compago doesn't appear in payment providers

* Verify the plugin is activated in **Apps**
* Click **Update Apps List** in the Apps menu
* Restart your Odoo instance

### Payment fails with currency error

* Ensure your company is configured in MXN
* Verify the selected journal is in MXN currency
* Check that the product prices are in MXN

### Customer not redirected after payment

* Verify your API key is correct and active
* Check that the environment setting matches your API key (production vs. demo)
* Review Odoo logs for any error messages

## Support

If you encounter issues with the Compago eCommerce plugin:

* Check your API key is valid in the [Compago Dashboard](https://app.compago.com)
* Review the Odoo logs for detailed error messages
* Contact Compago support at **[help@compago.com](mailto:help@compago.com)** for assistance with payment processing issues