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.

A guide to the plug-in tab in your Accept dashboard. Please scroll down to "Settings" to update your profile settings on the Dashboard.

Business Branding

You can add your logo by clicking on "Update" and adjusting business settings from this tab.

Account Info

You can get your account status, HMAC, API key, Secret key, Public key, and Merchant ID from the settings tab in the dashboard.

HMAC Secret

Please skip this part if you are integrating with Accept through one of the standalone checkout tools.

It is the hash secret with which all the requests between your server and Accept's server are authenticated, it is used for calculating the hmac authentication query param that comes with the transaction callbacks.

API Key

Please skip this part if you are integrating with Accept through one of the standalone checkout tools.

Accept authenticates your API requests using your account’s API keys, so use this API key to obtain your authentication token, check the Auth API to learn more about the API key usage.

To obtain your API key, click on the eye sign under the API key tab, you can change your API key whenever you need by clicking on the refresh button.

Change your account password

1. Click on the Password button.

2. Enter your old password, then enter your new password, then select Submit.

Email Notification

1. Accept notifies you whenever there's a transaction performed on one of your orders.
2. You receive this notification on the primary email, which you've registered your account with.
3. You can enable the payment notification from the notification button in your profile tab.
4. From there you can enable it or disable it, then click submit.

5. You can add extra emails to get a payment notification from the Update button.

6. Then add the desired email.

A guide for your Integration IDs.

By reading this guide you will understand the functionalities of the payment integrations tab found in your dashboard and you will be able to create/control your own payment integration IDs

Payment Integrations Tab

1. Log in to your Accept [portal]. "Sign up for a new account if you don't already have one" "Learn how to create a new Accept account"
2. In your dashboard, click on the “Payment Integrations” tab in your navigation board, where you should find all the existing payment method integration IDs related to your Accept account listed as viewed below.

Adding New Integration ID

1. To add a new payment integration in your Paymob Dashboard, navigate to the Payment Integrations tab. Look for the "Add" button located in the upper right corner of the screen, as shown in the image below. Click on it to proceed with setting up your new payment integration.

2. A pop-up screen as the image below should appear to you.

3. Click on the type field and choose “MIGS” for cards payment method, "Mobile Wallets" for mobile wallet payment method, and “Kiosk” for the kiosk payment method. 

4. Set the currency to “EGP”

If you're using one of Accept's quick link checkout tools leave the callback URLs as it is, click on the submit button and that's it you're ready to use your integration ID.

If you're integrating with Accept directly through your APIs, please check the transaction callbacks guide.

Modification of Integration Name, Processed Callback Url, and Response Callback Url:

If you would like to edit the integration name, transaction processed callback, or response callback, please click the "Edit" button.

Integration Name:

• The integration name can be customized to suit your preferences, serving as a unique identifier for your records.
• This name can also be included in the payment_methods parameter within the integration method, serving as the integration ID

Transaction Processed Callback:

• Configure this with the URL where you wish to receive server-to-server notifications regarding the transaction status.
• This callback is triggered after any payment process is completed by the customer.
• It sends a notification to a specified endpoint in your web application, providing detailed information about the transaction.

Transaction Response Callback:

• Configure this with the URL where you would like to redirect the customer after they complete the payment.
• This callback provides immediate feedback on the transaction request, indicating whether the transaction was successful or not.

A guide to the Orders tab in the Accept dashboard.

Learn how to register a new Accept account.

Orders Tab

1. In your dashboard, click on the Orders tab found in your navigation board as shown in the image below.

2. You should have a view similar to the one shown in the image below.

If you click on any of your orders in the order summary section, you should have a view similar to the one in the image below.

The Order detail tab will give you extra details about your order, and the link of your order if it was created through one of Accept's standalone checkout tools. Also, you can delete this order if you want from the delete button found in the right upper corner of the order detail.

Order Detail Deep Filter

You can filter the viewed order by using the filter button found in the right upper corner of the order summary.

The following table will describe each of the filter parameters

An instruction manual on how to use the Transactions tab within your Accept dashboard.

The transaction tab is where you can find all the payment transactions performed for your orders from all the available payment channels. You can export, filter, and monitor your transactions.

Learn how to register a new Accept account.

Transactions Tab

1. In your dashboard, click on the Transactions tab found in your navigation board, you should have a view similar to the one shown in the image below.

Let's explain the usage and references of each section of this tab.

Live Processed

This section gives you a quick review of the numbers of your live processed transactions.

Accept Dashboard - Transactions Tab.

By default, it shows the total number of your performed transactions and the precise amount passed through each payment channel depending on the selected currency or a specific date range.

Transactions Summary

This section will allow you to view your transactions in more detail.

The Transaction Summary table gives you the following details:

If you click on any of your transactions in the transaction summary section, you should have a view similar to the one in the image below.

The Transaction detail tab will provide you with extra details about your transactions, related orders, the related payment channel, the billing data related to the customer Also, you can delete this order if you want from the delete button found in the right upper corner of the order detail.

Transaction Detail Deep Filter

You can filter the viewed transactions by using the filter button found in the right upper corner of the order summary.

The following table will describe each of the filter parameters

Customize Your Checkout

You can personalize the checkout experience directly from your Merchant Dashboard.

Steps for Customization:

1. Navigate to the "Checkout Customization" tab.

2. Make your desired changes.

3. Click "Apply Changes" to save your customization.

Customization Sections:

1. Branding

• 1.1 Logo: Upload your business logo in PNG, JPG, or JPEG formats (size up to 1 MB).
• 1.2 Business Address & Phone Number: Display your business address and phone number on the checkout page.
• 1.3 Brand Color:
  • Background: Set the background color to match your brand.
  • Button: Customize the button color.
• 1.4 Font: Select a font style that aligns with your brand.
• 1.5 Style: Choose a style that suits your brand identity.

2. Payment

• 2.1 Layout Options: Choose how to display payment methods:
  • Tab View: Displays up to four payment methods upfront. If more than four methods are available, "Pay Later" will be grouped under a "Pay Later" section. If "Kiosk" is included, up to five payment methods will be displayed upfront.

• List View: Payment methods will be displayed in a list format, with "Pay Later" methods grouped under a single header if enabled.

List View - Without Pay Later Payment Methods Grouped:

List View - With Pay Later Payment Methods Grouped:

• 2.2 Payment Methods: All available payment methods, including test and live integrations, will be displayed. If you have multiple integration IDs for a payment method, it will appear only once. You can enable or disable payment methods using the toggle button. Disabled methods will not appear during checkout. Reorder payment methods by dragging them up or down in the list.
• 2.3 Additional Information:
  • 2.3.1 Show Billing Address: Enable this option and pass the Billing Data to display the Billing Address on Checkout. Applicable for merchants integrated via direct API or Plugin. Not applicable for Quick Link products. Billing Data is passed through Intention API.
  • 2.3.2 Show Item/Product: Enable this option and pass the Item Data to display item details on Checkout. Applicable for merchants integrated via direct API or Plugin. For Quick Link products, product descriptions will always be shown on Checkout if provided during Quick Link creation. Item Data is passed through Intention API.
  • 2.3.3 Show Save Card: Enable this option to allow users to save their card information. Applicable for Card and Bank Installment Payments. To enable the save card feature, please contact your Account Manager.

3. Post Payment Section

• 3.1 Payment Confirmation Message: Display a customized payment confirmation message shown to consumers upon successful transaction.
• 3.2 Re-direction Experience: Choose from three options for the post-payment experience. Option 1 is the default. This option is applicable for merchants integrated via Direct API or Plugin and not for Quick Link merchants, as redirection experience is not applicable for them.

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.

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.