1. Bitrix
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Card data encryption
      • Payments
        • Overview
        • Pay by card
        • Pay by card: complete 3DS
        • Pay with Apple Pay
        • Pay with Google Pay
        • Pay by recurring profile
        • Create payment page
        • Create payment page with any amount
        • Capture payment (clearing)
        • Cancel payment
        • Refund payment
        • Get payment status
      • Payouts
        • Overview
        • Pay out to card
        • Pay out to IBAN
        • Get payout balance
        • Get payout status
      • Transfers
        • Overview
        • Transfer from card to card
        • Transfer from card to card: complete 3DS
        • Get exchange rates
        • Get transfer status
      • Saved cards
        • Overview
        • Save card
        • Save card: complete 3DS
        • List saved cards
        • Remove saved card
        • Pay by card token
        • Pay out to card token
        • Get payment status
    • Async API
      • Overview
      • Create
        • Create payment
        • Save card without a charge
      • Read
        • Get payment status
        • Get request result
      • Edit
        • Capture payment (clearing)
        • Cancel payment (reverse)
        • Refund payment
  • Merchant API
    • Overview
    • Payments
      • Overview
      • Checkout
      • Pay by saved card
        • Overview
        • Create payment
        • Confirm payment with CVC
        • Confirm payment without the client
      • Create payment
      • Create payment with a payment page template
      • Create payment in a payment frame
      • Create payment with any amount
      • Create recurring payment
      • Capture payment (clearing)
      • Cancel payment
      • Refund payment
      • Get payment status
    • Payouts
      • Overview
      • Create payout page
      • Pay out to saved card
      • Pay out to IBAN
      • Get payout status
      • Get payout balance
    • Saved cards
      • Get saved cards
      • Save card
      • Save card for payouts
      • Delete saved card
      • Save card without a charge
    • Mobile balance
      • Overview
      • Create mobile balance payment
      • Charge mobile balance
      • Get mobile balance payment status
      • Confirm payment with SMS code
      • Resend SMS code
    • Invoices
      • Overview
      • Recurring payments
        • Overview
        • Create recurring profile
        • Get recurring profile
        • Charge by recurring profile
        • Cancel recurring profile
        • Recurring profile notification
      • Tips
        • Overview
        • Create
      • Create invoice
      • Get invoice status
      • Get invoice details
      • Cancel invoice
      • Refund invoice
    • SDK
      • JS SDK
      • Merchant SDK
        • Android
        • iOS
        • Migration guide
    • CMS
      • Overview
      • Get Merchant ID and key
      • WordPress
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
        • Update
      • Tilda
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • InSales
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Ecwid
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • Bitrix
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • PrestaShop
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • OpenCart
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
      • CS-Cart
        • Overview
        • Installation
        • Configuration
        • Test
        • Live payments
    • Installment
      • Overview
      • Status
        • Get application status
        • Application status notification
        • Change application status
      • Get partners
      • Create application
    • Callbacks
      • Overview
      • Result notify
      • Check request
      • Payout notify
      • Redirect back
  • Partner API
    • Overview
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Client request status
      • Create terminal
      • Update terminal limits
      • Product request status
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Device ID
      • Android SDK
      • iOS SDK
    • Implement SuperApp
      • Overview
      • Pay
      • Refund
      • Status
    • Account
      • Overview
      • Create payment
      • Payment status
      • Batch statuses
      • Statement
      • Statement status
      • Balance
      • Balance status
    • Invoices
      • Info
  1. Bitrix

Configuration

Please, pay attention!
The plugin configuration should only be performed after correct installation.

Open Freedom Pay plugin settings#

To open the Freedom Pay plugin settings, follow these steps:
1.
Open your site's Dashboard:
image.png
2.
Click on the “Store” item in the left panel, “Payment systems” in the sub-menu:
image.png
3.
If you added the Freedom Pay payment system before, choose it in the list, and click the button on the left side of the payment system name and click “Edit” button. If there's no Freedom Pay system yet, click the button “Add payment system” on the right-top corner and choose “FreedomPay” handler:
image.png

Settings#

About payment system logo
To set the logo for the payment system, you can download the favicon image from our website freedompay.kz/logo-of-company and then upload it to your site in the payment system settings page.
 After successfully opening the settings, review the settings available for change. The module interface is in Russian: the second line of each setting is its label in the admin panel.

Payment settings#

SettingRequiredDescriptionDefault
Payment system name
“Название платежной системы”
Needed only if you renamed the payment system in Bitrix (the name your clients see at checkout). In that case enter FreedomPay here: the module uses this value to find the payment of the order. If you did not rename the payment system, leave the field empty.—
Merchant ID
“Идентификатор магазина в FreedomPay (Merchant ID)”
YesStore ID in the payment gateway. To get it, see Get Merchant ID and key.—
Merchant Key
“Секретный ключ (Secret Key)”
YesStore key used to sign requests to the payment gateway and to check notifications from it. To get it, see Get Merchant ID and key.—
API URL
“API URL платежной системы”
YesAddress of the payment gateway. Select the address of the country in which your store is legally located:
• api.freedompay.kz: Kazakhstan.
• api.freedompay.kg: Kyrgyzstan.
• api.freedompay.uz: Uzbekistan.
api.freedompay.kz
Order status upon successful payment
“Статус после успешной оплаты”
Status of the order in the Bitrix order list after a successful payment. The payment of the order is also marked as paid.Not set: choose a status
Order status when payment failed
“Статус после отказа”
Status of the order after an unsuccessful payment.Not set: choose a status
Order status after refund
“Статус после возврата”
Status of the order after the payment is refunded in Freedom Pay (for example, from your personal account).Not set
Test mode
“Тестовый режим”
When enabled, all payments are created as test payments: no real money is charged. Use it together with test cards, see Test. Disable it before you accept real payments.Disabled
Order identifier type
“Тип идентификатора заказа”
Which order identifier is sent to Freedom Pay and shown in your personal account:
• “Id заказа”: order ID.
• “Номер заказа”: order number (account number).
Order ID
Time to close the payment page
“Время закрытия страницы с платежом”
Time in seconds after which the payment result page returns the client to your store automatically. If the field is empty, the payment page uses its own default.—

Receipt (fiscal document) settings#

 These settings do not affect the payment, only the receipts. Receipts are generated only if “Включить ОФД” is enabled. The module has receipt formats only for Uzbekistan (“ФФД 1.00 (ГНК)”) and Russia (Atol): for stores in Kazakhstan and Kyrgyzstan, keep “Включить ОФД” disabled.
SettingRequiredDescriptionDefault
FFD
“Включить ОФД”
Generate fiscal documents (receipts) for payments.Disabled
FFD version
“Версия ФФД”
Format of fiscal documents:
• “ФФД 1.00 (ГНК)”: Uzbekistan. Fill in the product codes, see below.
• “Старая версия ФФД 1.05”, “ФФД 1.05 (Атол)”, “ФФД 1.2 (Атол)”: Russian formats (Atol), kept for compatibility.
“Старая версия ФФД 1.05”
VAT on goods
“НДС на товары”
VAT on goods: without VAT, 0%, 10%, 20%, 10/110 or 20/120. Used with “ФФД 1.00 (ГНК)” and the Atol formats.Without VAT
Append delivery to FFD
“Учитывать доставку в ОФД”
Add delivery to the receipt as a separate item (only if the delivery is not free).Disabled
Delivery VAT
“НДС на доставку”
VAT on delivery: same values as VAT on goods. Used with “ФФД 1.00 (ГНК)” and the Atol formats.Without VAT
IKPU code for delivery
“ИКПУ код для доставки”
IKPU code of delivery. “ФФД 1.00 (ГНК)” only.—
Shipping Packaging Code
“Код упаковки для доставки”
Package code of delivery. “ФФД 1.00 (ГНК)” only.—
Shipping unit code
“Код единицы измерения доставки”
Unit code of delivery. “ФФД 1.00 (ГНК)” only.—
Taxation system
“Система налогообложения”
Tax system of the store. Atol formats only.General tax system
Calculation method indicator
“Признак способа расчета”
Payment method indicator (prepayment, full payment and so on). Atol formats only.Prepayment
Indicator of the subject of calculation of goods
“Признак предмета расчета товара”
What the store sells (product, service and so on). Atol formats only.Product
Measure
“Мера количества предмета расчета”
Unit of quantity of goods. “ФФД 1.2 (Атол)” only.Piece
Shipping calculation item indicator
“Признак предмета расчета доставки”
How delivery is described: work or service. Atol formats only.Work
VAT on goods for FFD old version
“НДС на товары для ФФД старой версии”
VAT on goods. “Старая версия ФФД 1.05” only.Without VAT
Delivery VAT for old version FFD
“НДС на доставку для ФФД старой версии”
VAT on delivery. “Старая версия ФФД 1.05” only.Without VAT
 For “ФФД 1.00 (ГНК)” (Uzbekistan), every product in the cart must have three properties with these codes:
SPIC: IKPU code of the product.
PACKAGE_CODE: package code of the product.
UNIT_CODE: unit code of the product.
 The properties must be added to the cart together with the product (cart item properties), otherwise they do not get into the receipt.
After changing the settings, click the “Save Changes” button:
image.png
Next step
integration testing
Previous
Installation
Next
Test