---
title: "SendPayment"
method: POST
path: "/v2/SendPayment"
tags: ["Payments (V2)"]
---

# SendPayment

`POST /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.

## Request body

- object
  - `CustomerName` string, required — Your customer name that will be displayed during the checkout.
  - `InvoiceValue` number, required — The amount you are seeking to charge the customer and accepts decimal values. Must be greater than 0.
  - `NotificationOption` 'EML' | 'SMS' | 'LNK' | 'ALL', required — 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.
  - `DisplayCurrencyIso` 'KWD' | 'SAR' | 'BHD' | 'AED' | 'QAR' | 'OMR' | 'JOD' | 'EGP' — 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` 'EN' | 'AR' — EN: to display the checkout page in English. AR: to display the checkout page in Arabic.
  - `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
    - `Block` string — Block number or area name that contains the delivery address.
    - `Street` string — Delivery address street name.
    - `HouseBuildingNo` string — House / Building number.
    - `AddressInstructions` string — Additional instructions for the delivery address, landmark or directions.
  - `ExpiryDate` string, 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` object[] — Array of invoice items. Note: The InvoiceValue should equal the total sum of (UnitPrice × Quantity) for all items.
    - `ItemName` string, required — Invoice item name that will be displayed in the invoice.
    - `Quantity` integer, required — Item quantity.
    - `UnitPrice` number, required — Item unit price.
    - `Weight` number — Weight in kg. Must be between 0 and 100.
    - `Width` number — Width in cm. Must be between 0 and 200.
    - `Height` number — Height in cm. Must be between 0 and 160.
    - `Depth` number — Depth in cm. Must be between 0 and 200.
  - `ShippingMethod` 1 | 2 — 1: for DHL, 2: for ARAMEX.
  - `ShippingConsignee` object — Mandatory if you are creating a Shipping invoice.
    - `PersonName` string, required — Consignee person name.
    - `Mobile` string, required — Consignee mobile number.
    - `EmailAddress` string, email — Consignee email address.
    - `LineAddress` string, required — Consignee line address.
    - `CityName` string, required — Consignee city name.
    - `PostalCode` string — Consignee postal code.
    - `CountryCode` string, required — Consignee country code.
  - `Suppliers` object[] — Mandatory only if you are using the Multi-Vendors feature.
    - `SupplierCode` integer, required — The supplier code you need to associate the invoice with.
    - `ProposedShare` number — The amount that the supplier will get after paying the invoice.
    - `InvoiceShare` number, required — Amount specified for this supplier from the total invoice value.
  - `ProcessingDetails` object — Used for payment methods that have the authorization and capture feature enabled.
    - `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.
  - `InvoicePaymentMethods` integer[] — Enter the PaymentMethodId for the payment methods you want to display on the invoice. You can find the PaymentMethodId from InitiatePayment endpoint.
  - `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.

## Response `200`

Invoice created successfully

- object
  - `IsSuccess` boolean — Indicates if the request was successful.
  - `Message` string — Response message associated with the request.
  - `ValidationErrors` object[] — List of validation errors, if any.
    - `Name` string — The name of the field with validation error.
    - `Error` string — The validation error message.
  - `Data` object
    - `InvoiceId` integer — The invoice number that you can use to inquire the invoice payment status later.
    - `InvoiceURL` string, uri — The URL that should be sent to the customer to proceed with the payment.
    - `CustomerReference` string — Refers to the order or transaction ID in your system that you have sent in the request.
    - `UserDefinedField` string — The custom field that you have passed in the request.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/myfatoorah/apis/myfatoorah-api-v3.md) · [All operations](https://skmtc.net/myfatoorah/apis/myfatoorah-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/myfatoorah/myfatoorah-api-v3/revisions/994a74287a16/schema)