SendPayment

post

https://apitest.myfatoorah.com/v2/SendPayment

Creates a MyFatoorah invoice. This endpoint generates an invoice link that can be sent to customers via email, SMS, or returned directly in the response.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

CustomerName

string

required

Defaults to John Doe

Your customer name that will be displayed during the checkout.

InvoiceValue

number

required

Defaults to 10

The amount you are seeking to charge the customer and accepts decimal values. Must be greater than 0.

NotificationOption

string

enum

required

Defaults to LNK

EML: sends the invoice link by email only (requires CustomerEmail). SMS: sends the invoice link by SMS (requires CustomerMobile). LNK: returns the invoice link through the response body only. ALL: sends the invoice link by Email and SMS, also returns the invoice link through the response body.

Allowed:

DisplayCurrencyIso

string

enum

The currency ISO code you want to display to the customer, by default it is the same as the base currency of the country API. Possible values: KWD, SAR, BHD, AED, QAR, OMR, JOD, EGP.

MobileCountryCode

string

Customer mobile number country code (e.g., +965 for Kuwait).

CustomerMobile

string

Customer mobile number. Mandatory if NotificationOption is SMS or ALL. String uses English letters ONLY and does not accept Arabic characters. Its length is between 0 and 11. Pattern: ^(?:(+)|(00)|(*)|())[0-9]{3,14}((#)|())$

CustomerEmail

string

Customer email that will get the invoice URL. Mandatory if NotificationOption is EML or ALL.

Language

string

enum

EN: to display the checkout page in English. AR: to display the checkout page in Arabic.

Allowed:

CustomerReference

string

Refers to the order or transaction ID in your own system that you can link with the invoice generated for reporting purposes.

CustomerCivilId

string

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

UserDefinedField

string

A custom field that you may use as additional information to be stored with the transaction. If using save card characters 'CK-', max length is 50 chars. Otherwise, maximum length is 500.

CallBackUrl

string

The return URL you like to have for successful payment. The localhost is not allowed to be set as a domain. Maximum 254 characters.

ErrorUrl

string

The return URL in case of a failed payment or any exception raised during the payment. The localhost is not allowed. Maximum 254 characters.

CustomerAddress

object

ExpiryDate

date-time

The date you want the invoice link to expire. If not passed, the default is considered from the account profile in the portal.

InvoiceItems

array of objects

Array of invoice items. Note: The InvoiceValue should equal the total sum of (UnitPrice × Quantity) for all items.

InvoiceItems

ShippingMethod

integer

enum

1: for DHL, 2: for ARAMEX.

Allowed:

ShippingConsignee

object

Mandatory if you are creating a Shipping invoice.

Suppliers

array of objects

Mandatory only if you are using the Multi-Vendors feature.

Suppliers

ProcessingDetails

object

Used for payment methods that have the authorization and capture feature enabled.

InvoicePaymentMethods

array of integers

Enter the PaymentMethodId for the payment methods you want to display on the invoice. You can find the PaymentMethodId from InitiatePayment endpoint.

InvoicePaymentMethods

WebhookUrl

string

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.

Responses

200Invoice created successfully

400Bad Request