Getting Started - Egypt
Sign up for registering a new account
A guide to registering a new accept account.
To create your account, follow these steps
- 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!
What made this section unhelpful for you?
Accept Dashboard
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.
API Checkout Experience
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.
E-Commerce Plugins
Mobile SDKs
Subscriptions
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.
Payment Types
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.
Payment Links
Payment Actions
This section contains the following topics:
- Refund Transaction through the Dashboard.
- Refund Transaction through API.
- Void Transaction through the Dashboard.
- Void Transaction through API.
- Auth/Capture Transaction through the Dashboard.
- Auth/Capture Transaction through API.
Payment Methods
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.
Test Credentials
Here are the test credentials for the online card payment method:
Mastercard:
Card | Mastercard |
Card number | 5123456789012346 |
Cardholder Name | Test Account |
Expiry Month | 12 |
Expiry Year | 25 |
CVV | 123 |
Wallet Test Credentials :
Here are the test credentials for Wallets;
Wallet Number | 01010101010 |
MPin Code | 123456 |
OTP | 123456 |
MasterCard For Simulation:
Card | Mastercard |
Card number | 5123450000000008 |
Cardholder Name | TEST CARD |
Expiry Month | 01 |
Expiry Year | 39 |
CVV | 123 |
VISA Card for Simulation:
Card | VISA |
Card number | 4111111111111111 |
Cardholder Name | Test Account |
Expiry Month | 12 |
Expiry Year | 25 |
CVV | 123 |
Successful Response:
Failed Response:
What made this section unhelpful for you?
Transaction Inquiry API
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:
- Retrieve Transaction with Order ID Use the Order ID to access transaction details.
- Retrieve Transaction with Transaction ID Use the Transaction ID to obtain the relevant transaction information.
- Retrieve Transaction with Merchant Order ID(Special Reference Number) Access transaction details using the Merchant Order ID (Special Reference Number).
Manage Callback
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.
Error Codes
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.
What made this section unhelpful for you?
Risk Declines
Paymob has its own Fraud management system to protect its Merchants from Fraudulent Transactions.
111 | ip country not in whitelist | You will receive 111 Risk decline if you are performing a transaction from Country IP which is not in whitelist. Kindly coordinate with Paymob support team for any further clarity. |
112 | ip country in black list | You will receive 112 Risk decline if you are performing a transaction from Country IP which is in Blacklist. Kindly coordinate with Paymob support team for any further clarity. |
113 | ip not in whitelist | You will receive 113 Risk decline if you are performing a transaction from "IP" which is not in Whitelist. Kindly coordinate with Paymob support team for any further clarity. |
114 | ip in blacklist | you will receive 113 Risk decline if you are performing a transaction from "IP" which is in Blacklist. Kindly coordinate with Paymob support team for any further clarity. |
121 | bin country not in whitelist | This means that you are performing a transaction from the bank card number , which bin country is not in White list in our FMS (Fraud Management System) |
122 | bin country in whitelist | This means that you are performing a transaction from the bank card number , which bin country is in black list in our FMS (Fraud Management System) |
123 | bin not in whitelist | This means that you are performing a transaction from the bank card number , which bin country is in black list in our FMS (Fraud Management System) |
124 | bin in blacklist | This transacton is getting declined due to Bin is not in whitelist. |
131 | amount_cents exceeds allowed | This transaction is getting declined due to amount limit exceed. |
141 | amount_cents exceeds moto limit | This transaction is getting declined due to amount limit exceed. |
153 | email dns check failed | This means that the email server could not find the DNS record for the entered email address in the invoice. This can happen for a number of reasons, such as: The recipient's email address is incorrect or contains a typo. |
154 | email is disposable | "This is due to disposable email addresses often being associated with fraudulent activity. For example, scammers may use disposable email addresses to create fake accounts or to sign up for services without paying. We may reject payments from disposable email addresses because they are difficult to verify. When making an online payment, we typically needs to verify your identity and your email address. This is to help prevent fraud and to the user financial information." |
201 | IP is in Global Blacklist | "IP address is in a global blacklist, it means that that the IP address has been flagged as a potential source of malicious activity. This can happen for a number of reasons, such as: IP address has been used to send spam or phishing emails. IP address has been used to launch DDoS attacks. IP address has been infected with malware. IP address has been used to commit other types of cybercrime." |
202 | Email in Global Blacklist | This is due having the email addresses linked to the attempted transactions identified as being associated with spam, phishing, Fraudulent attempts or other malicious activities. You will need to reach out to Pyamob support team directly for further support and help. |
301 | Fraud Engine | This means that this transaction has been declined due to Risk Checks and our FMS System has rejected this transaction due to any Fraud management reasons like you are not passing the genuine or unique data i.e Email, phone or Name. To avoid this error please always try to pass genuine customer data in the request parameters. |
200 | if merchant is live and using test credentials | This error code means that you are trying to pass test credentials upon live integration ids. |
As for any further inquiries related to the previously mentioned error codes or any codes raised from your side while performing any transaction, please contact your Account Manager or Contact Support team through email support@paymob.com or you can also raise a ticket through a support widget in your Merchant portal Dashboard.
What made this section unhelpful for you?
Error Messages
Error Messages
If an error occurs during performing a transaction, you can identify the specific error message and code associated with it. These error messages and codes are designed to help you understand what went wrong and how to fix it. By referencing the error message and code, you can gain a clear understanding of the issue and take appropriate action to resolve it. It's important to review the error message and code carefully to ensure that you address the root cause of the error. By doing so, you can improve the reliability and accuracy of your transactions.
0 | Transaction approved | The transaction has been processed successfully |
1 | Refer to issuer | The Cardholder issuer has indicated there is a problem with the credentials/card number used in the transaction. The Cardholder should use an alternate Card/payment method, or contact their bank to resolve this issue. |
2 | Refer to issuer, special | The Cardholders issuer has indicated there is a problem with the card number. The Cardholder should use an alternate payment method, or contact their bank. |
3 | Invalid merchant or service provider | This error indicates that either the Merchant facility is non-functional or the details entered into the Gateway are invalid.Reasons for an Invalid Merchant ID Error Code. The disconnection between your merchant account and payment gateway may be caused by a bad gateway configuration, bank error, improper card configuration, or terminated merchant account. Please reach out to our Customer support for any further support in this regard. |
4 | Pick up card | The issuing bank of the customer has declined the transaction as the card may have been reported as stolen or lost. Please advise cardholder to contact their issuing bank for the resolution of this error. |
5 | Do not honour | "Do not error comes when the customer's issuing bank is not authorising this transaction due to any valid reason. The payment has been declined by your bank. Please try a different card or contact your bank for further support. This error can be triggered due to following reason. a) The bank's fraud rules (which consider various factors that are not made public) have been triggered. b) The bank may have placed a temporary hold on the customer's card. c) The purchase session may have been locked due to multiple declined payments. d) The seller is located in a country different from that of the card issuing bank. This can be resolved by following below steps:
" |
6 | Error | The Cardholders issuer has declined the transaction as there is a problem with the card number. The Cardholder should contact their card issuer and/or use an alternate payment method. |
7 | Pickup card, special condition (other than lost/stolen card) | The Cardholders card issuer has declined the transaction and requested that the card be retained as the card may have been reported as lost or stolen. |
8 | Honour with identification | Transaction processed successfully - identification NOT required. This code is returned by some banks in place of 00 response. This means your transaction has been approved. |
9 | Request in progress | The Cardholders issuer has indicated there is a problem with the card number. The Cardholder should contact their bank and/or use an alternate payment method. |
10 | Approved for partial amount | The transaction was successful for a partial amount. |
12 | Invalid transaction | The bank has declined the transaction because of an invalid format or field. This indicates the card details were incorrect. Check card data entered and try again. This code is often returned from the issuer when they do not accept the transaction. This can possibly be when a transaction for the same amount and merchant is attempted multiple times quickly for the same card. The cardholder should contact their issuing bank. |
13 | Invalid amount | The Cardholders issuer has declined the transaction because of an invalid format or field; or amount exceeds maximum for card program.This usually is the result of a typo (negative amount or ineligible symbol). Double-check what you entered and make sure it wasn't negative or included incorrect symbols. |
14 | Invalid card number | " The Cardholders issuing bank has declined the transaction as the payment card number is incorrectly entered, or does not exist.This indicates a problem with the information entered for the card. Double-check the card number, expiration date, and CVV. If you haven't already, also ensure that the card has been activated" |
15 | No issuer | The Cardholders issuer does not exist. Check the card information and try processing the transaction again.Wrong card number (Codes 14 & 15): There are two wrong ways to enter the card number improperly. If the very first digit is incorrect, you'll see error code 15 for “no such issuers” since the first digit pinpoints the card's issuing bank. If we say more specifically ,The card number entered is wrong since it doesn’t start with a 3 (AMEX), 4 (Visa), 5 (MasterCard), or 6 (Discover). |
16 | Approved, update track 3 | An unspecified bank error has occurred. The Cardholder should attempt to process the transaction again. |
17 | Customer cancellation | "This indicates that the transaction was authorised and subsequently voided. Voided transactions do not appear on the customer's statement or form part of your settlement total." |
18 | Customer dispute | The Cardholders card issuer has prevented this transaction from taking place due to an ongoing or previous dispute. |
19 | Re-enter last transaction | The transaction has not been processed and the Cardholder should attempt to process the transaction again. No further information is provided from the bank as to the reason why this was not processed. |
20 | Invalid response/acquirer error | The bank has declined the transaction because of an invalid format or field. This indicates the card details were incorrect. Check card data entered and try again. |
21 | No action taken | The Cardholders issuer has indicated there is a problem with the payment card number. The Cardholder should use an alternate payment method, or contact their bank. |
22 | Suspected malfunction | The Cardholders issuer could not be contacted during the transaction. The Cardholder should check the card information and try processing the transaction again. |
23 | Unacceptable transaction | An unspecified bank error has occurred. The Cardholder should attempt to process the transaction again. |
24 | File update impossible | An unspecified bank error has occurred. The Cardholder should attempt to process the transaction again. |
25 | Unable to locate record on file | The Cardholders card issuer does not recognise the credit card details. The Cardholder should check the card information and try processing the transaction again. |
26 | Duplicate reference number | The Cardholders card issuer does not recognise the credit card details. The Cardholder should check the card information and try processing the transaction again. |
27 | Error in reference number | The Cardholders card issuer does not recognise the credit card details. The Cardholder should check the card information and try processing the transaction again. |
28 | File is temporarily unavailable for update | An unspecified bank error has occurred. The Cardholder should attempt to process the transaction again.A code 28 error happens during this initial authorization process. It simply means there was an issue immediately retrieving the information from the card-issuing bank. Therefore, because of its temporary status, the transaction should be put through again. |
29 | File action failed/contact acquirer | An unspecified bank error has occurred. The Cardholder should attempt to process the transaction again. |
30 | Format error | The Cardholders issuer does not recognise the transaction details being entered. This is due to a format error. The Cardholder should check the transaction information and try processing the transaction again. We can further explain this as "An "Invalid format" error when updating your credit card means that the credit card number was entered with spaces, dashes, or some other character that is not allowed." |
As for any further inquiries related to the previously mentioned error codes or any codes raised from your side while performing any transaction, please contact your Account Manager or Contact Support team through email support@paymob.com or you can also raise a ticket through a support widget in your Merchant portal Dashboard.
What made this section unhelpful for you?
Bills Portal API
Payouts
Frequently Asked Questions (FAQs)
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.