Sign up for registering a new account

A guide to registering a new accept account.

To create your account, follow these steps

1. Navigate to Accept's home page

2. After that, you will enter your mobile number on which you will be receiving OTP for first-time verification.

3. As soon as you enter the OTP that you have received on your mobile number, you will get the below screen where you will be adding your name, and email details including your desired Password which you will be using for further logging.

4. Please note that after this screen you will get a login screen where you will be entering your registered mobile number without country code and your password which you have set in the previous screen.

5. As soon as you will log in, you will get the below screen to enter your business details.

After filling in this information, you will get a " Registration successful" message on the screen and you will be routed to your Paymob Dashboard as below :

Great-Now you have successfully made your Merchant portal dashboard 

Now you can go to the Sign-In page and start accepting online payments from your customers, Go check our use case guide and choose your perfect payment scenario!

A detailed guide to your Accept dashboard

In order to deal with any of Accept's services, you have to create an Accept account.

In your Accept portal, you can find:

• Profile.
• Payment Integrations.
• Orders.
• Transactions.
• Checkout Customization.

Welcome to the API Checkout Experience documentation! In this guide, you will learn how to integrate and set up our API to provide a seamless and unified checkout experience. This includes everything you need to get started with setting up the API, generating your keys, and configuring both the Unified Intention API Checkout and Pixel Native Payment experiences.

We'll walk you through the basics of the API, including an overview of how it works, step-by-step instructions on how to get your environment set up, and how to use the various endpoints to facilitate secure and efficient transactions.

A handy way to successfully integrate our gateway within your Shopify store, please follow along with the below steps to accomplish your integration

Steps for Shopify Integration:

1- Log in to your Shopify Dashboard.

2- Select Settings from the left bottom of your Dashboard page.

3- After clicking Settings, select “Payments”.

4- At the payment page, please make sure that the Payment Capture option should be Automatic.

5- In “Payments”. Click on the Add Payment Methods button.

6- After choosing “Add Payment Method” click on Search by the provider, write Paymob in the search field, and click on the Paymob icon.

7. Further, click on the Connect Button.

8. Choose your Shopify store country.

9. After choosing your country, you will see below page to install your app.

10. Then, it will ask for your Paymob dashboard credentials. The merchant must log in only using the owner's account credentials.

11. Click on Activate Paymob and make sure to select the "Enable Test mode" if you want to perform the test transactions. You will choose the payment methods according to the availability in your country as well as your requirements.

Now Paymob Services are activated on your Shopify.

You can perform your test transactions by using the below Test credentials.

Once you have successfully performed your test transactions. You can contact your sales agent or the Paymob support team for your live account.

Please follow the below steps to successfully install and configure the Paymob plugin for WordPress (WooComerce). The plugin supports a customizable checkout experience, allowing merchants to tailor their checkout process through the Merchant Dashboard. Additionally, the "Pay with Saved Card" feature is available, enabling users to manage their saved cards easily. Users can access and manage their saved cards by navigating to Account > Paymob Saved Cards section.

Guide for installing Accept's OpenCart plugin supporting our payment methods ( Credit Card, Omannet).

OpenCart 4.x.x plugin

Installation Steps:

Download the plugin file and follow the instructions on how to set it up.

Log in to the Opencart admin panel and click Extension =Installer.

Then, at the top-left side of the page click on the Upload icon and locate the Upload Plugin file.

In the Installed Extensions, locate Paymob Payment. Then, click on Install It.

From the left menu in OpenCart admin=> Extensions = Extensions =>Payments, find Paymob Payment.

Then, click on the install icon.

Merchant configuration

Log into Paymob account => Setting in the left menu. Then get the Secret, public, and API keys.

Paste each key in its place in the Paymob OpenCart setting page.

Then, click on the Validate PayMob API key button to ensure the data provided keys are valid and returns the needed information. (Important)

The HMAC key will be shown in its field and the existing Paymob integration IDs as well. In case any of the provided data is not correct, the validation will fail.

Please ensure to select the integration IDs that you need the end-user pay with/sees in Paymob payment page. (Important)

Copy the integration callback URL that exists in Paymob OpenCart setting page. Then, paste it into each payment integration in Paymob account .

Then, click on Save Changes.

Checkout page

Paymob payment method will be shown for the end-user to start his payment process.

OpenCart 3.x - 2.3 plugin

Installation Steps: Download the plugin file and follow the instructions on how to setup it up. • Log in to the Opencart admin panel and click Extension =>Installer=> Upload your extensions.

• From the left menu in OpenCart admin=> Extensions = Extensions =>Payments, find Paymob Payment. • Then, click on the install icon.

Merchant configuration • Log into Paymob account => Setting in the left menu. Then get the Secret, public, and API keys.

• Paste each key in its place in the Paymob OpenCart setting page. • Then, click on the Validate PayMob API key button to ensure the data provided keys are valid and returns the needed information. (Important) • The HMAC key will be shown in its field and the existing Paymob integration IDs as well. In case any of the provided data is not correct, the validation will fail. • Please ensure to select the integration IDs that you need end-user pay with/sees in Paymob payment page. (Important)

• Copy the integration callback URL that exists in Paymob OpenCart setting page. Then, paste it into each payment integration in Paymob account

• Then, click on save changes.

Checkout page Paymob payment method will be shown for the end-user to start his payment process.

Magento Marketplace

You can check the Paymob Magento 2 module from the Magento Adobe marketplace page.

Installation Steps

In the server cmd terminal

Run the below command to install the Paymob Payment via composer

Shell

 
   composer require paymob/magento-payment 

Run the below Magento commands to enable Paymob Module

Shell

 
   php -f bin/magento module:enable --clear-static-content Paymob_Payment  
   php bin/magento setup:upgrade  
   php bin/magento setup:di:compile  
   php bin/magento setup:static-content:deploy -f  
   php bin/magento cache:clean  
   php bin/magento cache:flush

Merchant Configuration

PayMob Account

1. Log into Paymob account => Setting in the left menu.
2. Get the Secret, public, API keys, HMAC and integration IDs.

Magento admin configuration

1. In Magento Admin Panel Menu Stores → Configuration
2. Expand Sales Menu → select Payment Methods → Accept Paymob payment paste each key in its place in the setting page.
3. Please ensure adding the integration IDs separated by comma ,. These IDs will be shown in the Paymob payment page.
4. Copy the integration callback URL that exists in Paymob Magento setting page. Then, paste it into each payment integration/method in Paymob account

5. Then, click on save changes.

6. Ensure there's no error while saving due to incorrect information provided.

Checkout page

Paymob payment method will be shown for the end-user to start his payment process.

We are supporting the following Odoo versions:

• Odoo Version 18
• Odoo Version 17
• Odoo Version 16
• Odoo Version 15

Introduction

The Odoo Payment Plugin is available for merchants using Odoo.sh and Odoo On-Premise.

Installation & Configuration Steps

1

Merchants can access the plugin via Paymob | Odoo Apps Store.

2

Once you deploy the plugin on the Odoo Instance, navigate to Configuration → Payment Providers.

3

Activate the Paymob Plugin.

4

After activation is complete, you will be directed to the screen below:

5

Credential Section

• If the "Enabled" state is selected, the plugin will be in the Published state. Enter the Live Mode API Key, Secret Key, and Public Key.
• If the "Test Mode" state is selected, the plugin will be in the Unpublished state. Enter the Test Mode API Key, Secret Key, and Public Key.

Note: The keys for Test and Live Mode are different.

• If you select LIVE Mode, all transactions will involve real money.

Where to Find the Keys?

Log in to the Paymob Merchant Dashboard and go to the Settings section. Select "Live" mode to access Live Keys or "Test" mode to access Test Keys. All keys can be found under the Account Info section.

6

After entering the keys, click on “Validate”. If the keys are validated successfully, all the Payment Methods will be enabled for the given set of keys.

7

Merchants can view the available payment methods on the Configuration Page.

8

Merchant can click on “Enable Payment Methods” to view all the Payment Integrations for the entered Keys. By default, the Payment Methods will be in disabled state . Merchants will need to enable the Payment Methods. Merchants can edit the logo of Payment Methods and change the name of Payment Method by clicking on the respective Payment Methods. It’s recommended not to edit the name and logo of Payment Methods.

In Odoo 18, payment methods will be displayed as a list. Payments that are in an Active State will be shown on Odoo's Checkout

9

Webhook Configurations - Once Merchants will enable any Payment Method, webhook will be automatically configured in the Paymob System for that integration ID.

10

Card Tokenization In case the merchant wants to enable the “Pay with Saved Card” feature for the consumer, the following steps need to be followed:

9.1 Access Checkout Customization Log in to the Paymob Merchant’s Dashboard and navigate to the Checkout Customization section. 9.2 Enable "Save Card" Option Under the Payment Section, enable the “Show Save Card” option and click on “Apply Changes”.

If the user consents to save the card during the initial transaction, the user will be shown the option to pay with saved cards for subsequent transactions.

FAQ’s

• The plugin is available in Egypt, UAE, KSA, and Oman.
• The plugin supports the Auth + Capture Model.
• The plugin supports both Full and Partial Refunds.
• The plugin supports Checkout Customization.

Checkout Sample

Introduction

The Odoo Payment Plugin is available for merchants using Odoo.sh and Odoo On-Premise.

Installation & Configuration Steps

1

Merchants can access the plugin via Paymob | Odoo Apps Store.

2

Once you deploy the plugin on the Odoo Instance, navigate to Configuration → Payment Providers.

3

Activate the Paymob Plugin.

4

After activation is complete, you will be directed to the screen below:

5

Credential Section

• If the "Enabled" state is selected, the plugin will be in the Published state. Enter the Live Mode API Key, Secret Key, and Public Key.
• If the "Test Mode" state is selected, the plugin will be in the Unpublished state. Enter the Test Mode API Key, Secret Key, and Public Key.

Note: The keys for Test and Live Mode are different.

• If you select LIVE Mode, all transactions will involve real money.

Where to Find the Keys?

Log in to the Paymob Merchant Dashboard and go to the Settings section. Select "Live" mode to access Live Keys or "Test" mode to access Test Keys. All keys can be found under the Account Info section.

6

After entering the keys, click on “Validate”. If the keys are validated successfully, all the Payment Methods will be enabled for the given set of keys.

7

Merchants can view the available payment methods on the Configuration Page.

8

Merchant can click on “Enable Payment Methods” to view all the Payment Integrations for the entered Keys. By default, the Payment Methods will be in disabled state . Merchants will need to enable the Payment Methods. Merchants can edit the logo of Payment Methods and change the name of Payment Method by clicking on the respective Payment Methods. It’s recommended not to edit the name and logo of Payment Methods.

In Odoo 18, payment methods will be displayed as a list. Payments that are in an Active State will be shown on Odoo's Checkout

9

Webhook Configurations - Once Merchants will enable any Payment Method, webhook will be automatically configured in the Paymob System for that integration ID.

10

Card Tokenization In case the merchant wants to enable the “Pay with Saved Card” feature for the consumer, the following steps need to be followed:

9.1 Access Checkout Customization Log in to the Paymob Merchant’s Dashboard and navigate to the Checkout Customization section. 9.2 Enable "Save Card" Option Under the Payment Section, enable the “Show Save Card” option and click on “Apply Changes”.

If the user consents to save the card during the initial transaction, the user will be shown the option to pay with saved cards for subsequent transactions.

FAQ’s

• The plugin is available in Egypt, UAE, KSA, and Oman.
• The plugin supports the Auth + Capture Model.
• The plugin supports both Full and Partial Refunds.
• The plugin supports Checkout Customization.

Checkout Sample

Introduction

The Odoo Payment Plugin is available for merchants using Odoo.sh and Odoo On-Premise.

Installation & Configuration Steps

1

Merchants can access the plugin via Paymob | Odoo Apps Store.

2

Once you deploy the plugin on the Odoo Instance, navigate to Configuration → Payment Providers.

3

Activate the Paymob Plugin.

4

After activation is complete, you will be directed to the screen below:

5

Credential Section

If the state "Enabled" is selected, the plugin will be in the Published state. Enter the Live Mode API Key, Secret Key, Public Key & the LIVE Payment Integration IDs are to be made available on Paymob’s Checkout.

If the state "Test Mode" is selected, the plugin will be in the Unpublished state. Enter the Test Mode API Key, Secret Key, Public Key & the TEST Payment Integration ID are to be made available on Paymob’s Checkout for testing Purposes.

Note: The keys for Test and Live Mode are different..

Where to Find the Payment Integration IDs?

Log in to the Paymob Merchant Dashboard

• Select the Mode(Test/Live: In Live Mode, Live Integration IDs will be listed, while in Test Mode, Test Integration IDs will be displayed.
• Navigate to Developers → Payment Integrations Section
• “ID” refers to “Integration ID”

6

After entering the keys & the integration id’s, click on "Validate." If the keys are successfully validated, all the payment methods associated with the entered integration IDs will be enabled.

7

Merchants can view the available payment methods on the Configuration Page under the Payment Form section.

In Odoo 16, payment methods will not be displayed as a list. Instead, only the provider name or the name set by the merchant in the "Displayed as" label will appear on Odoo's checkout.

8

Webhook Configurations - Once merchants enter the Integration IDs in the Credentials section and the keys are validated, the webhook will be automatically configured in the Paymob system for those integration IDs.

09

Card Tokenization In case the merchant wants to enable the “Pay with Saved Card” feature for the consumer, the following steps need to be followed:

9.1 Access Checkout Customization Log in to the Paymob Merchant’s Dashboard and navigate to the Checkout Customization section. 9.2 Enable "Save Card" Option Under the Payment Section, enable the “Show Save Card” option and click on “Apply Changes”.

If the user consents to save the card during the initial transaction, the user will be shown the option to pay with saved cards for subsequent transactions.

FAQ’s

• The plugin is available in Egypt, UAE, KSA, and Oman.
• The plugin supports the Auth + Capture Model.
• The plugin supports both Full and Partial Refunds.
• The plugin supports Checkout Customization.

Checkout Sample

Introduction

The Odoo Payment Plugin is available for merchants using Odoo.sh and Odoo On-Premise.

Installation & Configuration Steps

1

Merchants can access the plugin via Paymob | Odoo Apps Store.

2

Once you deploy the plugin on the Odoo Instance, navigate to Configuration → Payment Acquirers.

3

Activate the Paymob Plugin.

4

After activation is complete, you will be directed to the screen below:

5

Credential Section

If the state "Enabled" is selected, the plugin will be in the Published state. Enter the Live Mode API Key, Secret Key, Public Key & the LIVE Payment Integration IDs are to be made available on Paymob’s Checkout.

If the state "Test Mode" is selected, the plugin will be in the Unpublished state. Enter the Test Mode API Key, Secret Key, Public Key & the TEST Payment Integration ID are to be made available on Paymob’s Checkout for testing Purposes.

Note: The keys for Test and Live Mode are different..

Where to Find the Payment Integration IDs?

Log in to the Paymob Merchant Dashboard

• Select the Mode(Test/Live: In Live Mode, Live Integration IDs will be listed, while in Test Mode, Test Integration IDs will be displayed.
• Navigate to Developers → Payment Integrations Section
• “ID” refers to “Integration ID”

6

After entering the keys & the integration id’s, click on "Validate." If the keys are successfully validated, all the payment methods associated with the entered integration IDs will be enabled.

7

Merchants can view the available payment methods on the Configuration Page under the Payment Form section.

In Odoo 15, payment methods will not be displayed as a list. Instead, only the provider name or the name set by the merchant in the "Displayed as" label will appear on Odoo's checkout.

8

Webhook Configurations - Once merchants enter the Integration IDs in the Credentials section and the keys are validated, the webhook will be automatically configured in the Paymob system for those integration IDs.

09

Card Tokenization In case the merchant wants to enable the “Pay with Saved Card” feature for the consumer, the following steps need to be followed:

9.1 Access Checkout Customization Log in to the Paymob Merchant’s Dashboard and navigate to the Checkout Customization section. 9.2 Enable "Save Card" Option Under the Payment Section, enable the “Show Save Card” option and click on “Apply Changes”.

If the user consents to save the card during the initial transaction, the user will be shown the option to pay with saved cards for subsequent transactions.

FAQ’s

• The plugin is available in Egypt, UAE, KSA, and Oman.
• The plugin supports the Auth + Capture Model.
• The plugin supports both Full and Partial Refunds.
• The plugin supports Checkout Customization.

Checkout Sample

WHMCS Marketplace

You can check the Paymob WHMCS module from the WHMCS marketplace page.

Installation Steps

1. Download the Paymob WHMCS plugin from here.
2. Extract the downloaded WHMCS module .zip file into your server in the path of WHMCS project.
3. Login in to the WHMCS admin panel, navigate to Setup → Apps & integrations → Browse → Payments.
4. Search for Paymob Payment, then click on Manage button.

Admin configuration

1. Log into Paymob account → Setting in the left menu. Then get the Secret, public, API keys, HMAC and integration IDs.

1. In WHMCS admin, Navigate to Addons→ Apps & integrations → Payments Apps.
2. Configure the new module in the Manage Existing Gateways tab.
3. Add Paymob configuration as mentioned in the first point.
4. Copy integration callback URL that exists in Paymob WHMCS setting page. Then, paste it into each payment integration/method in Paymob account.
5. Then, click on save changes.

Checkout page

Paymob payment method will be shown for the end-user to start his payment process.

Cs-Cart Marketplace

You can check the Paymob Cs-Cart Addon from the marketplace page.

Installation Steps

1. Download the Paymob Cs- Cart Addon from the marketplace
2. Login into Cs-Cart admin panel, from the upper menu, click on Add-ons → Manage add-ons.
3. Click on the tools/setting icon in the upper right corner.
4. Choose Manual installation → Local and Select the Paymob downloaded .zip file.

5. Then, click on the Upload & Install button.

6. The Paymob addon will appear on the Add-ons list.

Admin configuration

1. From the Cs-Cart admin panel, in the upper menu click on "Administration" →"Payment Methods".
2. Click on the Add button on the top right to add the payment method.
3. You can name your payment method according to the one you need to add and then choose Paymob in the "Processor" dropdown list.
4. Click on "Configure".
5. Add all the configurations needed.
6. Log in to Paymob account → Setting in the left menu. Then get the Secret, public, and API keys.

7. Paste each key in its place in the Paymob Cs-Cart setting page.

8. Then, click on Validate PayMob API key button to ensure the data provided keys are valid and returns the needed information. (Important)

9. The HMAC key will be shown in its field and the existing Paymob integration IDs as well. In case any of the provided data is not correct, the validation will fail.

10. Copy integration callback URL that exists in Paymob Cs-Cart setting page. Then, paste it into each payment integration in Paymob account.

11. Then, click on save changes.

Checkout page

Paymob payment method will be shown for the end-user to start his payment process.

Installation Steps

1. Paymob PrestaShop unified checkout module is compatible with PrestaShop versions 1.6, 1.7 and 8.
2. Download the Paymob PrestaShop module from here
3. Login into Prestashop admin panel → Modules → Module Manager → Upload a module.
4. Select the Paymob downloaded .zip file.

5. You will see that the module is now uploaded and installed.

6. The Paymob module will appear on the module list.

Admin configuration

1. From the Prestashop admin panel, in the left menu Payments → payment methods.
2. Click on the configure button beside Paymob payment method to start the configuration.
3. You can name your payment method according to the one you need to display in the checkout page.
4. Log in to Paymob account → Setting in the left menu. Then get the Secret, public, and API , HMAC keys and Payment Integration IDs.

5. Paste each key in its place in the Paymob PrestaShop setting page.

6. Copy integration callback URL that exists in Paymob PrestaShop setting page. Then, paste it into each payment integration in Paymob account.

7. Then, click on save changes.

Checkout page

Paymob payment method will be shown for the end-user to start his payment process.

Paymob VirtueMart Plugin for Joomla

Installation Steps:

• Download the Paymob Joomla VirtueMart module from here. • Login into admin panel of your Joomla store. Browse to your admin panel → Extensions → Manage → Install.

• Click on "Browse for file" below, then choose our plugin ZIP file.In Plugin list

• Click on VirtueMart → Payment Methods.

• Click on the "New" button. You will be redirected to the payment method information page.

• You will then fill in the payment method information based on which one you will integrate.

• You will then click "Save" and then click on "Configuration" tab.

Merchant configuration

• Log into Paymob account = → Setting in the left menu. Then get the Secret, public ,and API keys.

• Paste each key in its place in the Paymob Virtuemart Configuration page. • Then, click on Validate API key button to ensure the data prvided keys are valid and returns the needed information. (Important) • The HMAC key will be shown in its field and the existing Paymob integration IDs as well. In case any of the provided data is not correct, the validation will fail. • Please ensure to select the integration IDs that you need end-user pay with/sees in Paymob payment page. (Important)

• Copy integration callback URL that exists in Paymob Virtuemart Configuration page. Then, paste it into each payment integration in Paymob account

• Then, click on save changes.

Checkout page

Paymob payment method will be shown for the end-user to start his payment process.

Paymob for ZenCart plugin

Installation Steps:

• Download the Paymob ZenCart module from here
• Extract the downloaded ZenCart module .zip file into your server in the path of ZenCart project.
• Login in to the ZenCart admin panel, navigate to Modules → Payment.
• Search for Paymob Payment, then click on it and install the module.

Admin configuration:

• Log into Paymob account → Setting in the left menu. Then get the Secret, public keys, HMAC and Payment integration IDs.

• Paste each key in its place in the Paymob ZenCart configuration page.

• Copy integration callback URL that exists in Paymob ZenCart Configuration page. Then, paste it into each payment integration in Paymob account

• Then, click on save changes.

Checkout page:

Paymob payment method will be shown for the end-user to start his payment process.

Paymob for Oscommerce plugin

Installation Steps:

• Download the Paymob Oscommerce module from here
• Extract the downloaded Oscommerce module .zip file into your server in the path of Oscommerce project.
• Login in to the Oscommerce admin panel, navigate to Modules → Payment → Online.
• Click on Show not installed checkbox then Search for Paymob Payment, then click on it and install the module.

Admin configuration:

• Log into Paymob account → Setting in the left menu. Then get the Secret, public keys, HMAC and Payment integration IDs.

• Paste each key in its place in the Paymob Oscommerce Settings page.

• Copy integration callback URL that exists in Paymob Oscommerce Settings page. Then, paste it into each payment integration in Paymob account.

• Then, click on save changes.

Checkout page:

Paymob payment method will be shown for the end-user to start his payment process.

Paymob for Laravel Bagisto E-Commerce

Installation Steps

Bagisto 1.x

1. Install the Paymob Payment package for Laravel Bagisto 1.x e-commerce via paymob/laravel-bagisto1.x composer.

In the server cmd terminal, Run the below command to install the Paymob Payment Package

 
composer require paymob/laravel-bagisto1.x

2. Then, run the below commands

 
php artisan migratephp artisan optimize

3. Goto app/Http/Middleware/VerifyCsrfToken.php file. Then, add **paymob/callback** in the protected array $except as below

 
protected $except = ['paymob/callback',];

4. After that, run the following command

 
php artisan config:cache

Bagisto 2.x

1. Install the Paymob Payment module for Laravel Bagisto 2.x e-commerce via paymob/laravel-bagisto2.x composer.

In the server cmd terminal, Run the below command to install the Paymob Payment Package

 
composer require paymob/laravel-bagisto2.x

2. Then, run the below commands

 
php artisan vendor:publish --force --tag=paymob
php artisan migrate
php artisan optimize

3. Goto app/Http/Middleware/VerifyCsrfToken.php file. Then, add **paymob/callback** in the protected array $except as below

 
protected $except = ['paymob/callback',];

4. After that, run the following command

 
php artisan config:cache

Merchant Configuration

PayMob Account

1. Log into Paymob account → Setting in the left menu.
2. Get the Secret, public, API keys, HMAC and integration IDs.

Bagisto admin configuration

1. In Bagisto Admin Panel Menu configuration→ sales→ payment methods.
2. Search for Paymob payment, paste each key in its place in the setting page.
3. Please ensure adding the integration IDs separated by comma ,. These IDs will be shown in the Paymob payment page.

4. Copy integration callback URL that exists in Paymob Bagisto setting page. Then, paste it into each payment integration/method in Paymob account.

5. Then, click on save changes.

Checkout page

Paymob payment method will be shown for the end-user to start his payment process.

Paymob for Drupal Commerce

Drupal Marketplace

You can check the Paymob Drupal Commerce module from the Drupal marketplace.

Installation Steps

1. In the server cmd terminal, Install the Paymob Payment module for Drupal Commerce e-commerce via Composer using below command

 
composer require paymob_drupal/commerce_paymob

2. In the admin panel, Extend tab, search for the Paymob module, select it, and click the install button to install it.

PayMob Account

1. Log into Paymob account => Setting in the left menu.
2. Get the Secret, public, API keys, HMAC and integration IDs.

Drupal commerce admin configuration

1. In Drupal commerce Admin Panel Menu Commerce → Configuration → Payments → Payment Gateways section.
2. Select Paymob payment, paste each key in its place in the setting page.
3. Ensure adding the integration IDs separated by comma ,. These IDs will be shown in the Paymob payment page.

4. Copy integration callback URL that exists in Paymob Drupal commerce setting page. Then, paste it into each payment integration/method in Paymob account

5. Then, click on save changes.

Checkout page

Paymob payment method will be shown for the end-user to start his payment process.

Overview

Paymob provides a comprehensive subscription module designed to help merchants efficiently manage their subscriptions on a variety of billing cycles, including weekly, bi-weekly, monthly, quarterly, semi-annual, and annual plans. This module is tailored to meet the specific needs of each merchant, enabling them to create, manage, and control their subscriptions independently through our APIs.

Integration Requirements

To successfully set up your subscription plan, you will need two integration IDs:

• Online 3DS Integration ID: This ID will be used for creating subscriptions.
• Moto Integration ID: Utilize this ID when creating the subscription plan itself.

Ensure you have both integration IDs ready to streamline the setup process.

For further assistance or detailed API guidance, please refer to the subsequent sections of this documentation.

Paymob provides a comprehensive range of payment options to suit various business needs, enhancing the flexibility and security of online transactions. The following are the four primary payment types supported by Paymob:

1. 3D Secure (3DS)

3D Secure (3DS) is a security protocol designed to reduce the risk of fraudulent online transactions by adding an additional layer of authentication. When a cardholder makes a purchase online, 3DS prompts the customer to authenticate their identity with the card issuer during the final stage of the checkout process. This step typically involves entering a one-time password (OTP) or biometric verification, depending on the card issuer’s requirements.

2. Auth and Capture

The Auth and Capture payment method is a two-step process where the transaction is initially authorized, but the funds are not immediately captured. First, the payment gateway authorizes the transaction by confirming that the customer has sufficient funds available, but the actual transaction amount will be captured later. If the transaction is not captured within 07 days, it will be automatically voided.

3. Card Verification

Card Verification Function is a functionality provided by the Network to authenticate a card transaction without actually deducting the transaction amount from the customer’s card.

4. Pay with Saved Card Token

The Pay with Saved Card Token method allows customers to store their card details securely for future transactions. Once a customer has completed a transaction, the payment system stores a unique token that represents their payment method. In subsequent transactions, customers can opt to pay using this saved token without having to re-enter their card details, simplifying the checkout process.

This section contains the following topics:

1. Refund Transaction through the Dashboard.
2. Refund Transaction through API.
3. Void Transaction through the Dashboard.
4. Void Transaction through API.
5. Auth/Capture Transaction through the Dashboard.
6. Auth/Capture Transaction through API.

Paymob provides a wide range of payment methods in Egypt, enabling businesses to offer seamless and secure transactions for their customers. Whether through cards, digital wallets, or installment plans, Paymob ensures a smooth payment experience tailored to diverse customer needs. Below is a list of supported payment methods:

• Card Payments
• Digital Wallets
• Apple Pay
• ValU
• Bank Installments
• Souhoola V3
• Aman V3
• Forsa
• Premium
• Contact
• HALAN
• SYMPL
• Kiosk
• InstaPay (Coming Soon)

This extensive payment network allows businesses to expand their customer reach and simplify transactions through flexible and accessible solutions.

Here are the test credentials for the online card payment method:

Mastercard:

Wallet Test Credentials :

Here are the test credentials for Wallets;

MasterCard For Simulation:

VISA Card for Simulation:

Successful Response:

Failed Response:

Retrieve A Transaction allows you to obtain the details and status of a transaction-whether it is successful or failed, using one of the following methods:

1. Retrieve Transaction with Order ID Use the Order ID to access transaction details.
2. Retrieve Transaction with Transaction ID Use the Transaction ID to obtain the relevant transaction information.
3. Retrieve Transaction with Merchant Order ID(Special Reference Number) Access transaction details using the Merchant Order ID (Special Reference Number).

Welcome to the Manage Callback documentation! In this section, we'll guide you through the different types of transaction callbacks that are essential for handling payment processing and ensuring a seamless integration with your system. Specifically, we'll cover transaction processed callbacks, transaction response callbacks, and how to calculate HMAC for processed callbacks, redirection callbacks, and saved card token objects.

You will learn how to configure and manage these callbacks, understand their role in transaction flow, and ensure that your system securely processes and responds to different events during payment transactions. Whether you're dealing with successful payments, handling failures, or managing tokenized card data, this guide will provide you with the necessary tools and knowledge to handle callbacks efficiently and securely.

Let's dive into understanding each callback type and how to calculate and implement HMAC to ensure the integrity and security of your transactions.

You can find the Risk error codes and other Acquirer response code descriptions in this section to know more about your declines, and detailed reasons.

Table Of Contents

• Definitions and Acronyms
• Generate and Refresh Token API Endpoint
• Instant Cashin API Endpoint
• Cancel Aman Transaction API Endpoint
• Bulk Transaction Inquiry API Endpoint
• User Budget Inquiry API Endpoint
• CallBack Url
• Response Codes

The Frequently Asked Questions (FAQ) section is a comprehensive resource designed to address common inquiries about our services and features. Here, you will find detailed answers to questions regarding payment methods, transaction processes, technical requirements, and security measures. Whether you're a new user seeking guidance or an experienced merchant looking for specific information, this section aims to provide clarity and support. For any additional questions not covered here, please feel free to reach out to our customer support team at support@paymob.com.