User Guide for Odoo-Paymennt Connector

This comprehensive guide provides detailed instructions for the installation, configuration, and daily usage of the Paymennt payment gateway integration with your Odoo e-commerce platform.

---

1. Introduction

The Odoo-Paymennt Connector module provides a robust and seamless integration between your Odoo e-commerce platform and Paymennt's online payment gateway. This module enables your customers to make secure payments directly through your website using various methods supported by Paymennt, streamlining the checkout process and ensuring efficient transaction management within Odoo.

---

2. Prerequisites

• Active Odoo instance (Community or Enterprise)
• Paymennt Merchant Account
• Paymennt API Credentials:
  • API Secret
  • Public API Key

---

3. Installation

1. Upload the Module: Copy the `oe_paymennt_payment_integration` (or similar technical name) module folder to your Odoo custom addons path.
2. Update Apps List: Go to Apps > Update Apps List (activate Developer Mode first under Settings > General Settings > Developer Tools if needed).
3. Install the Module: In the Apps menu, search for "Paymennt Payment Connector" (or "Paymennt") and click the "Install" button.

---

4. Configuration

4.1 Configure Paymennt Payment Acquirer

1. Navigate to Payment Acquirers: Go to Invoicing / Accounting > Configuration > Payment Acquirers.
2. Activate Paymennt: Locate "Paymennt" in the list.
3. Edit Settings: Click on the "Paymennt" payment acquirer.
4. Enter Credentials:
   • Paymennt API Secret: Enter your API Secret from your Paymennt merchant dashboard.
   • Paymennt Public API Key: Enter your Public API Key from your Paymennt merchant dashboard.
   • (These fields are typically found under the "Credentials" tab.)
5. Set State:
   • Test: Select "Test" mode for testing transactions in Paymennt's sandbox environment.
   • Enabled: Select "Enabled" mode to go live and accept real payments.
6. (These options are usually under the "Configuration" tab.)
7. Set Countries: Under the "Configuration" tab, specify the countries for which this payment method will be available. Leave blank for all countries.
8. Save Changes: Click the "Save" button.

4.2 Other Important Settings (General Payment Acquirer Settings)

• Display on Website: Ensure the "Published" checkbox is checked for visibility on your website checkout.
• Support & Messages: Configure custom messages (e.g., instructions, thank you, error messages) under the "Messages" tab.
• Processing Fees: Set up any processing fees for Paymennt transactions under the "Fees" tab.

---

5. Usage

5.1 Customer Checkout Process

1. Shopping Cart & Checkout: Customers add products to their cart and proceed to checkout on your Odoo e-commerce website.
2. Select Paymennt: On the "Select Payment Method" step, customers choose "Paymennt".
3. Redirection to Paymennt: The customer is securely redirected to the Paymennt gateway.
4. Payment Completion: The customer enters payment information on the Paymennt page.
5. Return to Odoo: After successful payment, the customer is redirected back to your Odoo website's order confirmation page. Order and payment transaction statuses are automatically updated.

5.2 Managing Paymennt Transactions in Odoo Backend

1. Access Payment Transactions: Go to Invoicing / Accounting > Customers > Payments or Invoicing / Accounting > Configuration > Payment Transactions.
2. Locate Transaction: Search using the order reference or customer name. Paymennt transactions will have "Paymennt" as their "Provider".
3. Transaction Statuses: Monitor statuses like Draft, Pending, Authorized, Done, Canceled, or Error.
4. Capturing Payments (if applicable): If manual capture is configured, finalize "Authorized" payments via a "Capture" action on the transaction record.
5. Refunds: Initiate refunds from the related invoice or payment transaction in Odoo using standard refund processes.
6. Error Handling: Payment failures will update the transaction to "Error" status, with relevant messages logged in Odoo for troubleshooting.