Page with amount control

Request

Body Params multipart/form-data

pg_order_id

string

required

Payment ID in the merchant system. It is recommended to keep this field unique.||string

pg_merchant_id

integer

required

Merchant ID in {{project}}. Issued upon connection.||integer

pg_amount

number

required

Payment amount in pg_currency. Minimum 0

pg_description

string

required

Description of the product or service.||string

pg_salt

string

required

Random string consisting of arbitrary numbers and Latin letters||string

pg_sig

string

required

Request signature||string

pg_currency

string

optional

Currency in which the amount is specified (KZT

pg_check_url

string

optional

URL to check the possibility of payment.||string

pg_result_url

string

optional

URL to report the result of the payment.||string

pg_request_method

string

optional

GET

pg_success_url

string

optional

URL to which the user is sent in case of a successful payment.||string

pg_failure_url

string

optional

URL to which the user is sent in case of unsuccessful payment.||string

pg_success_url_method

string

optional

Method used for the success URL (GET or POST).||string

pg_failure_url_method

string

optional

Method used for the failure URL (GET or POST).||string

pg_site_url

string

optional

Merchant's site URL for returning the buyer after payment.||string

pg_lifetime

integer

optional

Time during which the payment must be completed (in seconds).||integer

pg_user_phone

string

optional

The user's phone number (starting with the country code).||string

pg_user_contact_email

string

optional

User's contact email address.||string

pg_user_ip

string

optional

Client's IP address.||string

pg_language

string <ISO 639-1:2002>

optional

Language of the payment pages

Default:

ru

Examples:

ruenkzkguz

pg_testing_mode

integer

optional

Creating a payment in test mode.||integer

pg_user_id

string

optional

User ID in the merchant system.||string

pg_param1

string

optional

Additional parameter 1.||string

pg_param2

string

optional

Additional parameter 2.||string

pg_param3

string

optional

Additional parameter 3.||string

pg_payment_method

string

optional

Payment method (e.g.

pg_amount_interval_from

integer

optional

The lower limit of the payment amount.||integer

pg_amount_interval_to

integer

optional

The highest threshold for the payment amount.||integer

pg_generate_qr

boolean

optional

Receive a QR code with a link to the payment form in base64 format.||boolean

pg_idempotency_key

string

optional

Idempotency key. Used to prevent duplicate request creation. A unique value within the merchant's scope; the same key cannot be used for different operations.

pg_loyalty_id

string

optional

Identifier in the loyalty system.

pg_loyalty_amount

number

optional

Amount of accrued units in the loyalty system.

pg_freedom_id

string

optional

User identifier in the Freedom ecosystem.

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.freedompay.kg/g2g/any_amount' \
--form 'pg_order_id=""' \
--form 'pg_merchant_id=""' \
--form 'pg_amount=""' \
--form 'pg_description=""' \
--form 'pg_salt=""' \
--form 'pg_sig=""' \
--form 'pg_currency=""' \
--form 'pg_check_url=""' \
--form 'pg_result_url=""' \
--form 'pg_request_method=""' \
--form 'pg_success_url=""' \
--form 'pg_failure_url=""' \
--form 'pg_success_url_method=""' \
--form 'pg_failure_url_method=""' \
--form 'pg_site_url=""' \
--form 'pg_lifetime=""' \
--form 'pg_user_phone=""' \
--form 'pg_user_contact_email=""' \
--form 'pg_user_ip=""' \
--form 'pg_language=""' \
--form 'pg_testing_mode=""' \
--form 'pg_user_id=""' \
--form 'pg_param1=""' \
--form 'pg_param2=""' \
--form 'pg_param3=""' \
--form 'pg_payment_method=""' \
--form 'pg_amount_interval_from=""' \
--form 'pg_amount_interval_to=""' \
--form 'pg_generate_qr=""' \
--form 'pg_idempotency_key=""' \
--form 'pg_loyalty_id=""' \
--form 'pg_loyalty_amount=""' \
--form 'pg_freedom_id=""'

Responses

🟢200Success

application/xml

Body

pg_payment_id

integer

required

Payment ID

pg_status

string

required

ok

pg_redirect_url

string

required

pg_redirect_url_type

string

required

pg_redirect_qr

string

required

pg_salt

string

required

pg_sig

string

required

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_status>ok</pg_status>
    <pg_payment_id>123456</pg_payment_id>
    <pg_redirect_url>https://customer.freedompay.kz/</pg_redirect_url>
    <pg_redirect_url_type>need data</pg_redirect_url_type>
    <pg_redirect_qr>data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA...</pg_redirect_qr>
    <pg_salt>some random string</pg_salt>
    <pg_sig>signature-abc123</pg_sig>
</response>