Regional Checkout Payment Gateway

A shop selling in the Sultanate needs a local online payment option in its Odoo checkout. This module adds a provider that creates a hosted payment session from the order, redirects the customer, and processes the return. It converts line amounts to the gateway currency unit and supports test and live API addresses. It depends on the Payment app and serves eCommerce and invoice payment flows.

1. 1

   Enable the provider

   Open Payment Providers and pick the gateway added by the module. Set the state to test first and then enabled. Default payment methods come from the module constants.

   • Provider code added
   • Default payment method codes
2. 2

   Enter the API keys

   Fill Secret Key and Publishable Key. The secret key is visible to system administrators only. The API URL changes with test or live state.

   • Fields: Secret Key, Publishable Key
   • Test and live API URL
3. 3

   Create the payment session

   At checkout a session request is built with product lines, amounts and the return URLs. Amounts are converted to the smaller currency unit. The response returns the hosted page address.

   • Method _gateway_prepare_payment_session_request_payload
   • Amount conversion helper
4. 4

   Customer pays on the hosted page

   The customer is redirected to the gateway page using the rendering template. After payment the gateway sends them back to the return route with the reference and success flag. The Odoo page then shows the result.

   • Template payment_gateway_templates
   • Return route with reference and success
5. 5

   Process the notification

   The return controller finds the transaction by reference and processes the notification data. A helper decides if the status is a success. The transaction becomes done or failed.

   • Method _process_notification_data
   • Helper is_success
6. 6

   Reconcile and review

   Accountants review payment transactions and reconcile them with the invoices or orders. Statuses show the outcome. Use test mode to validate before going live.

   • Payment Transactions list
   • Test before live

Back to version applications