Payment Gateway Provider

Businesses in the region need a local card and wallet gateway on their website. This module adds a payment provider that connects to the gateway with public, secret and API keys and an HMAC for verifying callbacks. Payment methods, currencies and countries are fetched from the account, and transactions support tokens, capture, void and refund. It plugs into the Payment app, Website checkout and Accounting.

1. 1

   Configure the provider

   Open the payment provider record and enter the public, secret and API keys, then enable it. Keys are required once the provider is active.

   • paymob_public_key
   • paymob_secret_key
   • paymob_api_key
2. 2

   Validate the keys

   The Validate button tests the credentials against the gateway. It also retrieves the HMAC and integration IDs.

   • Validate button
   • HMAC set automatically
3. 3

   Sync payment methods

   Payment methods are created from the account's integration IDs with descriptions. Available currencies and countries are updated from the same data.

   • integration_id
   • Currencies and countries
4. 4

   Customer pays online

   At checkout the customer selects the gateway and is redirected to complete the payment. The transaction creates an intent with amount details.

   • Redirect form
   • Down payment and discount fields
5. 5

   Process the callback

   The return controller verifies the HMAC, normalizes data and updates the transaction state. Saved tokens support later payments.

   • HMAC verification
   • Token handling
6. 6

   Refund, capture and void

   From the transaction staff can send capture, void or refund requests to the gateway. Results update the payment and accounting records.

   • Refund request
   • Void request

Back to version applications