InitiatePayment Request

The end point for this step is as following:

https://apitest.myfatoorah.com/swagger/ui/index#!/Payment/Payment_InitiatePayment

Now are going to list the model and its detailed information:

Input Parameter	Type	Description
InvoiceAmount	number	The transaction amount you need to charge your customer
CurrencyIso	string	The currency code that you need to charge your customer through. For full list please check here

📘
Note
We calculate the total amount of the invoice for a certain currency after applying the exchange rate

Response

In addition to the Response Model that you will get in the response result, as a result of the initiate payment, this call should returns you a list of the available payment methods in your account based on your profile within the Data Model as following:

Response Field	Type	Description
PaymentMethodId	integer	The payment method ID that is used in MyFatoorah system to identify the method of payment
PaymentMethodAr	string	Payment method Arabic name
PaymentMethodEn	string	Payment method English name
IsDirectPayment	boolean	"true" or "false" to indicate if this payment method supports Direct Payment
ServiceCharge	double	The transaction service charges based on the settings in the portal profile
TotalAmount	double	The total amount that you should send before calling Execute Payment including the service charges after calculating it.
CurrencyIso	string	The currency code that you have sent in CurrencyIso
ImageUrl	string	Payment icon URL that you can use to display it in your page for the customers

👍
Hint !
As explained in Gateway Integration, Initiate Payment step is a preparation step that sends you a list of parameters and Payment Methods that you need in Execute Payment, this not executing or storing any information about the payment it's just get the proper information based on your profile in MyFatoorah and calculating the Service Charges based on the settings there

👍
Direct Payment Hint!
If you have IsDirectPayment true in once of the payment methods, we recommend you to let the credit card input controls enabled for your customer to make all calls in the background without affecting the user experience, as Direct Payment is executed over 2 API calls. Check Direct Payment for more details about this part

Sample Messages

{
  "InvoiceAmount": 100,
  "CurrencyIso": "KWD"
}

{
  "IsSuccess": true,
  "Message": "Initiated Successfully!",
  "ValidationErrors": null,
  "Data": {
    "PaymentMethods": [
      {
        "PaymentMethodId": 1,
        "PaymentMethodAr": "كي نت",
        "PaymentMethodEn": "KNET",
        "IsDirectPayment": false,
        "ServiceCharge": 0.5,
        "TotalAmount": 100.5,
        "CurrencyIso": "KWD",
        "ImageUrl": "https://beta.myfatoorah.com/imgs/payment-methods/kn.png"
      },
      {
        "PaymentMethodId": 2,
        "PaymentMethodAr": "فيزا / ماستر",
        "PaymentMethodEn": "VISA/MASTER",
        "IsDirectPayment": true,
        "ServiceCharge": 0.5,
        "TotalAmount": 100.5,
        "CurrencyIso": "KWD",
        "ImageUrl": "https://beta.myfatoorah.com/imgs/payment-methods/vm.png"
      },
      {
        "PaymentMethodId": 3,
        "PaymentMethodAr": "اميكس",
        "PaymentMethodEn": "AMEX",
        "IsDirectPayment": false,
        "ServiceCharge": 0.5,
        "TotalAmount": 100.5,
        "CurrencyIso": "KWD",
        "ImageUrl": "https://beta.myfatoorah.com/imgs/payment-methods/ae.png"
      },
      {
        "PaymentMethodId": 4,
        "PaymentMethodAr": "سداد",
        "PaymentMethodEn": "Sadad",
        "IsDirectPayment": false,
        "ServiceCharge": 0.5,
        "TotalAmount": 100.5,
        "CurrencyIso": "KWD",
        "ImageUrl": "https://beta.myfatoorah.com/imgs/payment-methods/s.png"
      },
      {
        "PaymentMethodId": 5,
        "PaymentMethodAr": "بنفت",
        "PaymentMethodEn": "Benefit",
        "IsDirectPayment": false,
        "ServiceCharge": 0.5,
        "TotalAmount": 100.5,
        "CurrencyIso": "KWD",
        "ImageUrl": "https://beta.myfatoorah.com/imgs/payment-methods/b.png"
      },
      {
        "PaymentMethodId": 6,
        "PaymentMethodAr": "مدى",
        "PaymentMethodEn": "MADA",
        "IsDirectPayment": false,
        "ServiceCharge": 0.5,
        "TotalAmount": 100.5,
        "CurrencyIso": "KWD",
        "ImageUrl": "https://beta.myfatoorah.com/imgs/payment-methods/md.png"
      },
      {
        "PaymentMethodId": 7,
        "PaymentMethodAr": "البطاقات المدينة - قطر",
        "PaymentMethodEn": "Qatar Debit Cards",
        "IsDirectPayment": false,
        "ServiceCharge": 0.5,
        "TotalAmount": 100.5,
        "CurrencyIso": "KWD",
        "ImageUrl": "https://beta.myfatoorah.com/imgs/payment-methods/np.png"
      },
      {
        "PaymentMethodId": 8,
        "PaymentMethodAr": "البطاقات المدينة - الامارات",
        "PaymentMethodEn": "UAE Debit Cards",
        "IsDirectPayment": false,
        "ServiceCharge": 0.5,
        "TotalAmount": 100.5,
        "CurrencyIso": "KWD",
        "ImageUrl": "https://beta.myfatoorah.com/imgs/payment-methods/uaecc.png"
      },
      {
        "PaymentMethodId": 11,
        "PaymentMethodAr": "أبل الدفع",
        "PaymentMethodEn": "Apple Pay",
        "IsDirectPayment": false,
        "ServiceCharge": 0.5,
        "TotalAmount": 100.5,
        "CurrencyIso": "KWD",
        "ImageUrl": "https://beta.myfatoorah.com/imgs/payment-methods/ap.png"
      }
    ]
  }
}