Name;Description;Type;

pg_amount <p style="color:#d63384">required</p>; Payment amount. <br> Minimum 0.01 <br><br><span style="font-size:14px">Example: 10</span>;number pg_currency;Payment/transfer currency<br><span style="font-size:14px">Example: KZT</span>;string pg_description <p style="color:#d63384">required</p>; Payment description <br>Letters, numbers, dash (-), space <br><span style="font-size:14px">Example: Payment description<span>;string pg_merchant_id <p style="color:#d63384">required</p>; Merchant ID <br>Numbers;integer pg_order_id <p style="color:#d63384">required</p>; Order ID in the shop system<br>Numbers and Latin characters <br><span style="font-size:14px"> Example:123<span>;string pg_card_name <p style="color:#d63384">required</p>;Name and surname of card holders <br>Letters (Latin), dash (-) and space<br> <span style="font-size:14px">Example: TEST TESTOV: 123</p>;string pg_card_pan <p style="color:#d63384">required</p>; Card number <br>Number of digits: from 13 to 20.;integer pg_card_cvc <p style="color:#d63384">required</p>; CVC/CVC2/CVV card password<br>Numbers.;integer pg_card_year <p style="color:#d63384">required</p>; Card expiration year<br>Number of digits: 2.;integer pg_card_month <p style="color:#d63384">required</p>; Card expiration month <br>Number of digits: 2.;integer pg_auto_clearing; Clearing type (0 or 1).<br>1 - automatic write-off after successful authorization, <br>0 - write-off by launching the clearing method<br>Number of digits: 1.;integer pg_testing_mode; Payment mode.<br>0 - production, 1 - test.<br>If the mode is not specified, then the mode set in the shop settings is taken;integer pg_3ds_challenge; Determines the need to complete the Challenge Flow (1 - it is mandatory to conduct the Challenge Requested, 0 or empty - the method is determined by the issuer)<br>the issuing bank can ignore this parameter and make a payment according to its own Challenge Flow;integer pg_language;Error text language.<br>Available languages: ru, en, kz, kg, uz, de;string pg_param1; Additional parameter 1. <br>String;string pg_param2; Additional paramete 2. <br>String;string pg_param3; Additional parameter 3. <br>String;string pg_sig <p style="color:#d63384">required</p>; Digital signature of the request<br>Numbers and Latin letters;string pg_salt <p style="color:#d63384">required</p>; Random string <br>Random numbers and Latin letters <br><span style="font-size:14px"> Example: some random string</span>;string

Title;Description;Type;

pg_description;Description of payment purpose;Letters, numbers, dash (-), space. Format example: Wallet replenishment NoT02265795060, Account replenishment 41225232 pg_user_id;User ID in the merchant system.;Letters, numbers, dashes (-). Format example: No65GFR755789T, 25642588 pg_user_email;Payer's email or Email linked (specified as String in the example@site.com format during registration) to the ID of the personal cabinet or account or the payer's wallet number;A string in the format example@site.com pg_user_phone;Payer's phone number or Phone number linked (specified during registration) to the ID of the personal cabinet or account or the payer's wallet number;Numbers without spaces pluses and brackets. Format example: 89686810502, 87001234567 pg_user_ip;Client IP address;IP address in IPv4 format or IPv6. Examples: 185.102.131.54<br>2001:0DB0:0000:123A:0000:0000:<br>0000:0030<br>2001:DB0:0:123A:0:0:0:30

Title;Description;Type;

pg_payment_method;Payment via tokenized method (apple pay, google pay, samsung pay, yandex pay);Letters (Latin script). Example: apple_pay, google_pay, samsung_pay, yandex_pay pg_online_payment_cryptogram;Ephemeral public key bytes. EC_v1 only;Encrypted string. Related to the field [pg_eci_indicator] pg_eci_indicator;Optional. ECI indicator, as definition of 3d secure. Confirmation from Apple;String. Related to the field [pg_online_payment_cryptogram]

Title;Description;Validation;

pg_payment_id;Transaction ID;Numbers pg_status; Shows the result of the query<br>Status Description <br><span style="color:#d63384">Ok</span> - Request successful <br><span style="color:#d63384">Error</span> - The request failed <br><span style="color:#d63384">Pending</span> - Waiting for payer or payment system;Latin characters pg_3ds;Flag indicating the need to request 3ds. <br>1 - 3ds is set, 0 - no;Digit pg_3d_acsurl;Card Issuer Bank Url for 3ds Validation;url pg_3d_md;Parameter for request 3ds;Letters, numbers pg_3d_pareq;Parameter for request 3ds;Letters, numbers, dashes (-), pg_recurring_profile;Recurring profile ID;Digits (If a parameter was specified in the payment request, pg_recurring_start = 1) pg_card_id;Saved card ID for next payments (Deprecated);Numbers (If parameters were specified, saving the card, pg_save_card and pg_user_id) pg_card_token;Saved card token for next payments;Letters, numbers, dashes (-) (If parameters were specified, saving the card, pg_save_card and pg_user_id) pg_auth_code;Bank payment authorization code;Numbers, length 6 pg_salt;Random string;Arbitrary numbers and Latin letters pg_sig;Request digital signature;Numbers and Latin letters pg_datetime;Date and time of the request;Format: YYYY-MM-DDThh:mm:ss±hh:mm

Title;Description;Validation;

pg_error_code;Error code ID;Numbers pg_error_description;Text description of the error; String

Title;Description;

PaReq;The pg_3d_pareq parameter from the Payment request response MD;The pg_3d_md parameter from the response to the requestPayment TermUrl;Url to which the answer will come in case of success

Title;Description;

PaRes;The parameter is required for the paymentAc request MD;The parameter is required to request paymentAcs

Name;Description;Type;

pg_md <p style="color:#d63384">required</p>; Parameter from the response<br>ACS server of the issuer card <br>Numbers and Latin letters;string pg_pares<p style="color:#d63384">required</p>;Parameter from response<br>ACS server of issuer card <br>Letters, numbers, dashes (-);string pg_payment_id <p style="color:#d63384">required</p>; Transaction ID <br>Numbers.>;integer pg_merchant_id <p style="color:#d63384">required</p>; Merchant ID <br>Numbers;integer pg_salt <p style="color:#d63384">required</p>; Random string<br>Arbitrary numbers and letters;string pg_sig <p style="color:#d63384">required</p>;Digital signature of the request<br>Numbers and Latin letters;string

Title;Description;Validation;

pg_payment_id;Transaction ID;Numbers pg_status; Shows the result of the query<br>Status Description <br><span style="color:#d63384">Ok</span> - Request successful <br><span style="color:#d63384">Error</span> - The request failed <br><span style="color:#d63384">Pending</span> - Waiting for payer or payment system;Latin characters pg_card_id;Saved card ID for next payments (Deprecated);Numbers (If parameters were specified, save the card, pg_save_card pg_user_id) pg_card_token;Saved card token for next payments;Letters, numbers, dashes (-) (If parameters were specified, save the card, pg_save_card pg_user_id) pg_auth_code;Bank payment authorization code;Numbers, length 6 pg_salt;Random string;Arbitrary numbers and Latin letters pg_sig;Request digital signature;Numbers and Latin letters pg_datetime;Date and time of the request;Format: YYYY-MM-DDThh:mm:ss±hh:mm

Title;Description;Validation

pg_error_code;Error Code ID;Numbers pg_error_description;Text description of the error;String

Name;Description;Type;

pg_merchant_id <br><p style="color:#d63384">required</p>;Merchant ID in the system FreedomPay;integer pg_amount <br><p style="color:#d63384">required</p>;Payment amount.<br>Minimum 0.01<br><span style="font-size:14px">Example: 100</span>;number pg_order_id <br><p style="color:#d63384">required</p>;Order ID in the merchant system<br><span style="font-size:14px">Example: 12345</span>;string pg_user_id <br><p style="color:#d63384">required</p>;User ID in the merchant system.<br><span style="font-size:14px">Example: No65GFR755789T, 25642588</span>; string pg_card_id <br><p style="color:#d63384">required</p> if no pg_card_token;Card ID. (Deprecated<br><span style="font-size:14px">Example: 56</span>;integer pg_card_token <br><p style="color:#d63384">required</p> if no pg_card_id;Card token.<br><span style="font-size:14px">Example: ef741cfc-f85e-41a0-84e6-2ba964912182</span>;string pg_description <br><p style="color:#d63384">required</p>;Order description <br><span style="font-size:14px">Example: Payment Description</span>;string pg_salt <br><p style="color:#d63384">required</p>;A random string consisting of arbitrary numbers and Latin letters.<br><span style="font-size:14px">Example: some random string</span>;string pg_sig <br><p style="color:#d63384">required</p>;Request signature;string pg_currency <br><p style="color:#d63384">required</p>;Currency of payment/transfer. Only KZT is allowed in Kazakhstan;string pg_language;Error text language. <br> Available languages: ru, en, kz, kg, uz, de<br><span style="font-size:14px">;string pg_param1;Additional Information;string pg_param2;Additional Information;string pg_param3;Additional Information;string

Title;Description;Type;

pg_status;Shows the result of the query <br>Status Description <br> <span style="color:#d63384">Ok</span> -Request successful <br><span style="color:#d63384">Error</span> - The request failed <br><span style="color:#d63384">Pending</span> - Waiting for payer or payment system;string pg_payment_id;The unique identifier of the payment transaction in FreedomPay. Serves as a key for all further work with the transaction;integer pg_merchant_id;Merchant ID in the system FreedomPay;integer pg_order_id;Order ID in the merchant system;string pg_salt;Random string;string pg_sig;Request signature;string pg_datetime;Date and time of the request;datetime

Title;Description;Validation;

pg_error_code;Error code ID;Numbers pg_error_description;Text description of the error;String

Name;Description;Type;

pg_order_id <br><p style="color:#d63384">required</p>;Payment ID in the merchant system. It is recommended to keep this field unique. <br><p style="color:#d63384">If the merchant did not send this field, then it becomes mandatory for the payer to fill in</p> <br><span style="font-size:14px">Example: 00102</span>;string pg_merchant_id <br><p style="color:#d63384">required</p>;Merchant ID in FreedomPay. Issued upon connection. ;integer pg_amount<br><p style="color:#d63384">required</p>;Payment amount in pg_currency.<br>Minimum 0.01<br><span style="font-size:14px">Example: 10</span>; number pg_description <br><p style="color:#d63384">required</p>;Description of the product or service. Displayed to the customer during the payment process.<br><span style="font-size:14px">Example: Ticket</span>;string pg_salt <br><p style="color:#d63384">required</p>;Random string<br><span style="font-size:14px">Example: some random string</span>;string pg_sig <br><p style="color:#d63384">required</p>;Request signature;string pg_currency;The currency in which the amount is specified. KZT, USD, EUR. If the buyer chooses a payment method in another currency, the recalculation is made at the exchange rate of the Central Bank on the day of payment.<br><span style="font-size:14px">Example: KZT</span>;string pg_check_url;URL to check the possibility of payment. Called before the payment, if the payment system provides such an opportunity. If the parameter is not specified, then it is taken from the merchant settings. If the parameter is set to an empty string, then the check of the possibility of payment is not performed.;string pg_result_url;URL to report the result of the payment. Called after payment on success or failure. If the parameter is not specified, then it is taken from the merchant settings. If the parameter is set to an empty string, then FreedomPay does not tell the merchant y about payment result.; string pg_request_method;GET, POST or XML – method for calling merchant scripts Check URL, Result URL, for transferring information from the payment gate.<br><span style="font-size:14px">Example: POST</span>;string pg_success_url;url to which the user is sent in case of a successful payment (for online systems only);string pg_failure_url;url to which the user is sent in case of unsuccessful payment (for online systems only);string pg_success_url_method;GET is a button that is submitted by the GET method. POST is a button that is submitted using the POST method. If the GET or POST method is selected, then the payment confirmation page is shown to the user on the freedompay.uz site and prompted to click a button to return to the merchant's site. <br><span style="font-size:14px">Example: GET</span>;string pg_failure_url_method;GET is a button that is submitted by the GET method. POST is a button that is submitted using the POST method. If the GET or POST method is selected, then a page with a message about failed payment is shown to the user on the site freedompay.uz, and prompted to click a button to return to the merchant's site.<br><span style="font-size:14px">Example: GET</span>;string pg_site_url; URL of the merchant's site to show the buyer a link by which he can return to the merchant's site after creating an account. Applies to offline PS (cash).<br><span style="font-size:14px">Example: http://site.kz/return</span>;string pg_lifetime;Default: "86400"<br> Time (in seconds) during which the payment must be completed, otherwise the order during the payment FreedomPay will refuse to process the payment system. This parameter is controlled by FreedomPay and, if the payment system supports it, by the payment system. The minimum allowed value is 300 seconds (5 minutes). The maximum allowed value is 604800 seconds (7 days). In case of exceeding the boundary values, the minimum or maximum value will be assigned, respectively.<br><span style="font-size:14px">Example: 86400</span>;integer pg_user_phone;The user's phone number (starting with the country code) is required to identify the buyer. If not specified, the choice will be offered to the user on the payment gate website.<br> <span style="color:#d63384">If the merchant did not send this field, then it becomes mandatory for the payer to fill in</span><br><span style="font-size:14px">Example: 77777777777</span>;string pg_user_contact_email;User's contact email address. If specified, notifications about changes in transaction status will be sent to this address.<br><span style="color:#d63384">If the merchant did not send this field, then it becomes mandatory for the payer to fill in</span><br><span style="font-size:14px">Example: mail@customer.kz</span>;string pg_user_ip;Client's IP address. It is necessary for the analysis of disputable situations in case of suspected fraud. The parameter can be omitted when transmitting information through the user's browser, in which case the IP from which the user went to the payment initialization page will be recorded.<br><span style="font-size:14px">Example: 127.0.0.1</span>;string pg_language; The language of the payment pages on the FreedomPay site and (if possible) payment systems. "en", "ru"<br><span style="font-size:14px">Example: ru</span>;string pg_testing_mode;Creating a payment in test mode.<br><span style="font-size:14px">Example: 1</span>;integer pg_user_id;User ID in the merchant system.<br><span style="font-size:14px">Example: No65GFR755789T, 25642588</span>;string pg_param1;Additional parameter 1.<br><span style="font-size:14px">Example: Additional parameter</span>;string pg_param2;Additional parameter 2.<br><span style="font-size:14px">Example: Additional parameter</span>;string pg_param3;Additional parameter 3.<br><span style="font-size:14px">Example: Additional parameter</span>;string pg_payment_method;Value - Payment method <br> mobile_commerce - Mobile commerce<br><span style="font-size:14px">Example: mobile_commerce</span>;string pg_amount_interval_from;The lower limit of the payment amount. If the parameter is not passed, then there is no lower threshold;integer pg_amount_interval_to;The highest threshold for the payment amount. If the parameter is not passed, then there is no upper threshold;integer pg_generate_qr;In case you want to receive a QR code with a link to the FreedomPay payment form in base64 format, send "1" in the pg_generate_qr parameter;boolean

Title;Description;Type;

pg_status;Shows the result of the query <br>Status Description <br><span style="color:#d63384">ok</span> - Request successful <br> <span style="color:#d63384">Error</span> - The request failed <br><span style="color:#d63384">Pending</span> - Waiting for payer or payment system;string pg_payment_id;The unique identifier of the payment transaction in FreedomPay. Serves as a key for all further work with the transaction; integer pg_redirect_url;The URL to redirect the user to. It can be both on the site freedompay.uz and on the site of the payment system;string pg_redirect_url_type;The type of page to which the redirect occurs. Possible values:<br> need data - dialogue with the buyer to clarify the parameters: payment system, phone number, parameters required for this payment system payment system–page of the payment system website or a page with instructions for paying through this payment system. The page with instructions can be located both on the freedompay.uz site and on the merchant's site. <br><br>If the merchant receives a response with pg_redirect_url_type=”need data”, the merchant may not redirect the buyer to the received URL, but clarify missing parameters on your site. In this case, after specifying the parameters and re-requesting the creation of a payment transaction, a new transaction will be created;string pg_redirect_qr;URL to redirect the user as a QRCode. Transmitted in base64 format;string pg_salt;Random string;string pg_sig;Request signature;string

Title;Description;Validation;

pg_error_code;Error code ID;Numbers pg_error_description;Text description of the error;String

Name;Description;Type;

pg_order_id <br><span style="color:#d63384">required</span>;Payment ID in the merchant system. It is recommended to keep this field unique.<br><span style="font-size:14px">Example: 00102</span>;string pg_merchant_id <br><span style="color:#d63384">required</span>;Merchant ID in FreedomPay. Issued upon connection.; integer pg_amount <br><span style="color:#d63384">required</span>;Payment amount in pg_currency.<br> Minimum 0.01 <br><span style="font-size:14px">Example: 10</span>;number pg_description <br><span style="color:#d63384">required</span>;Description of the product or service. Displayed to the customer during the payment process.<br><span style="font-size:14px">Example: Ticket</span>;string pg_salt <br><span style="color:#d63384">required</span>;Random string<br><span style="font-size:14px">Example: some random string</span>;string pg_sig <br><span style="color:#d63384">required</span>;Request signature;string pg_currency;The currency in which the amount is specified. KZT, USD, EUR. If the buyer chooses a payment method in another currency, the recalculation is made at the exchange rate of the Central Bank on the day of payment.<br><span style="font-size:14px">Example: KZT</span>;string pg_check_url;URL to check the possibility of payment. Called before the payment, if the payment system provides such an opportunity. If the parameter is not specified, then it is taken from the merchant settings. If the parameter is set to an empty string, then the check of the possibility of payment is not performed.;string pg_result_url;URL to report the result of the payment. Called after payment on success or failure. If the parameter is not specified, then it is taken from the merchant settings. If the parameter is set to an empty string, then FreedomPay does not tell the merchant y about payment result.; string pg_request_method;GET, POST or XML – method for calling merchant scripts Check URL, Result URL, for transferring information from the payment gate.<br><span style="font-size:14px">Example: POST</span>;string pg_success_url;url to which the user is sent in case of a successful payment (for online systems only);string pg_failure_url;url to which the user is sent in case of unsuccessful payment (for online systems only);string pg_success_url_method;GET is a button that is submitted by the GET method. POST is a button that is submitted using the POST method. If the GET or POST method is selected, then the payment confirmation page is shown to the user on the freedompay.uz site and prompted to click a button to return to the merchant's site.<br><span style="font-size:14px">Example: GET</span>;string pg_failure_url_method;GET is a button that is submitted by the GET method. POST is a button that is submitted using the POST method. If the GET or POST method is selected, then a page with a message about failed payment is shown to the user on the site freedompay.uz, and prompted to click a button to return to the merchant's site.<br><span style="font-size:14px">Example: GET</span>;string pg_site_url;URL of the merchant's site to show the buyer a link by which he can return to the merchant's site after creating an account. Applies to offline PS (cash).<br><span style="font-size:14px">Example: http://site.kz/return</span>;string pg_lifetime;Default: "86400" <br>Time (in seconds) during which the payment must be completed, otherwise the order during the payment FreedomPay will refuse to process the payment system. This parameter is controlled by FreedomPay and, if the payment system supports it, by the payment system. The minimum allowed value is 300 seconds (5 minutes). The maximum allowed value is 604800 seconds (7 days). In case of exceeding the boundary values, the minimum or maximum value will be assigned, respectively.<br><span style="font-size:14px">Example: 86400</span>;integer pg_user_phone;The user's phone number (starting with the country code) is required to identify the buyer. If not specified, the choice will be offered to the user on the payment gate website.<br><span style="font-size:14px">Example: 77777777777</span>;string pg_user_contact_email;User's contact email address. If specified, notifications about changes in transaction status will be sent to this address.<br><span style="font-size:14px">Example: mail@customer.kz</span>;string pg_user_ip;Client's IP address. It is necessary for the analysis of disputable situations in case of suspected fraud. The parameter can be omitted when transmitting information through the user's browser, in which case the IP from which the user went to the payment initialization page will be recorded.<br><span style="font-size:14px">Example: 127.0.0.1</span>;string pg_language;The language of the payment pages on the FreedomPay site and (if possible) payment systems. "en", "ru"<br><span style="font-size:14px">Example: ru</span>;string pg_testing_mode;Creating a payment in test mode.<br><span style="font-size:14px">Example: 1</span>;integer pg_user_id;User ID in the merchant system.<br><span style="font-size:14px">Example: No65GFR755789T, 25642588</span>;string pg_param1;Additional parameter 1. <br><span style="font-size:14px">Example: Additional parameter</span>;string pg_param2;Additional parameter 2.<br><span style="font-size:14px">Example: Additional parameter</span>;string pg_param3;Additional parameter 3.<br><span style="font-size:14px">Example: Additional parameter</span>;string pg_payment_method;Value - Payment <br> method mobile_commerce - Mobile commerce<br><span style="font-size:14px">Example: mobile_commerce</span>;string pg_generate_qr;In case you want to receive a QR code with a link to the FreedomPay payment form in base64 format, send "1" in the pg_generate_qr parameter; boolean

Title;Description;Type;

pg_status;Shows the result of the query. Status Description <br><span style="color:#d63384">ok</span> -Request successful<br><span style="color:#d63384">Error</span> - The request failed <br><span style="color:#d63384">Pending</span> - Waiting for payer or payment system;string pg_payment_id;The unique identifier of the payment transaction in FreedomPay. Serves as a key for all further work with the transaction;integer pg_redirect_url;The URL to redirect the user to. It can be both on the site freedompay.uz and on the site of the payment system;string pg_redirect_url_type;The type of page to which the redirect occurs. Possible values:<br>need data - dialogue with the buyer to clarify the parameters: payment system, phone number, parameters required for this payment system<br>payment system - page of the payment system website or a page with instructions for paying through this payment system. The page with instructions can be located both on the freedompay.uz site and on the merchant's site.<br><br>If the merchant receives a response with pg_redirect_url_type=”need data”, the merchant may not redirect the buyer to the received URL, but clarify missing parameters on your site. In this case, after specifying the parameters and re-requesting the creation of a payment transaction, a new transaction will be created;string pg_redirect_qr;URL to redirect the user as a QRCode. Transmitted in base64 format;string pg_salt;Random string;string pg_sig;Request signature;string

Title;Description;Validation;

pg_error_code;Error code ID;Numbers pg_error_description;Text description of the error;String

Card number;Expiration date;CVC;Response code;Response

4111111111111111;2024/12;123;0;Successful operation. 5555555555555599;2024/12;123;0;Successful operation. 4444444444446666;2024/12;123;10001;Payment error. Contact card issuer 4563960122001999;2024/12;123;11006;Insufficient funds for the operation. Top up the balance and repeat the payment. 5555555555555557;2024/12;123;10010;Card restrictions. Contact card issuer 4444444444444422;2024/12;123;10016;Payment error. Contact the support service of the site you are paying to. 4444444411111111;2024/12;123;10025;The operation was unsuccessful, an error appears on the side of the Payment System. Repeat payment later.