MyFatoorah Payment Installation

Installation

Preliminary Works

The following information is requested from the provider for the brand-specific and production (live) environment.

• API_URL

• API_KEYS

• WEBHOOK_SECRET_KEY *

A hash_key of at least 32 characters in length and a secret_key of at least 41 characters in length should be generated. The keys produced during the installation must be stored. Here is an example command to generate a random key:

openssl rand -base64 41

* In “Webhook Settings” on the panel:

- “Enable Webhook” must be marked as “Yes”

- ”Webhook” field should be set with this url: “https://SHOP_URL/orders/hooks/payment”

- “Enable Secret Key” must be marked as “Yes”

- ”Webhook Events” must be marked as “Transaction Status Changed”

-”Webhook Secret Key” must be generated and set to WEBHOOK_SECRET_KEY

Environment Variables

The extension installed to the relevant project in ACC must have the following environment variables. Environment variables can be entered before or after the deployment phase. As changes are made to the environment variables, the deployment process must be performed again.

Variable	Description
SECRET_KEY	Code received during the preliminary works phase
HASH_KEY	Code generated during the preliminary works phase
WEBHOOK_URL	https://{SHOP_URL}/orders/hooks/payment
API URL	URL received during the preliminary works phase (without a trailing slash at the end)
API KEYS	Currencies are defined in shop urls hashed with md5. Curency includes API KEY, WEBHOOK SECRET KEY and SUPPLIER parameters. SUPPLIER is not mandatory. This should be a json data as given example below: API_KEYS = { "{md5(https://shop_url.com)}": { "{currency}": { "API_KEY": "", "WEBHOOK_SECRET_KEY": "", "SUPPLIER": "" } } }
API URLS	This data should be in Json format. It contains the MyFatoorah API Url equivalents of currencies. When left blank, the default API URL parameter is valid. (optional) Example: {"KWD": "https://apitest.myfatoorah.com/v2","QAR": "https://api-qa.myfatoorah.com/v2"}
ADMIN_USERNAME	A username can be entered (example: ‘akinon’)
ADMIN_PASSWORD	A newly created and extension-specific strong password
ADMIN_EMAIL	The e-mail address of the installer can be entered
PAYMENT_METHODS	List of MyFatoorah Payment Method IDs corresponding to the payment methods that should be displayed on the redirected screen.If not added, all available payment methods will be displayed ex:[11]

Omnitron Settings

The installed extension must also be defined to the project via Omnitron. This can be done on the Payment Options & Add/Edit POS Integration pages. After the settings are completed, it will be accessible under a new tab on the payment screen as it is a redirection type payment integration.

Payment Options

One payment option must be defined in Omnitron to be specific for the extension installed. Explanations on how the settings should be made at this stage are in the table below.

Field	Description
Payment Option	Redirect to bank
Payment Option Name	Redirection
Payment Option Slug	myfatoorah_ext
Config*	{"pos_slug":"myfatoorah"}

Fields other than pos_slug should be determined according to the requirements.

POS Integration

One POS integration must be defined in Omnitron to be specific for the extension installed. Explanations on how the settings should be made at this stage are in the table below.

Field	Description
Name	MyFatoorah
Slug	myfatoorah
Gateway	extension
Resource URL	Extension URL
Username	ADMIN_USERNAME value in environment variables
Password	ADMIN_PASSWORD value in environment variables
Hash Key	Code received during the preliminary works phase
Payment Type	SALE

Cautions

There is a situation where refunds go into pending status, and after the maximum number of attempts (7 times), they switch to manual refund. In this case, the brand can manually proceed with the refund process.