Commit b6516bc1: update library to 2.2.7...

MyFatoorahPayment.php

-35+35

/src/API/Payment/MyFatoorahPayment.php

View

* MyFatoorahPayment handles the payment process of MyFatoorah API endpoints

*

* @author MyFatoorah <tech@myfatoorah.com>

* @license GNU General Public License v3.0

*/

class MyFatoorahPayment extends MyFatoorah

/**

* List available Payment Methods (POST API)

*

* @param double|int $invoiceValue Total invoice amount.

* @param string $displayCurrencyIso Total invoice currency.

* @param boolean $isCached It used to cache the gateways

* @param double|int $invoiceAmount The display invoice total amount.

* @param string $currencyIso The display invoice currency ISO.

* @param boolean $isCached It used to cache the gateways.

*

* @return array

*/

public function initiatePayment($invoiceValue = 0, $displayCurrencyIso = '', $isCached = false)

public function initiatePayment($invoiceAmount = 0, $currencyIso = '', $isCached = false)

{

$postFields = [

'InvoiceAmount' => $invoiceValue,

'CurrencyIso' => $displayCurrencyIso,

'InvoiceAmount' => $invoiceAmount,

'CurrencyIso' => $currencyIso,

];

$json = $this->callAPI("$this->apiURL/v2/InitiatePayment", $postFields, null, 'Initiate Payment');

/**

* List available cached Payment Methods

*

* @param bool $isAppleRegistered Is site domain is registered with applePay and MyFatoorah or not

* @param bool $isApRegistered Is site domain is registered with applePay and MyFatoorah or not

*

* @return array

*/

public function getCachedCheckoutGateways($isAppleRegistered = false)

public function getCachedCheckoutGateways($isApRegistered = false)

{

$gateways = $this->getCachedVendorGateways();

$cachedCheckoutGateways = ['all' => [], 'cards' => [], 'form' => [], 'ap' => [], 'gp' => []];

$cachedGateways = ['all' => [], 'cards' => [], 'form' => [], 'ap' => [], 'gp' => []];

foreach ($gateways as $gateway) {

$cachedCheckoutGateways = $this->addGatewayToCheckoutGateways($gateway, $cachedCheckoutGateways, $isAppleRegistered);

$cachedGateways = $this->addGatewayToCheckout($gateway, $cachedGateways, $isApRegistered);

}

if ($isAppleRegistered) {

if ($isApRegistered) {

//add only one ap gateway

$cachedCheckoutGateways['ap'] = $cachedCheckoutGateways['ap'][0] ?? [];

$cachedGateways['ap'] = $cachedGateways['ap'][0] ?? [];

}

return $cachedCheckoutGateways;

return $cachedGateways;

}

//-----------------------------------------------------------------------------------------------------------------------------------------

/**

* Add the MyFatoorah gateway object to the a given Payment Methods Array

*

* @param object $gateway MyFatoorah gateway object.

* @param array $checkoutGateways Payment Methods Array.

* @param boolean $isAppleRegistered Is site domain is registered with applePay and MyFatoorah or not.

* @param object $gateway MyFatoorah gateway object.

* @param array $checkoutGateways Payment Methods Array.

* @param boolean $isApRegistered Is site domain is registered with applePay and MyFatoorah or not.

*

* @return array

*/

protected function addGatewayToCheckoutGateways($gateway, $checkoutGateways, $isAppleRegistered)

protected function addGatewayToCheckout($gateway, $checkoutGateways, $isApRegistered)

{

if ($gateway->PaymentMethodCode == 'gp') {

$checkoutGateways['gp'] = $gateway;

$checkoutGateways['all'][] = $gateway;

} elseif ($gateway->PaymentMethodCode == 'ap') {

if ($isAppleRegistered) {

if ($isApRegistered) {

$checkoutGateways['ap'][] = $gateway;

} else {

$checkoutGateways['cards'][] = $gateway;

/**

* Get Payment Method Object

*

* @param string $gateway MyFatoorah gateway object.

* @param string $gatewayType The Search key ['PaymentMethodId', 'PaymentMethodCode'].

* @param double|int $invoiceValue Total invoice amount.

* @param string $displayCurrencyIso Total invoice currency.

* @param string $gateway MyFatoorah gateway object.

* @param string $searchKey The Search key ['PaymentMethodId', 'PaymentMethodCode'].

* @param double|int $invoiceAmount The display invoice total amount.

* @param string $currencyIso The display invoice currency ISO.

*

* @return object

*

* @throws Exception

*/

public function getOnePaymentMethod($gateway, $gatewayType = 'PaymentMethodId', $invoiceValue = 0, $displayCurrencyIso = '')

public function getOnePaymentMethod($gateway, $searchKey = 'PaymentMethodId', $invoiceAmount = 0, $currencyIso = '')

{

$paymentMethods = $this->initiatePayment($invoiceValue, $displayCurrencyIso);

$paymentMethods = $this->initiatePayment($invoiceAmount, $currencyIso);

$paymentMethod = null;

foreach ($paymentMethods as $pm) {

if ($pm->$gatewayType == $gateway) {

if ($pm->$searchKey == $gateway) {

$paymentMethod = $pm;

break;

}

/**

* Get the invoice/payment URL and the invoice id

*

* @param array $curlData Invoice information.

* @param int|string $gatewayId MyFatoorah Gateway ID (default value: '0').

* @param int|string $orderId It used in log file (default value: null).

* @param string $sessionId The payment session used in embedded payment.

* @param string $notificationOption could be EML, SMS, LNK, or ALL.

* @param array $curlData Invoice information.

* @param int|string $gatewayId MyFatoorah Gateway ID (default value: '0').

* @param int|string $orderId It used in log file (default value: null).

* @param string $sessionId The payment session used in embedded payment.

* @param string $ntfOption The notificationOption for send payment. It could be EML, SMS, LNK, or ALL.

*

* @return array of invoiceURL and invoiceURL

*/

public function getInvoiceURL($curlData, $gatewayId = 0, $orderId = null, $sessionId = null, $notificationOption = 'Lnk')

public function getInvoiceURL($curlData, $gatewayId = 0, $orderId = null, $sessionId = null, $ntfOption = 'Lnk')

{

$this->log('------------------------------------------------------------');

return ['invoiceURL' => $data->PaymentURL, 'invoiceId' => $data->InvoiceId];

} elseif ($gatewayId == 'myfatoorah' || empty($gatewayId)) {

if (empty($curlData['NotificationOption'])) {

$curlData['NotificationOption'] = $notificationOption;

$curlData['NotificationOption'] = $ntfOption;

}

$data = $this->sendPayment($curlData);

/**

* Create an Payment Link (POST API)

*

* @param array $curlData Invoice information, check https://docs.myfatoorah.com/docs/execute-payment#required-fields.

* @param array $curlData Invoice information, check https://docs.myfatoorah.com/docs/execute-payment#request-model.

*

* @return object

*/

$this->preparePayment($curlData);

$json = $this->callAPI("$this->apiURL/v2/ExecutePayment", $curlData, $curlData['CustomerReference'], 'Execute Payment'); //__FUNCTION__

$json = $this->callAPI("$this->apiURL/v2/ExecutePayment", $curlData, $curlData['CustomerReference'], 'Execute Payment');

return $json->Data;

}

MyFatoorahPaymentEmbedded.php

-20+22

/src/API/Payment/MyFatoorahPaymentEmbedded.php

View

* MyFatoorahPaymentForm handles the form process of MyFatoorah API endpoints

*

* @author MyFatoorah <tech@myfatoorah.com>

* @license GNU General Public License v3.0

*/

class MyFatoorahPaymentEmbedded extends MyFatoorahPayment

/**

* List available Payment Methods

*

* @param double|int $invoiceValue Total invoice amount.

* @param string $displayCurrencyIso Total invoice currency.

* @param bool $isAppleRegistered Is site domain is registered with applePay and MyFatoorah or not.

* @param double|int $invoiceAmount The display invoice total amount.

* @param string $currencyIso The display invoice currency ISO.

* @param bool $isApRegistered Is site domain is registered with ApplePay and MyFatoorah or not.

*

* @return array

*/

public function getCheckoutGateways($invoiceValue, $displayCurrencyIso, $isAppleRegistered)

public function getCheckoutGateways($invoiceAmount, $currencyIso, $isApRegistered)

{

if (!empty(self::$checkoutGateways)) {

return self::$checkoutGateways;

}

$gateways = $this->initiatePayment($invoiceValue, $displayCurrencyIso);

$gateways = $this->initiatePayment($invoiceAmount, $currencyIso);

$mfListObj = new MyFatoorahList($this->config);

$allRates = $mfListObj->getCurrencyRates();

$currencyRate = MyFatoorahList::getOneCurrencyRate($displayCurrencyIso, $allRates);

$currencyRate = MyFatoorahList::getOneCurrencyRate($currencyIso, $allRates);

self::$checkoutGateways = ['all' => [], 'cards' => [], 'form' => [], 'ap' => [], 'gp' => []];

foreach ($gateways as $gateway) {

'GatewayTransCurrency' => self::getTranslatedCurrency($gateway->PaymentCurrencyIso),

];

self::$checkoutGateways = $this->addGatewayToCheckoutGateways($gateway, self::$checkoutGateways, $isAppleRegistered);

self::$checkoutGateways = $this->addGatewayToCheckout($gateway, self::$checkoutGateways, $isApRegistered);

}

if ($isAppleRegistered) {

if ($isApRegistered) {

//add only one ap gateway

self::$checkoutGateways['ap'] = $this->getOneApplePayGateway(self::$checkoutGateways['ap'], $displayCurrencyIso, $allRates);

self::$checkoutGateways['ap'] = $this->getOneEmbeddedGateway(self::$checkoutGateways['ap'], $currencyIso, $allRates);

}

return self::$checkoutGateways;

private function getPaymentTotalAmount($paymentMethod, $allRates, $currencyRate)

{

$dbTrucVal = ((int) ($paymentMethod->TotalAmount * 1000)) / 1000;

if ($paymentMethod->PaymentCurrencyIso == $paymentMethod->CurrencyIso) {

return $paymentMethod->TotalAmount;

return ceil($dbTrucVal * 100) / 100;

}

//convert to portal base currency

$baseTotalAmount = ceil(((int) ($paymentMethod->TotalAmount * 100)) / $currencyRate) / 100;

$dueVal = ($currencyRate == 1) ? $dbTrucVal : round($paymentMethod->TotalAmount / $currencyRate, 3);

$baseTotalAmount = ceil($dueVal * 100) / 100;

//gateway currency is not the portal currency

$paymentCurrencyRate = MyFatoorahList::getOneCurrencyRate($paymentMethod->PaymentCurrencyIso, $allRates);

/**

* Returns One Apple pay array in case multiple are enabled in the account

*

* @param array $apGateways The all available AP gateways

* @param array $gateways The all available AP/GP gateways

* @param string $displayCurrency The currency of the invoice total amount.

* @param array $allRates The MyFatoorah currency rate array of all gateways.

*

* @return array

*/

protected function getOneApplePayGateway($apGateways, $displayCurrency, $allRates)

private function getOneEmbeddedGateway($gateways, $displayCurrency, $allRates)

{

$displayCurrencyIndex = array_search($displayCurrency, array_column($apGateways, 'PaymentCurrencyIso'));

$displayCurrencyIndex = array_search($displayCurrency, array_column($gateways, 'PaymentCurrencyIso'));

if ($displayCurrencyIndex) {

return $apGateways[$displayCurrencyIndex];

return $gateways[$displayCurrencyIndex];

}

//get defult mf account currency

$defCurKey = array_search('1', array_column($allRates, 'Value'));

$defaultCurrency = $allRates[$defCurKey]->Text;

$defaultCurrencyIndex = array_search($defaultCurrency, array_column($apGateways, 'PaymentCurrencyIso'));

$defaultCurrencyIndex = array_search($defaultCurrency, array_column($gateways, 'PaymentCurrencyIso'));

if ($defaultCurrencyIndex) {

return $apGateways[$defaultCurrencyIndex];

return $gateways[$defaultCurrencyIndex];

}

if (isset($apGateways[0])) {

return $apGateways[0];

if (isset($gateways[0])) {

return $gateways[0];

}

return [];

MyFatoorahPaymentStatus.php

-1+1

/src/API/Payment/MyFatoorahPaymentStatus.php

View

* MyFatoorahPaymentStatus handles the payment status of MyFatoorah API endpoints

*

* @author MyFatoorah <tech@myfatoorah.com>

* @license GNU General Public License v3.0

*/

class MyFatoorahPaymentStatus extends MyFatoorahPayment

MyFatoorahList.php

-1+1

/src/API/MyFatoorahList.php

View

* MyFatoorahList handles the list process of MyFatoorah API endpoints

*

* @author MyFatoorah <tech@myfatoorah.com>

* @license GNU General Public License v3.0

*/

class MyFatoorahList extends MyFatoorah

MyFatoorahRefund.php

-9+9

/src/API/MyFatoorahRefund.php

View

* MyFatoorahRefund handles the refund process of MyFatoorah API endpoints

*

* @author MyFatoorah <tech@myfatoorah.com>

* @license GNU General Public License v3.0

*/

class MyFatoorahRefund extends MyFatoorah

*

* @deprecated

*

* @param int|string $keyId payment id that will be refunded

* @param double|int|string $amount the refund amount

* @param string $currencyCode the amount currency

* @param string $comment reason of the refund

* @param int|string $orderId used in log file (default value: null)

* @param string $keyType supported keys are (InvoiceId, PaymentId)

* @param int|string $keyId payment id that will be refunded

* @param double|int|string $amount the refund amount

* @param string $currency the amount currency

* @param string $comment reason of the refund

* @param int|string $orderId used in log file (default value: null)

* @param string $keyType supported keys are (InvoiceId, PaymentId)

*

* @return object

*/

public function refund($keyId, $amount, $currencyCode = null, $comment = null, $orderId = null, $keyType = 'PaymentId')

public function refund($keyId, $amount, $currency = null, $comment = null, $orderId = null, $keyType = 'PaymentId')

{

$postFields = [

'Key' => $keyId,

'RefundChargeOnCustomer' => false,

'ServiceChargeOnCustomer' => false,

'Amount' => $amount,

'CurrencyIso' => $currencyCode,

'CurrencyIso' => $currency,

'Comment' => $comment,

];

MyFatoorahShipping.php

-1+1

/src/API/MyFatoorahShipping.php

View

* MyFatoorahShipping handles the shipping process of MyFatoorah API endpoints

*

* @author MyFatoorah <tech@myfatoorah.com>

* @license GNU General Public License v3.0

*/

class MyFatoorahShipping extends MyFatoorah

MyFatoorahSupplier.php

/src/API/MyFatoorahSupplier.php

View

MyFatoorah.php

/src/MyFatoorah.php

View

MyFatoorahHelper.php

/src/MyFatoorahHelper.php

View

autoload.php

/autoload.php

View

CHANGELOG.md

/CHANGELOG.md

View

composer.json

/composer.json

View

README.md

/README.md

View



	src
	API
	Payment
	MyFatoorahPayment.php
	MyFatoorahPaymentEmbedded.php
	MyFatoorahPaymentStatus.php
	MyFatoorahList.php
	MyFatoorahRefund.php
	MyFatoorahShipping.php
	MyFatoorahSupplier.php
	MyFatoorah.php
	MyFatoorahHelper.php
	autoload.php
	CHANGELOG.md
	composer.json
	README.md