About this integration
MENA payments — create hosted invoices and sessions, capture or refund, manage suppliers and shipping, and watch portal webhook events.
There are 1 trigger, 21 search modules and 24 actions available. The integration connects via basic authentication. Webhook-based triggers fire instantly without polling.
How to connect
The credential form asks for API Key and Region.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
API KeyRequired | password | Integration Settings → API Key. Bearer token. Each enabled country has its own key. |
RegionRequired | select | API host for this key. Each country/region uses a distinct endpoint. |
Use it in workflow automation
Start with Watch Events, then add Calculate Shipping Charge.
Triggers, searches and actions
Open any MyFatoorah trigger, search, or action to see its inputs and outputs — 1 trigger, 21 searchs, 24 actions.
Triggers
Use one of 1 trigger to kick off a workflow as soon as an event occurs in the app.
- Watch Events
Searches
This integration includes 21 search modules for looking data up mid-run.
- Get Banks
- Get Cities
- Get Countries
- Get Currencies Exchange List
- Get Customer Details
16more searches
Actions
Take action during a run with 24 available modules that write data back into the app.
- Calculate Shipping Charge
- Cancel Recurring Payment
- Cancel Token
- Create Payment
- Create Session
19more actions
Explore the fields available for each MyFatoorah trigger, search, and action.
Triggers
Output fields
| Field | Type |
|---|---|
Event | object |
Code | number |
Name | text |
Country ISO Code | text |
Creation Date | date |
Reference | text |
Data | text |
Searches
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
Shipping MethodRequired | choice |
Country CodeRequired | choice |
Search | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
Customer ReferenceRequired | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Deposit ReferenceRequired | text |
Type | choice |
Supplier Code | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
External IdentifierRequired | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | object |
Invoice | object |
Transactions | array |
Customer | text |
Amount | text |
Suppliers | array |
Input fields
| Field | Type |
|---|---|
Invoice IdRequired | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | object |
Invoice | object |
Transactions | array |
Customer | text |
Amount | text |
Suppliers | array |
Input fields
| Field | Type |
|---|---|
Payment IdRequired | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
KeyRequired | text |
Key TypeRequired | choice |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
Key TypeRequired | choice |
KeyRequired | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Session IdRequired | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Shipping MethodRequired | choice |
Order StatusRequired | choice |
Start (offset) | number |
Length | number |
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
Supplier CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Supplier CodeRequired | choice |
Search | text |
Start (offset) | number |
Length | number |
Sort Column | text |
Sort Direction | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
Supplier CodeRequired | choice |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Supplier CodeRequired | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
Start (ISO 8601 UTC) | date |
End (ISO 8601 UTC) | date |
Page (1-based, 500 events/page) | number |
Event Type | choice |
Status | choice |
Key Type | choice |
Limit | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Data | array |
Value | text |
Input fields
| Field | Type |
|---|---|
Shipping MethodRequired | choice |
Maximum Results | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Actions
Input fields
| Field | Type |
|---|---|
Shipping MethodRequired | choice |
City NameRequired | choice |
Country CodeRequired | choice |
Postal Code | text |
ItemsRequired | array |
Weight (kg) | number |
Width (cm) | number |
Height (cm) | number |
Depth (cm) | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Recurring IdRequired | choice |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
TokenRequired | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
OrderRequired | object |
AmountRequired | number |
Currency | choice |
External Identifier | text |
Payment Method | choice |
Source of Fund | object |
Session Id | text |
Token | text |
Type | text |
Card | object |
Operation Type | choice |
Notification Option | choice |
Language | choice |
Customer | object |
Reference | text |
Email | text |
Name | text |
Mobile | text |
Integration URLs | object |
Redirection URL | url |
Webhook URL (per-invoice override) | url |
Payment Expiry | text |
Metadata | object |
UDF1 | text |
UDF2 | text |
UDF3 | text |
UDF4 | text |
UDF5 | text |
Suppliers | array |
Supplier Code | choice |
Proposed Deposit Share | number |
Invoice Share | number |
Idempotency Key | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Payment ModeRequired | choice |
OrderRequired | object |
AmountRequired | number |
Currency | text |
External Identifier | text |
Operation Type | choice |
Customer | object |
Reference | text |
Email | text |
Name | text |
Mobile | text |
Integration URLs | object |
Redirection URL | url |
Webhook URL | url |
Language | choice |
Metadata | object |
UDF1 | text |
UDF2 | text |
UDF3 | text |
UDF4 | text |
UDF5 | text |
Suppliers | array |
Supplier Code | choice |
Invoice Share | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Supplier NameRequired | text |
MobileRequired | text |
EmailRequired | text |
Bank | choice |
Bank Account Holder Name | text |
Bank Account | text |
IBAN | text |
Commission Value | number |
Commission Percentage | number |
Is Percentage of Net Value | boolean |
Deposit Terms | choice |
Deposit Day | text |
Is Active | boolean |
Display Supplier Details | boolean |
Business Name | text |
Business Type | choice |
Logo File | object |
File Name | text |
Media Type | text |
Buffer (base64) | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Supplier CodeRequired | choice |
Supplier Commissions | array |
Payment Method | choice |
Commission Value | number |
Commission Percentage | number |
Is Percentage of Net Value | boolean |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Invoice KeyRequired | text |
Payment Gateway IdRequired | text |
Payment TypeRequired | choice |
Card | object |
Card Number | text |
Expiry Month | text |
Expiry Year | text |
Security Code (CVV) | text |
Holder Name | text |
Token | text |
Bypass 3DS | boolean |
Save Token | boolean |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Supplier CodeRequired | choice |
Supplier NameRequired | text |
MobileRequired | text |
EmailRequired | text |
Bank | choice |
Bank Account Holder Name | text |
Bank Account | text |
IBAN | text |
Commission Value | number |
Commission Percentage | number |
Is Percentage of Net Value | boolean |
Deposit Terms | choice |
Deposit Day | text |
Display Supplier Details | boolean |
Business Name | text |
Logo File | object |
File Name | text |
Media Type | text |
Buffer (base64) | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Invoice ValueRequired | number |
Payment Method | choice |
Session Id | text |
Suppliers | array |
Supplier CodeRequired | choice |
Invoice ShareRequired | number |
Shipping Consignee | object |
Person Name | text |
Mobile | text |
Line Address | text |
Country CodeRequired | choice |
City NameRequired | text |
Email Address | text |
Postal Code | text |
Recurring Model | object |
Recurring Type | choice |
Interval Days (1–180) | number |
Iteration | number |
Retry Count (1–5) | number |
Callback URL | url |
Error URL | url |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Invoice Amount | number |
Currency ISO | choice |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Customer IdentifierRequired | text |
Save Token | boolean |
Is Recurring | boolean |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
URLRequired | text |
Method | choice |
Query String Parameters | array |
Key | text |
Value | text |
Headers | array |
Key | text |
Value | text |
Body | text |
Input fields
| Field | Type |
|---|---|
Key TypeRequired | choice |
KeyRequired | text |
AmountRequired | number |
Comment | text |
External Identifier | text |
Service Charge on Customer | boolean |
Idempotency Key | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Key TypeRequired | choice |
KeyRequired | text |
Vendor Deduct Amount | number |
Comment | text |
External Identifier | text |
Suppliers (RefundSupplier) | array |
Supplier Code | choice |
Supplier Deducted Amount | number |
Idempotency Key | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Domain NameRequired | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Recurring IdRequired | choice |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Customer NameRequired | text |
Invoice ValueRequired | number |
Notification OptionRequired | choice |
Payment Methods | choice |
Suppliers | array |
Supplier CodeRequired | choice |
Invoice ShareRequired | number |
Shipping Consignee | object |
Person Name | text |
Mobile | text |
Line Address | text |
Country CodeRequired | choice |
City NameRequired | text |
Email Address | text |
Postal Code | text |
Invoice Items | array |
Item Name | text |
Quantity | number |
Unit Price | number |
Customer Email | text |
Customer Mobile | text |
Language | text |
Invoice Date | text |
Expiry Date | text |
Shipping Method | choice |
Webhook URL (per-invoice override) | url |
Callback URL | url |
Error URL | url |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Supplier CodeRequired | choice |
Transfer AmountRequired | number |
Transfer TypeRequired | choice |
Internal Notes | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Payment IdRequired | text |
Operation TypeRequired | choice |
Amount | number |
Idempotency Key | text |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
OperationRequired | choice |
KeyRequired | text |
Key TypeRequired | choice |
Amount | number |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Session IdRequired | text |
TokenRequired | text |
Token TypeRequired | choice |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Shipping MethodRequired | choice |
Invoice Numbers | array |
Invoice Number | number |
Order Status Changed To | choice |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message | text |
Data | text |
Input fields
| Field | Type |
|---|---|
Supplier CodeRequired | choice |
File UploadRequired | object |
File NameRequired | text |
Media TypeRequired | text |
Buffer (base64)Required | text |
File TypeRequired | choice |
Expire Date | date |
Output fields
| Field | Type |
|---|---|
Is Success | boolean |
Message (contains file URL) | text |