Step 1 β Setup and activate the integration method
PayTabs Mobile SDKs streamline the integration process with the PayTabs payment gateway by offering a pre-configured payment interface. This interface efficiently manages card data entry, billing and shipping information, and automatically supplements any missing details required to complete the transaction flow.
System Requirementsβ
To start integrating your system through this SDK, kindly make sure of the following system requirements first to avoid any environmental issues according to the operating system/application type:
- First of all, you need to have a PayTabs merchant account relative to your business country.
- For the Flutter environment:
- For the IOS Applications:
- For the Android Applications:
Setup, Activate and Upgrade the integration methodβ
Flutter is an open-source UI software development kit. In addition to a react-style framework, this toolkit includes its own rendering engine, a rich set of ready-made widgets, unit and integration testing APIs, plugin APIs, and command-line tools for building and compiling apps.
We will walk you through how to manage the setup of our Flutter SDK from scratch. You will be introduced to how to install the SDK, activate it, and upgrade it as well if needed. You will be also introduced to how to uninstall it as well if needed. Kindly take your time in reading and simulate the following guidelines:
How to install and activate this SDK?β
Details
You can install this SDK into your project as clarified below:
That for the version number, please use the latest version according to our latest update on our repository.
To install the PayTabs SDK into your project, specify it in your dependencies file -located in your project root directory under the name of pubspec.yaml- with the latest SDK version available at the time:
dependencies: flutter_PayTabs_bridge: ^X.X.X
In most cases, the editor will install the package automatically if not, please do one of the below steps to proceed with the installation.
From the terminal: Run
flutter pub getOR
From Android Studio/IntelliJ: Click Packages get in the action ribbon at the top of pubspec.yaml.
From VS Code: Click Get Packages located on the right side of the action ribbon at the top of pubspec.yaml.
After that, you will receive a notification message asking you if you want to synchronize the dependencies file as you just modified it. Kindly approve the "Sync Now" option as shown below:

How to upgrade the SDK?β
Details
To upgrade the PayTabs SDK that has been built in your project, specify it in your dependencies file located in your project root directory under the name of pubspec.yaml- with the new SDK version you wanted to upgrade to:
dependencies:
flutter_PayTabs_bridge: ^X.X.X
Then after that, you will receive a notification message asking you if you want to synchronize the dependencies file as you just modified it. Kindly approve the "Sync Now" option as shown below:

How to uninstall the SDK?β
Details
To uninstall the SDK that has been built into your project using, remove the line you already specified from your dependencies file located in your project root directory under the name of pubspec.yaml:
dependencies:
flutter_PayTabs_bridge: ^X.X.X
Then after that, you will receive a notification message asking you if you want to synchronize the dependencies file as you just modified it. Kindly approve the "Sync Now" option as shown below:

Supported Payment Methodsβ
This SDK is supporting various types of payment methods as shown below:
CreditCard
American Express
mada
UnionPay
OmanNet Debit
UrPay
StcPay
Valu
Aman
Meeza (QR)
KnetPay (Debit)
KnetPay (Credit)
ApplePay
SamsungPay
Forsa
Halan
Tamara
Souhoola
Tabby
Tru (Shahry)
You should know that all the main payment methods which are (Credit Cards, SamsungPay, and ApplePay) are managed (displayed and handled) in the SDK form itself. However, the rest of the payment methods mentioned above which are considered APMs (Alternative Payment Methods) will be displayed in a WebView using the Hosted Payment Page methodology instead to be managed on our side instead.
To know more about this, please check our Step 4 - Accepting the payment solution article.