Freedom Pay
  1. Products
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
        POST
      • Request status
        POST
    • 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. Products

Dictionaries

Request#

CodeDescription
successSuccessfully processed.
processIn progress.
errorProcessing error.

Product#

Product IDName
10001Freedom Pos
11001Freedom Box
20000Freedom Ecom

Freedom POS#

Parameter NameParameter NameParameter NameDescriptionType
productObject containing product parameters.object
product_id (required)Identifier of the product (Reference Guide).integer
mcc (required)Merchant Category Code.string
currency (required)Currency for transactions.string
name (required)Name of the trading point displayed in the softPOS application.string
descriptor (required)Terminal descriptor (Maximum 24 characters, Latin alphabet).string
address (required)Address data object where Freedom Pos will be used.object
country (required)Country (alpha-3 format).string
postal_code (required)Postal code.string
address_line1 (required)City of registration.string
address_line2 (required)Street of registration.string
address_line3 (required)Building and premises of registration.string
user (required)Cashier data object for Freedom Pos.object
name (required)Full name of the cashier.string
email (required)Email of the cashier.string
phone (required)Phone number of the cashier.string
package_name (required)Name of the softPOS application.string

Freedom ECOM#

Parameter NameParameter NameParameter NameDescriptionType
productObject containing product parameters.object
product_id (required)Identifier of the product (Reference Guide).integer
name (required)Name of the trading point displayed in the softPOS application.string
mcc (required)Merchant Category Code.string
descriptor (required)Terminal descriptor (Maximum 24 characters, Latin alphabet).string
merchant_url (required)The address where the terminal will be used.string
merchant_ip (required)IP address from where requests for operations will be initiated.string
address (required)Address data object where Freedom Pos will be used.object
country (required)Country (alpha-3 format).string
postal_code (required)Postal code.string
address_line1 (required)City of registration.string
address_line2 (required)Street of registration.string
address_line3 (required)Building and premises of registration.string
limitArray containing limits.array
typeLimit type.
See reference
string
valueValue of limits.
See reference
string
currency (required)Currency of transactions.string

Freedom BOX#

Parameter NameParameter NameParameter NameDescriptionType
productObject containing product parameters.object
product_id (required)Identifier of the product (Reference Guide).integer
merchant_id (required)Merchant ID.integer
mcc (required)Merchant Category Code.string
currency (required)Currency for transactions.string
terminal_number (required)Terminal number in the partner's system.string
name (required)Name of the trading point displayed in the softPOS application.string
descriptor (required)Terminal descriptor (Maximum 24 characters, Latin alphabet).string
address (required)Address data object where Freedom Pos will be used.object
country (required)Country (alpha-3 format).string
postal_code (required)Postal code.string
address_line1 (required)City of registration.string
address_line2 (required)Street of registration.string
address_line3 (required)Building and premises of registration.string
limitArray containing limits.array
typeLimit type.
See reference
string
valueValue of limits.
See reference
string

Limits#

Limits for the Freedom Ecom Product#

Limit Type (type)Limit Value (value)Description
MAX_TR_AMNT_LIMMAX100KMaximum transaction amount of 100,000 KZT
MAX500KMaximum transaction amount of 500,000 KZT
MAX1MLNMaximum transaction amount of 1 million KZT
VISA_MAX_TR_AMNT_LIMVMAX2500USDMaximum transaction amount with VISA: 2,500 USD
MC_MAX_TR_AMNT_LIMMCMAX5000USDMaximum transaction amount with Mastercard: 5,000 USD
DAILY_LIM1MLNDaily limit of 1 million KZT
2MLNDaily limit of 2 million KZT
10MLNDaily limit of 10 million KZT
30MLNKZTDaily limit of 30 million KZT
MONTHLY_LIM10MLNKZTMonthly limit of 10 million KZT
30MLNKZTMonthly limit of 30 million KZT
60MLNKZTMonthly limit of 60 million KZT
300MLNKZTMonthly limit of 300 million KZT
1BILKZTMonthly limit of 1 billion KZT

Limits for the Freedom Box Product#

Limit TypeDescription
daily_pos_limitDaily turnover limit
daily_card_limitDaily turnover limit for a single card

Reference for daily_pos_limit sizes#

CodeDescription
GROUP110,000,000 KZT
GROUP220,000,000 KZT
GROUP330,000,000 KZT
GROUP450,000,000 KZT
GROUP570,000,000 KZT
GROUP6100,000,000 KZT

Reference for daily_card_limit sizes#

CodeDescription
GROUP1_2_31,000,000 KZT
GROUP4_52,000,000 KZT
GROUP63,000,000 KZT
Previous
Overview
Next
Add client with product