ExecutePayment

InvoiceValue

number

The amount you are seeking to charge the customer and accepts decimal values e.g. 2.500

PaymentMethodId

integer, not required if SessionId provided

For example, it will be 2 for VISA/MASTER payment method
It is required if you did not pass a "SessionId"

SessionId

string, not required if PaymentMethodId provided

Used according to the description in Embedded Payment

CustomerName

string, optional

Your customer name that should be displayed during the checkout

CallBackUrl

string, optional

The return URL in case of a successful payment, refer to Payment Inquiry for more details.
The localhost is not allowed to be set as a domain.
The maximum number of characters is 254

ErrorUrl

string, optional

The return URL in case of a failed payment or any exception raised during the payment, refer to Payment Inquiry for more details.
The localhost is not allowed to be set as a domain.
The maximum number of characters is 254

DisplayCurrencyIso

string, optional

The currency ISO code you want to display to the customer, by default is the same as the base currency of the country API, for possible values please click here

MobileCountryCode

string, optional

Customer mobile number country code, for possible values please check here

CustomerMobile

string, optional

String uses English letters ONLY and does not accept Arabic characters
Its length is between 0 and 11
Regular expression pattern is ^(?:(+)|(00)|(*)|())[0-9]{3,14}((#)|())$

CustomerEmail

string, optional

Customer email

Language

string, optional

"EN" to display the checkout page in English
"AR" to display the checkout page in Arabic

CustomerReference

string, optional

Refers to the order or transaction ID in your own system and you can use it for payment inquiry as well

CustomerCivilId

string, optional

Your customer civil ID that you can associate with the transaction if needed

UserDefinedField

string, optional

A custom field that you may use as additional information to be stored with the transaction.
The maximum length is 500.

CustomerAddress

CustomerAddressModel array, optional

ExpiryDate

string, optional

The date you want the payment to expire, if not passed the default is considered from the account profile in the portal

InvoiceItems

Array of InvoiceItemModel objects, optional

ShippingMethod

integer, optional

• *1** for DHL
• *2** for ARAMEX

ShippingConsignee

Consignee array, optional

This parameter is only mandatory if you are creating a Shipping invoice.

Suppliers

Array of InvoiceSuppliers objects, optional

This parameter is only mandatory if you are using the Multi-Vendors feature.

RecurringModel

RecurringModel object, optional

ProcessingDetails

ProcessingDetails object, optional

WebhookUrl

string, optional

You will get the webhook events for the created invoice on the specified Webhook URL. This includes transactions webhook, refunds webhook, capture/release webhook. The secret key for this URL will be the same as your webhook URL used in the dashboard.

If you don't add this parameter, MyFatoorah sends the webhook event to the one configured in the dashboard.

ItemName

string

Invoice item name that will be displayed in the invoice

Quantity

integer

Item Quantity

UnitPrice

number

Item unit price

Weight

number, optional

100 >= Weight > 0
Weight in kg

Width

number, optional

200 >= Width > 0
Width in cm

Height

number, optional

160 >= Height > 0
Height in cm

Depth

number, optional

200 >= Depth > 0
Depth in cm

AutoCapture

Boolean

• *true**: To make the capture process directly without authorization
• *false**: To make the authorization step first, then call UpdatePaymentStatus to capture/release the amount

Bypass3DS

Boolean

• *true**: To bypass 3DS challenge
• *false**: To redirect the customer to the 3DS challenge
  The Bypass3DS feature must be enabled on your account to be able to use this feature.