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 “Extensions” item, in the window that opens, click on the “PayBox” link.

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

Payment system language
Allows you to set the language with which the store will work, the payment page will also be displayed with it. Available languages:

Russian

English

German

Kazakh

Kyrgyz

Uzbek

Default - Russian

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.kz

Order status after successful payment
Allows you to set what status the order will receive in the InSales order list after successful payment. You can read more about statuses here.
Default - New

Order status when payment failed
Allows you to set what status the order will receive in the InSales order list after an unsuccessful payment. You can read more about statuses here.
Default - New

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

Include delivery into receipt
Allows you to set whether it is necessary to add the cost of delivery to fiscal documents (receipts) upon payment.
Default - disabled

VAT
Allows you to set the VAT amount used when generating fiscal documents. Available options:

Without VAT

12%

12/112

18%

18/118

10%

10/110

20%

20/120

15%
Default - Without VAT

10.

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

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