Setup of MyFatoorah Payment Gateway
This section contains essential information and usage guidelines for integrating the MyFatoorah payment gateway within the Agency Partner Panel.
Overview
MyFatoorah – Overview
MyFatoorah is a payment gateway that allows businesses to accept online payments through multiple payment methods. With the MyFatoorah integration, you can collect payments directly through the platform and manage transactions from your dashboard.
Once connected, it enables a smooth and secure payment experience for your customers.
Key Benefits of MyFatoorah Integration
Accept online payments through multiple methods.
Send payment links directly to customers.
Secure and reliable transaction processing.
Track payment status in real time.
Simplifies subscription and add-on purchases.
Where MyFatoorah Is Used
MyFatoorah can be used for:
Plan purchases
Add-on purchases
Subscription renewals
Customers can select MyFatoorah as their payment method during checkout.
Prerequisites
Before starting, make sure you have:
An active MyFatoorah account
Access to API credentials (API Key / Token)
Admin access to your BotPenguin dashboard
A. Get API Credentials from MyFatoorah
How to Generate Your API Token Key:
Log in to your MyFatoorah account using your Super Master Account https://portal.myfatoorah.com/En/KWT/Dashboard.
From the side menu, select Integration Settings → API Key
Click the "Add button" to generate a new key.
You will be redirected to a page where you can configure the key settings:
Name: A custom label for your token.
Expiry Date: Define when this key will expire.
Active Status: Choose whether the key is active or inactive.
Permissions: Select which API endpoints the key can access, and you can assign custom permissions like Super Rules, Create Payments, Update Payments, etc.
After filling in the details, scroll down and click Create to generate the new API key.
Once created, your key will appear in the list.
Click on the Copy icon next to the key to copy it and start using this key in your integration.
Use Test credentials for testing and Live credentials when going production.
Then navigate to the "Webhook settings".
Copy the "Webhook Secret Key".
Important Notes
You can create up to 5 API keys only.
If you use a token to access an endpoint without the required permissions, you will receive the following error:
Status Code: 401 , Message: "The token does not have the required permissions!"You can edit an existing API key by clicking the Edit icon next to it. This allows you to update the name, permissions, status, or delete the key.
Generating Webhook
We use webhooks to notify your application when an event happens in your account. Webhooks are particularly useful for asynchronous events, like when a customer has made a payment, deposited money to your account, the refund status has changed, or the supplier account status has changed. You can listen to specific events by webhook, as you don’t need to inquire about these actions to get the response.
To start with the MyFatoorah Webhook service, you can follow these steps to complete your integration settings:
Log in to your portal account and go to Integration Settings => Webhook Settings and configure your settings.
Enable the Webhook Feature.
Add your endpoint URL, which will handle the event.
Select the event types to get the webhook events.
Choose the Webhook Version. If you choose V2, make sure to configure the retries.
Click on the Save button.
Be ready to receive the notifications.
Navigate to the "Webhook Settings".
Copy the webhook secret key
B. Connect MyFatoorah in Agency Panel.
Log in to your BotPenguin Dashboard.
Click on Integrations.
Search or Select MyFatoorah by clicking on the "Connect" button.
Enter the required details:
MyFatoorah API secret Key
Webhook Secret Key
Once entered, click on the "Update" button.
C. Enable MyFatoorah Payment Method for Customers
After completing the MyFatoorah integration, you need to enable it as a payment method for your customers.
Steps:
Log in to your agency dashboard.
Go to Customers → Customer Plans.
Open the Configuration sub-tab.
Navigate to Currency & Payment Reminders.
Under Set Payment Method For Your Currencies:
Select the Currency (e.g., KWD).
Choose MyFatoorah as the Payment Method.
Select Payment Grace Applicable.
Click the Update button to save the settings.
The selected currency will now use MyFatoorah as the payment method for customer subscriptions and invoices.
FAQs
Can I use MyFatoorah in test mode?
Yes, you can use test credentials to simulate payments before going live. No money will be deducted when using the application in the test mode.
Can I switch from test to live later?
Yes, simply update the API key and change the environment to Live.
What if payment link is not generated?
Check if API key is correct.
Ensure the correct environment (Test/Live) is selected.
What if Payment status not updating?
Confirm integration is connected.
Retry the transaction with valid credentials.
Need Help?
Please feel free to reach out to us at [email protected], in case of any questions or concerns.
Last updated