SSLCOMMERZ Payment Module Business Flow

Overview

The SSLCOMMERZ payment module enables Odoo to process online payments via the SSLCOMMERZ payment gateway, supporting both test and production environments. It handles payment initiation, validation, and status updates for transactions, ensuring seamless integration with Odoo's e-commerce and payment workflows.

Business Flow

1. Payment Configuration

• The merchant configures the SSLCOMMERZ payment acquirer in Odoo, specifying the Store ID and Store Password provided by SSLCOMMERZ.
• The environment (test or production) is set, determining whether the module interacts with the sandbox (https://sandbox.sslcommerz.com) or live (https://securepay.sslcommerz.com) gateway.

2. Payment Initiation

• During checkout in Odoo's e-commerce module, the customer selects SSLCOMMERZ as the payment method.
• The sslcommerz_form_generate_values method prepares transaction data, including:
  • Store ID, store password, transaction amount, currency, and reference ID.
  • Customer details (name, email, address, etc.).
  • Success, failure, and cancel URLs for post-payment redirection.
• A session key is obtained by sending a POST request to the SSLCOMMERZ API (gwprocess/v3 for test or v4 for production).
• The customer is redirected to the SSLCOMMERZ payment gateway URL with the session key for payment processing.

3. Payment Processing

• The customer completes the payment on the SSLCOMMERZ gateway.
• SSLCOMMERZ processes the payment and sends a response to one of the predefined URLs:
  • Success URL (/shop/confirmation/): Triggered on successful payment.
  • Failure URL (/shop/failure/): Triggered on payment failure.
  • Cancel URL (/shop/cancel/): Triggered if the customer cancels the payment.

4. Transaction Validation

• Upon receiving a response, the sslcommerz_validate_data method verifies the transaction by sending a GET request to the SSLCOMMERZ validation API (validationserverAPI.php).
• The response is parsed to check the transaction status (VALID, VALIDATED, or INVALID_TRANSACTION).
• If valid, the transaction is updated in Odoo via form_feedback, setting the state to done or pending based on the response.
• If invalid or unrecognized, the transaction is marked as error or cancel, and an appropriate log is recorded.

5. Post-Payment Actions

• Success: The customer is redirected to the confirmation page (/shop/confirmation/). The module inserts a follower record in Odoo’s mail_followers to link the sale order to the customer for notifications.
• Failure: The customer is redirected to the cart page (/shop/cart/) to retry or choose another payment method.
• Cancel: The customer is redirected to the cart page, and the transaction is canceled in Odoo.

6. Transaction Status Update

• The TxSslcommerz model updates the transaction record with details like acquirer_reference (transaction ID) and sslcommerz_txn_type (card type).
• The transaction state is set to:
  • done for successful payments.
  • pending for transactions requiring further action (e.g., manual review).
  • error or cancel for failed or canceled transactions.
• Date and time of validation are recorded, converted to UTC if provided by SSLCOMMERZ.

Key Features

• Environment Flexibility: Supports both test and production environments with dynamic URL switching.
• Secure Validation: Uses SSLCOMMERZ’s validation API to ensure transaction integrity.

• Customer Redirection: Handles success, failure, and cancel scenarios with appropriate redirects.
• Transaction Tracking: Integrates with Odoo’s payment transaction model for status updates and logging.
• Customer Notifications: Adds followers to sale orders for seamless communication.

Error Handling

• Logs errors for missing or invalid transaction references.
• Validates transaction parameters to ensure consistency (e.g., matching tran_id with acquirer_reference).
• Handles unrecognized responses from SSLCOMMERZ, marking transactions as error with detailed logs.

Conclusion

The SSLCOMMERZ payment module for Odoo provides a robust integration for processing online payments, ensuring secure transaction validation and seamless customer experience. It aligns with Odoo’s e-commerce workflow, offering flexibility for both test and live environments while maintaining detailed transaction records.