$isDirectPayment
$isDirectPayment : boolean
To specify either the payment will be onsite or offsite (default value: false)
PaymentMyfatoorahApiV2 handle the payment process of MyFatoorah API endpoints
MyFatoorah offers a seamless business experience by offering a technology put together by our tech team. This enables smooth business operations involving sales activity, product invoicing, shipping, and payment processing. MyFatoorah invoicing and payment gateway solution trigger your business to greater success at all levels in the new age world of commerce. Leverage your sales and payments at all e-commerce platforms (ERPs, CRMs, CMSs) with transparent and slick applications that are well-integrated into social media and telecom services. For every closing sale click, you make a business function gets done for you, along with generating factual reports and statistics to fine-tune your business plan with no-barrier low-cost. Our technology experts have designed the best GCC E-commerce solutions for the native financial instruments (Debit Cards, Credit Cards, etc.) supporting online sales and payments, for events, shopping, mall, and associated services.
Created by MyFatoorah http://www.myfatoorah.com/ Developed By tech@myfatoorah.com Date: 03/03/2021 Time: 12:00
API Documentation on https://myfatoorah.readme.io/docs Copyright 2021 MyFatoorah, All rights reserved
__construct(string $apiKey, boolean $isTest, \sting|object $loggerObj = null, string $loggerFunc = null)
Constructor Initiate new MyFatoorah API process
| string | $apiKey | The API Token Key is the authentication which identify a user that is using the app. To generate one follow instruction here https://myfatoorah.readme.io/docs/live-token. |
| boolean | $isTest | If This set to true, the process will be on the test mode. Set it to false for live mode. |
| \sting|object | $loggerObj | It is optional. This is the file name or the logger object. It will be used in logging the payment/shipping events to help in debugging and monitor the process and connections. Leave it null, if you done't want to log the events. |
| string | $loggerFunc | It is optional. If $loggerObj is set as a logger object, you should set this var with the function name that will be used in the debugging. |
getPhone(string $inputString) : array
Returns the country code and the phone after applying MyFatoorah restriction
Matching regular expression pattern: ^(?:(+)|(00)|(\)|())[0-9]{3,14}((\#)|())$ if (!preg_match('/^(?:(+)|(00)|(\)|())[0-9]{3,14}((\#)|())$/iD', $inputString)) String length: inclusive between 0 and 11
| string | $inputString | It is the input phone number provide by the end user. |
Throw exception if the input length is less than 3 chars or long than 14 chars.
That contains the phone code in the 1st element the the phone number the the 2nd element.
getWeightRate(string $unit) : \real
Get the rate that will convert the given weight unit to MyFatoorah default weight unit.
| string | $unit | It is the weight unit used. Weight must be in kg, g, lbs, or oz. Default is kg. |
Throw exception if the input unit is not support. Weight must be in kg, g, lbs, or oz. Default is kg.
The conversion rate that will convert the given unit into the kg.
getDimensionRate(string $unit) : \real
Get the rate that will convert the given dimension unit to MyFatoorah default dimension unit.
| string | $unit | It is the dimension unit used in width, hight, or depth. Dimension must be in cm, m, mm, in, or yd. Default is cm. |
Throw exception if the input unit is not support. Dimension must be in cm, m, mm, in, or yd. Default is cm.
The conversion rate that will convert the given unit into the cm.
getCurrencyRate(string $currency) : string
Get the rate that will convert the given currency to the default currency of MyFatoorah portal account.
| string | $currency | The currency that will be converted into the currency of MyFatoorah portal account. |
Throw exception if the input currency is not support by MyFatoorah portal account.
The conversion rate that will convert the given currency into the default currency of MyFatoorah portal account.
getPaymentMethod(string $gateway, string $gatewayType = 'PaymentMethodId', \real $invoiceValue, string $displayCurrencyIso = '') : object
Get Payment Method Object
| string | $gateway | |
| string | $gatewayType | ['PaymentMethodId', 'PaymentMethodCode'] |
| \real | $invoiceValue | |
| string | $displayCurrencyIso |
callAPI(string $url, array $postFields = null, integer|string $orderId = null, string $function = null) : object
| string | $url | It is the MyFatoorah API endpoint URL |
| array | $postFields | It is the array of the POST request parameters. It should be set to null if the request is GET. |
| integer|string | $orderId | It is optional. It is the order id or the payment id of the process. It will be used in the events logging. |
| string | $function | It is optional. The function name that made the request. It will be used in the events logging. |
Throw exception if there is any curl error or a validation error in the MyFatoorah API endpoint URL
The response object as the result of a successful calling to the API.