Freedom Pay
  1. WordPress
Freedom Pay
  • Overview
  • Gateway API
    • Overview
    • Sync API
      • Overview
      • Purchase
        • Overview
        • Create payment
        • Any amount
        • Card
        • 3DSecure
        • Cancel
        • Clearing
        • Refund
        • Status
      • Payout
        • Overview
        • Card
        • IBAN
        • Balance
        • Status
      • Transfer
        • Overview
        • Card
        • 3DSecure
        • Rates
        • Status
      • Card
        • Overview
        • Add
        • 3DSecure
        • List
        • Remove
        • Status
      • Token
        • Overview
        • Token Pay
        • Apple Pay
        • Google Pay
        • Token Payout
        • Status
    • Async API
      • Overview
      • create
        • create payment
        • create payment recurrent
      • read
        • read payment
        • read request
      • edit
        • edit payment.refund
        • edit payment.reverse
        • edit payment.clearing
      • delete
  • Merchant API
    • Overview
    • Purchase
      • Overview
      • Checkout
      • Card token
        • Overview
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment (with CVC)
        • Confirm payment (with CVC)
        • Create payment
        • Confirm payment
      • Create payment
      • Any amount
      • Cancel payment
      • Clearing
      • Refund payment
      • Status
    • Payout
      • Overview
      • Card token
        • Tokenize card
        • Delete token
        • Card token list
        • Create payment
      • Create payment
      • IBAN
      • Balance status
      • Status by order_id
      • Status by Payment ID
      • Status
    • Mobile balance
      • Overview
      • Init
      • Pay
      • Approve
      • Resend code
      • Status
    • Invoice
      • Overview
      • Init
      • Info
      • Pay
      • Status
    • SDK
      • JS SDK
      • Google Pay
      • Freedom QR
        • Reader SDK (Android)
        • Provider SDK (Android)
      • Payment SDK
        • iOS
        • Android
    • 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
    • Redirect back
      POST
    • Result notify
      POST
    • Payout notify
      POST
    • Check request
      POST
  • Card API
    • Overview
    • Payment Cards
      • Overview
      • Dictionaries
      • Bulk issue
      • Issue card
      • Issue plastic card
      • Activate card
      • Block card
      • Unblock card
      • Set PIN
      • Reset PIN counter
      • Close card
      • Update client
      • Card info
      • Balance
      • Secret data
      • Secret data (version 2)
      • Statement
      • Statement extended
      • Create client
      • Edit client
      • Сards' list
      • Request' status
      • Create transaction
      • Clearing transaction
      • Refund transaction
      • Transaction request' status
      • Transaction info
    • Gift Cards
      • Overview
      • List
      • Issue
      • Confirm
      • Resend
      • Resend code
      • Status
  • Partner API
    • Rates
      • Overview
      • Rates
    • Products
      • Overview
      • Dictionaries
      • Add client with product
      • Request status
    • E-Money
      • Overview
      • Add
      • Owner identification
      • Info
      • Close
      • Block
      • Balance
      • Statement
      • Request Status
    • Freedom ID
      • Overview
      • Design
      • iOS SDK
      • Android SDK
      • OAuth2
        • Authorization link
        • Token exchange
        • Token refresh
        • User info
        • Request profile
        • Get profile status
        • Create user
        • Update user
      • OIDC
        • Authorization endpoint
        • Token exchange
        • Userinfo
      • Error codes
      • Examples
        • Keycloak
    • Transfer
      • Overview
      • Get token
      • Refresh token
      • Get agents
      • Fees
      • Create person
      • Create business
      • Create transfer
      • Print application
      • Confirm
      • Search
      • Payout
      • Payout confirm
      • Cancel
      • Get person info
      • Get business info
      • Status
      • Info
    • Device ID
      • Android SDK
      • iOS SDK
  1. WordPress

Configuration

Getting started#

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

Open FreedomPay plugin settings#

To open the FreedomPay plugin settings, follow these steps:
Open your site's Dashboard:
WordPress_WC_Dashboard.png
Click on the “Plugins” item in the left panel, find the line with the FreedomPay plugin in the window that opens and click the “Settings” button:
WordPress_CONF_Plugins.png
If you successfully complete the previous steps, WordPress will open the plugin settings window:
14.png
You can also achieve this result by clicking on the “WooCommerce” item in the left panel, selecting the “Settings” sub-item. Then, selecting the “Payment” group in the window that opens at the top, and clicking the “Manage” (or “Finish setup”) button in the FreedomPay line in the drop-down list:
WordPress_CONF_Payments.png

Actually change the settings#

After successfully opening the settings, you should review the list of settings available for change:
Activate the plugin
Deprecated - will be removed from the interface in future versions.
Allows you to set whether the payment gateway works with WooCommerce.
Default - enabled.
Header
Deprecated - will be removed from the interface in future versions.
Allows you to set the name of the payment system that the user sees at the time of payment. It is recommended not to change the default value.
Default - FreedomPay
Description
Deprecated - will be removed from the interface in future versions.
Allows you to set the description of the payment system that the user sees at the time of payment.
Default - no text
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 real payments mode must be done both on the plugin side and on the FreedomPay server side.
Default - enabled
Payment page language
Allows you to set the language in which the user making the payment will see the payment page. Available languages:
Russian
English
Default - Russian
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 instructions.
Default - no text
Merchant 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
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 - Kyrgyzstan.
api.freedompay.uz - Uzbekistan.
Default - api.freedompay.kz
Order status upon successful payment
Allows you to set what status the order will receive in the WooCommerce order list after successful payment. You can read more about statuses here. The default status is “Processing”, since some products sold may require shipping, so the products are marked as paid but not completed.
Default - Processing
Order status when payment failed
Allows you to set what status the order will receive in the WooCommerce order list after an unsuccessful payment. You can read more about statuses here.
Default - Failed
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
Filling in these attributes is possible on the product page:
WordPress_CONF_Attributes.png
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
After changing the settings, click the “Save Changes” button:
WordPress_CONF_Save.png
Next step
integration testing
Previous
Installation
Next
Test