1. OpenCart
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. OpenCart

Configuration

Please, pay attention!
The plugin configuration should only be performed after correct installation.
To successfully configure the plugin, you need to take some steps:
1.
Go to your site Dashboard:
image.png
2.
Select the “Extensions” button on the left panel, in the list opened click the “Extensions”.
image.png
3.
Choose "Payments" category in the filter.
image.png
4.
Click “Edit” blue button on the right side on the same line as “FreedomPay” payment gateway.
image.png
5.
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: see «Settings» below.
6.
When you have finished configuring the integration, click the “Save” button. Make sure that the data has been saved.

Settings#

 The plugin interface is in Russian: the second line of each setting is its label in the admin panel. Hover over a label in the admin panel to see a hint.
SettingRequiredDescriptionDefault
Is plugin turned on?
“Включен ли плагин”
YesShows Freedom Pay among the payment methods at checkout.Disabled
Sort order
“Порядок сортировки”
Position of Freedom Pay in the list of payment methods at checkout.0
Payment system name
“Название способа оплаты”
Name of the payment method that clients see at checkout.Freedom Pay (Visa, Mastercard)
Client ID (Merchant ID)
“Номер магазина”
YesStore ID in the payment gateway. To get it, see Get Merchant ID and key.—
Secret key
“Секретный ключ”
YesMerchant Key: the store key used to sign requests to the payment gateway and to check notifications from it. To get it, see Get Merchant ID and key.—
Country
“Страна”
YesCountry in which your store is legally located: Kazakhstan, Kyrgyzstan or Uzbekistan. The plugin sends payments to Freedom Pay of this country (api.freedompay.kz, api.freedompay.kg or api.freedompay.uz).Kazakhstan
Order status after payment
“Статус заказа после оплаты”
Status of the order after a successful payment. Read more about the order statuses in the official OpenCart documentation.Not set: choose a status
Two-step payment
“Двухэтапный платёж”
OpenCart 3.x only. When enabled, the money is only held on the client's card at payment. You charge it or release it later on the order page, see «Two-step payment» below. Ask your manager whether two-step payments are available for your store.
In the plugin for OpenCart 4.x, two-step payments are not available yet.
Disabled
Order status after clearing
“Статус заказа после клиринга”
OpenCart 3.x only. Status of the order after the held money is charged.Not set
Order status after cancel
“Статус заказа после отмены”
OpenCart 3.x only. Status of the order after the held money is released.Not set
FFD
“ОФД”
Generate fiscal documents (receipts) for payments. Receipts are generated for stores in Kazakhstan and Uzbekistan. Every product needs a VAT rate, and in Uzbekistan also product codes: see «Product data for receipts and split payments» below. Does not affect the payment.Disabled
Append delivery to FFD
“Учитывать доставку в ОФД”
Add delivery to the receipt. If disabled, delivery is not shown in the receipt. Set the delivery data in “Службы доставки”.Disabled
Shipping services
“Службы доставки”
Receipt and split payment data for each shipping service of your store: the same fields as for products, see below.—
Sub-merchants
“Суб-мерчанты”
Sub-merchants for split payments: add a sub-merchant by its ID and set its data. See «Split payments» below.—
 In the plugin for OpenCart 3.x, the buttons “Экспорт настроек” and “Импорт настроек” save the plugin settings to a file and load them back: use them to move the settings to another store.

Product data for receipts and split payments#

 After installation, the plugin adds the attribute group “Freedom Pay” to your store. Set the attributes on the “Attribute” tab of a product, or on the “Freedom Pay” tab of a category.
AttributeUsed forFormat
“Ставка НДС” (VAT rate)Receipts, Kazakhstan and UzbekistanVAT 0% / no VAT, 10%, 12% or 16%
“ИКПУ товара” (IKPU code)Receipts, Uzbekistan17 digits
“Код упаковки” (package code)Receipts, UzbekistanUp to 20 digits
“Код единицы измерения” (unit code)Receipts, UzbekistanUp to 8 digits
“Тип собственности” (owner type)Receipts, UzbekistanResale, own production or service
“Штрих-код товара” (barcode)Receipts, Uzbekistan, optionalUp to 13 digits
“Код маркировки товара” (marking code)Receipts, Uzbekistan, optionalDigits
“Использовать сплит-платежи” (use split payments)Split paymentsEnabled or disabled
“ID суб-мерчанта” (sub-merchant ID)Split paymentsDigits
“Процент комиссии для сплит-платежа” (commission for split payment)Split paymentsNumber from 0 to 100
“ИНН суб-мерчанта” or “ПИНФЛ суб-мерчанта” (sub-merchant TIN or PINFL)Receipts with split payments, UzbekistanTIN: 9 digits, PINFL: 14 digits
 Where the plugin takes a value from:
1.
The attribute of the product.
2.
If the product has no such attribute: the “Freedom Pay” tab of the product's category. If the product is in several categories, the first category with this value is used (with split payments: the category with the highest commission).
3.
If the categories have no value: the plugin settings.
4.
If the value is not set anywhere, the client sees an error at checkout and cannot pay. Check the products before you enable receipts or split payments.

Split payments#

 Split payments divide the amount of an order between your store and sub-merchants (for example, partners whose goods you sell). Split payments are set up together with your Freedom Pay manager.
1.
Add the sub-merchants in “Суб-мерчанты” in the plugin settings.
2.
For a product, a category or a shipping service, enable “Использовать сплит-платежи” and set “ID суб-мерчанта” and “Процент комиссии для сплит-платежа”.
 In Kazakhstan, receipts do not include sub-merchants.

Two-step payment#

 OpenCart 3.x only. With “Двухэтапный платёж” enabled, the order page of a paid order shows the buttons:
“Clear Freedom Pay payment”: charge the held money. The order gets the status from “Статус заказа после клиринга”.
“Cancel Freedom Pay payment”: release the held money. The order gets the status from “Статус заказа после отмены”.
“Set Freedom Pay payment cleared” and “Set Freedom Pay payment canceled”: only change the status in your store, without a request to Freedom Pay. Use them if the operation was already done in your personal account.
Next step
integration testing
Previous
Installation
Next
Test