Dictionaries
Request#
| Code | Description |
|---|
success | Successfully processed. |
process | In progress. |
error | Processing error. |
Product#
| Product ID | Name |
|---|
10001 | Freedom Pos |
11001 | Freedom Box |
20000 | Freedom Ecom |
Freedom POS#
| Parameter Name | Parameter Name | Parameter Name | Description | Type |
|---|
product | | | Object 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 Name | Parameter Name | Parameter Name | Description | Type |
|---|
product | | | Object 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 |
| limit | | Array containing limits. | array |
| | type | Limit type.
See reference | string |
| | value | Value of limits.
See reference | string |
| currency (required) | | Currency of transactions. | string |
Freedom BOX#
| Parameter Name | Parameter Name | Parameter Name | Description | Type |
|---|
product | | | Object 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 |
| limit | | Array containing limits. | array |
| | type | Limit type.
See reference | string |
| | value | Value of limits.
See reference | string |
Limits#
| Limit Type (type) | Limit Value (value) | Description |
|---|
| MAX_TR_AMNT_LIM | MAX100K | Maximum transaction amount of 100,000 KZT |
| MAX500K | Maximum transaction amount of 500,000 KZT |
| MAX1MLN | Maximum transaction amount of 1 million KZT |
| VISA_MAX_TR_AMNT_LIM | VMAX2500USD | Maximum transaction amount with VISA: 2,500 USD |
| MC_MAX_TR_AMNT_LIM | MCMAX5000USD | Maximum transaction amount with Mastercard: 5,000 USD |
| DAILY_LIM | 1MLN | Daily limit of 1 million KZT |
| 2MLN | Daily limit of 2 million KZT |
| 10MLN | Daily limit of 10 million KZT |
| 30MLNKZT | Daily limit of 30 million KZT |
| MONTHLY_LIM | 10MLNKZT | Monthly limit of 10 million KZT |
| 30MLNKZT | Monthly limit of 30 million KZT |
| 60MLNKZT | Monthly limit of 60 million KZT |
| 300MLNKZT | Monthly limit of 300 million KZT |
| 1BILKZT | Monthly limit of 1 billion KZT |
Limits for the Freedom Box Product#
| Limit Type | Description |
|---|
| daily_pos_limit | Daily turnover limit |
| daily_card_limit | Daily turnover limit for a single card |
Reference for daily_pos_limit sizes#
| Code | Description |
|---|
| GROUP1 | 10,000,000 KZT |
| GROUP2 | 20,000,000 KZT |
| GROUP3 | 30,000,000 KZT |
| GROUP4 | 50,000,000 KZT |
| GROUP5 | 70,000,000 KZT |
| GROUP6 | 100,000,000 KZT |
Reference for daily_card_limit sizes#
| Code | Description |
|---|
| GROUP1_2_3 | 1,000,000 KZT |
| GROUP4_5 | 2,000,000 KZT |
| GROUP6 | 3,000,000 KZT |
Modified at 2025-03-15 05:31:11
