Configuration

Getting started

Please, pay attention!

The plugin configuration should only be performed after correct installation.

To successfully configure the plugin, you need to take some steps:

Go to your site Dashboard:

Select the “Payment” button on the left panel, in the list opened click the “Payment Methods”.

Click “Configure” on the right side on the same line as “FreedomPay” payment gateway.

In the module settings, set the values of the client identifier (Merchant ID) and the secret key for receiving (Secret key). If you do not know how to obtain this data, use the instructions. You should also set the remaining settings. Their description follows.

Client ID (Merchant ID)

Must be installed for the plugin to work.

Allows you to set the store ID in the payment gateway. To get it, use the instructions.
Default - no text

Secret key

Must be installed for the plugin to work.

Allows you to set the store key that will be used to sign all incoming transactions in the payment gateway. To get it, use the instructions.
Default - no text

API URL for payment initialization

Must be installed for the plugin to work.

Allows you to set the payment gateway address. Select the address that matches the country in which your store is legally located:

api.freedompay.kz - Kazakhstan.

api.freedompay.kg - KyrKyrgyzstan.

api.freedompay.uz - Uzbekistan.

Default - api.freedompay.uz

Test mode

📌

Deprecated - will be removed from the interface in future versions.

Allows you to set whether the payment gateway works for test payments or real ones. When changing this parameter, be sure to contact the FreedomPay manager, since switching the store to “test” mode or “live payments” mode must be done both on the plugin side and on the FreedomPay server side.
By default - disabled

FFD
Allows you to set whether it is necessary to generate fiscal documents (receipts) upon payment.
Default - disabled

FFD version
Allows you to set which version of the fiscal document format the payment gateway should use. Available options:

FFD v1 - Obsolete format of fiscal documents (Russia, atol 1.05).

Deprecated - will be removed from the interface in future versions.

FFD v2 atol - Current format of fiscal documents (Russia, atol 1.05).

Deprecated - will be removed from the interface in future versions.

FFD v2 gnk - Current format of fiscal documents (Uzbekistan).
Don't forget to fill in the VAT field for goods when choosing this format.
Also, if you choose this format, you need to fill in some fields for all your goods separately, including such fields as:

ikpu_code - IKPU product code

package_code - Product packaging code

unit_code - Product unit code
Default - FFD v1

Taxation system
Allows you to set which tax system is used by the store. Used only if FFD v2 atol is selected. Does not affect the payment, only the fiscalization process.
Default - General tax system

Calculation method indicator
Allows you to set which payment method is selected by the store. Used only if FFD v2 atol is selected. Does not influence the payment, only the fiscalization process.
Default - Prepayment

Indicator of the subject of calculation of goods
Allows you to set what exactly the store sells. Used only if FFD v2 atol is selected. Does not influence the payment, only the fiscalization process.
Default - Product

VAT on goods for FFD old version

Deprecated - will be removed from the interface in future versions.

Allows you to set the value added tax for goods. Used only if FFD v1 is selected. Does not influence the payment, only the fiscalization process.
Default - Without VAT

VAT on goods
Allows you to set the value added tax for goods. Used only if FFD v2 atol or FFD v2 gnk is selected. Does not influence the payment, only the fiscalization process.
Default - Without VAT

Append delivery to FFD
Allows you to set whether to include delivery in fiscal documents. Does not affect the payment, only the fiscalization process.
Default - disabled

Shipping calculation item indicator

Deprecated - will be removed from the interface in future versions.

Allows you to set how the store will characterize the delivery. Used only if FFD v2 atol is selected. Does not influence the payment, only the fiscalization process.
Default - Work

Delivery VAT for old version FFD

Deprecated - will be removed from the interface in future versions.

Allows you to set the value added tax for delivery. Used only if FFD v1 is selected. Does not influence the payment, only the fiscalization process.
Default - Without VAT

Delivery VAT
Allows you to set the value added tax for delivery. Used only if FFD v2 atol or FFD v2 gnk is selected. Does not affect the payment, only the fiscalization process.
Default - Without VAT

IKPU code for delivery
Allows you to set the IKPU delivery code (ikpu_code). Used only if FFD v2 gnk is selected. Does not influence the payment, only the fiscalization process.
Default - no text

Shipping Packaging Code
Allows you to set the package code for delivery (package_code). Used only if FFD v2 gnk is selected. Does not influence the payment, only the fiscalization process.
Default - no text

Shipping unit code
Allows you to set the unit code for delivery (unit_code). Used only if FFD v2 gnk is selected. Does not influence the payment, only the fiscalization process.
Default - no text

When you have finished configuring the integration, you must click the “Save” button. Make sure that the data has been saved.

Next step

integration testing

Getting started#

Getting started