MyFatoorah icon

MyFatoorah

MENA payments — create hosted invoices and sessions, capture or refund, manage suppliers and shipping, and watch portal webhook events.

1 trigger21 searches24 actionsInstant (webhooks)Auth: API key

AI-assisted documentation12 min read

This documentation is compiled from our integration source code, internal specs for MyFatoorah, its official API documentation and anonymized requests logs we collect from our support team[2].

Open MyFatoorah on WEXTL →

MyFatoorah requires an active account and an API access token from your account settings to connect — both are set up on its own site.[3]

  • API KeypasswordRequired

    Integration Settings → API Key. Bearer token. Each enabled country has its own key.

    [1]
  • RegionselectRequired

    API host for this key. Each country/region uses a distinct endpoint.

    [1]
  1. Log in to your WEXTL account, add the MyFatoorah node module to your workflow, and click Create new credential.
    Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your MyFatoorah account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch EventsTrigger
Output fields[3]
FieldType
Eventobject
Codenumber
Nametext
Country ISO Codetext
Creation Datedate
Referencetext
Datatext
Get BanksSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Get CitiesSearch
Input fields[3]
FieldType
Shipping MethodRequired
choice
Country CodeRequired
choice
Searchtext
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Get CountriesSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Get Currencies Exchange ListSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Get Customer DetailsSearch
Input fields[3]
FieldType
Customer ReferenceRequired
text
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Get Deposited InvoicesAction
Input fields[3]
FieldType
Deposit ReferenceRequired
text
Typechoice
Supplier Codechoice
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Get Invoice by External IdentifierSearch
Input fields[3]
FieldType
External IdentifierRequired
text
Output fields[3]
FieldType
Is Successboolean
Messagetext
Dataobject
Invoiceobject
Transactionsarray
Customertext
Amounttext
Suppliersarray
Get Invoice by Invoice IdSearch
Input fields[3]
FieldType
Invoice IdRequired
text
Output fields[3]
FieldType
Is Successboolean
Messagetext
Dataobject
Invoiceobject
Transactionsarray
Customertext
Amounttext
Suppliersarray
Get Payment DetailsSearch
Input fields[3]
FieldType
Payment IdRequired
text
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Get Payment StatusAction
Input fields[3]
FieldType
KeyRequired
text
Key TypeRequired
choice
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Get Recurring PaymentSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Get Refund StatusAction
Input fields[3]
FieldType
Key TypeRequired
choice
KeyRequired
text
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Get Session DetailsSearch
Input fields[3]
FieldType
Session IdRequired
text
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Get Shipping Order ListSearch
Input fields[3]
FieldType
Shipping MethodRequired
choice
Order StatusRequired
choice
Start (offset)number
Lengthnumber
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Get Supplier DashboardSearch
Input fields[3]
FieldType
Supplier CodeRequired
choice
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Get Supplier DepositsSearch
Input fields[3]
FieldType
Supplier CodeRequired
choice
Searchtext
Start (offset)number
Lengthnumber
Sort Columntext
Sort Directionchoice
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Get Supplier DetailsSearch
Input fields[3]
FieldType
Supplier CodeRequired
choice
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Get Supplier DocumentsSearch
Input fields[3]
FieldType
Supplier CodeRequired
choice
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Get SuppliersSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Get WebhooksAction
Input fields[3]
FieldType
Start (ISO 8601 UTC)date
End (ISO 8601 UTC)date
Page (1-based, 500 events/page)number
Event Typechoice
Statuschoice
Key Typechoice
Limitnumber
Output fields[3]
FieldType
Is Successboolean
Dataarray
Valuetext
Request PickupSearch
Input fields[3]
FieldType
Shipping MethodRequired
choice
Maximum Resultsnumber
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Calculate Shipping ChargeAction
Input fields[3]
FieldType
Shipping MethodRequired
choice
City NameRequired
choice
Country CodeRequired
choice
Postal Codetext
ItemsRequired
array
Weight (kg)number
Width (cm)number
Height (cm)number
Depth (cm)number
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Cancel Recurring PaymentAction
Input fields[3]
FieldType
Recurring IdRequired
choice
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Cancel TokenAction
Input fields[3]
FieldType
TokenRequired
text
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Create PaymentAction
Input fields[3]
FieldType
OrderRequired
object
AmountRequired
number
Currencychoice
External Identifiertext
Payment Methodchoice
Source of Fundobject
Session Idtext
Tokentext
Typetext
Cardobject
Operation Typechoice
Notification Optionchoice
Languagechoice
Customerobject
Referencetext
Emailtext
Nametext
Mobiletext
Integration URLsobject
Redirection URLurl
Webhook URL (per-invoice override)url
Payment Expirytext
Metadataobject
UDF1text
UDF2text
UDF3text
UDF4text
UDF5text
Suppliersarray
Supplier Codechoice
Proposed Deposit Sharenumber
Invoice Sharenumber
Idempotency Keytext
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Create SessionAction
Input fields[3]
FieldType
Payment ModeRequired
choice
OrderRequired
object
AmountRequired
number
Currencytext
External Identifiertext
Operation Typechoice
Customerobject
Referencetext
Emailtext
Nametext
Mobiletext
Integration URLsobject
Redirection URLurl
Webhook URLurl
Languagechoice
Metadataobject
UDF1text
UDF2text
UDF3text
UDF4text
UDF5text
Suppliersarray
Supplier Codechoice
Invoice Sharenumber
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Create SupplierAction
Input fields[3]
FieldType
Supplier NameRequired
text
MobileRequired
text
EmailRequired
text
Bankchoice
Bank Account Holder Nametext
Bank Accounttext
IBANtext
Commission Valuenumber
Commission Percentagenumber
Is Percentage of Net Valueboolean
Deposit Termschoice
Deposit Daytext
Is Activeboolean
Display Supplier Detailsboolean
Business Nametext
Business Typechoice
Logo Fileobject
File Nametext
Media Typetext
Buffer (base64)text
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Customize Supplier CommissionsAction
Input fields[3]
FieldType
Supplier CodeRequired
choice
Supplier Commissionsarray
Payment Methodchoice
Commission Valuenumber
Commission Percentagenumber
Is Percentage of Net Valueboolean
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Direct PaymentAction
Input fields[3]
FieldType
Invoice KeyRequired
text
Payment Gateway IdRequired
text
Payment TypeRequired
choice
Cardobject
Card Numbertext
Expiry Monthtext
Expiry Yeartext
Security Code (CVV)text
Holder Nametext
Tokentext
Bypass 3DSboolean
Save Tokenboolean
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Edit SupplierAction
Input fields[3]
FieldType
Supplier CodeRequired
choice
Supplier NameRequired
text
MobileRequired
text
EmailRequired
text
Bankchoice
Bank Account Holder Nametext
Bank Accounttext
IBANtext
Commission Valuenumber
Commission Percentagenumber
Is Percentage of Net Valueboolean
Deposit Termschoice
Deposit Daytext
Display Supplier Detailsboolean
Business Nametext
Logo Fileobject
File Nametext
Media Typetext
Buffer (base64)text
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Execute PaymentAction
Input fields[3]
FieldType
Invoice ValueRequired
number
Payment Methodchoice
Session Idtext
Suppliersarray
Supplier CodeRequired
choice
Invoice ShareRequired
number
Shipping Consigneeobject
Person Nametext
Mobiletext
Line Addresstext
Country CodeRequired
choice
City NameRequired
text
Email Addresstext
Postal Codetext
Recurring Modelobject
Recurring Typechoice
Interval Days (1–180)number
Iterationnumber
Retry Count (1–5)number
Callback URLurl
Error URLurl
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Initiate PaymentAction
Input fields[3]
FieldType
Invoice Amountnumber
Currency ISOchoice
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Initiate SessionAction
Input fields[3]
FieldType
Customer IdentifierRequired
text
Save Tokenboolean
Is Recurringboolean
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
Methodchoice
Query String Parametersarray
Keytext
Valuetext
Headersarray
Keytext
Valuetext
Bodytext
Make RefundAction
Input fields[3]
FieldType
Key TypeRequired
choice
KeyRequired
text
AmountRequired
number
Commenttext
External Identifiertext
Service Charge on Customerboolean
Idempotency Keytext
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Make Supplier RefundAction
Input fields[3]
FieldType
Key TypeRequired
choice
KeyRequired
text
Vendor Deduct Amountnumber
Commenttext
External Identifiertext
Suppliers (RefundSupplier)array
Supplier Codechoice
Supplier Deducted Amountnumber
Idempotency Keytext
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Register Apple Pay DomainAction
Input fields[3]
FieldType
Domain NameRequired
text
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Resume Recurring PaymentAction
Input fields[3]
FieldType
Recurring IdRequired
choice
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Send PaymentAction
Input fields[3]
FieldType
Customer NameRequired
text
Invoice ValueRequired
number
Notification OptionRequired
choice
Payment Methodschoice
Suppliersarray
Supplier CodeRequired
choice
Invoice ShareRequired
number
Shipping Consigneeobject
Person Nametext
Mobiletext
Line Addresstext
Country CodeRequired
choice
City NameRequired
text
Email Addresstext
Postal Codetext
Invoice Itemsarray
Item Nametext
Quantitynumber
Unit Pricenumber
Customer Emailtext
Customer Mobiletext
Languagetext
Invoice Datetext
Expiry Datetext
Shipping Methodchoice
Webhook URL (per-invoice override)url
Callback URLurl
Error URLurl
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Transfer BalanceAction
Input fields[3]
FieldType
Supplier CodeRequired
choice
Transfer AmountRequired
number
Transfer TypeRequired
choice
Internal Notestext
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Update PaymentAction
Input fields[3]
FieldType
Payment IdRequired
text
Operation TypeRequired
choice
Amountnumber
Idempotency Keytext
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Update Payment StatusAction
Input fields[3]
FieldType
OperationRequired
choice
KeyRequired
text
Key TypeRequired
choice
Amountnumber
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Update SessionAction
Input fields[3]
FieldType
Session IdRequired
text
TokenRequired
text
Token TypeRequired
choice
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Update Shipping StatusAction
Input fields[3]
FieldType
Shipping MethodRequired
choice
Invoice Numbersarray
Invoice Numbernumber
Order Status Changed Tochoice
Output fields[3]
FieldType
Is Successboolean
Messagetext
Datatext
Upload Supplier DocumentAction
Input fields[3]
FieldType
Supplier CodeRequired
choice
File UploadRequired
object
File NameRequired
text
Media TypeRequired
text
Buffer (base64)Required
text
File TypeRequired
choice
Expire Datedate
Output fields[3]
FieldType
Is Successboolean
Message (contains file URL)text

Look for MyFatoorah templates in the WEXTL template library.

Browse templates →
  1. WEXTL® MyFatoorah Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for MyFatoorah.
  4. WEXTL® visual workflow builder data.

Last updated: Aug 19, 2026 08:39