Frame - Freedom Pay

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.

Example:

00102

pg_merchant_id

integer

required

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

pg_amount

number

required

Payment amount in pg_currency. Minimum 0.01.

Example:

10

pg_description

string

required

Description of the product or service. Displayed to the customer during the payment process.

Example:

Ticket

pg_salt

string

required

Random string.

Example:

some random string

pg_sig

string

required

Request signature.

pg_payment_route

string

required

To initialize frame.

Example:

frame

pg_currency

string

optional

The currency in which the amount is specified. KZT

Example:

KZT

pg_check_url

string

optional

URL to check the possibility of payment. Called before the payment

pg_result_url

string

optional

URL to report the result of the payment. Called after payment on success or failure.

pg_request_method

string

optional

Method for calling merchant scripts Check URL

Example:

POST

pg_failure_url

string

optional

URL to which the user is sent in case of unsuccessful payment (for online systems only).

pg_failure_url_method

string

optional

Method for button submission in case of failed payment.

Example:

GET

pg_state_url

string

optional

URL of the script on the merchant's website where the buyer is redirected to wait for a response from the payment system.

Example:

http://site.kz/state

pg_state_url_method

string

optional

Method for state URL submission.

Example:

GET

pg_site_url

string

optional

URL of the store site to display to the customer a link to return after creating an account.

Example:

http://site.kz/return

pg_lifetime

integer

optional

Time in seconds during which the payment must be completed

Example:

86400

pg_user_phone

string

optional

The user's phone number (starting with the country code) is required to identify the buyer. If not specified

Example:

77777777777

pg_user_contact_email

string

optional

User's contact email address. If specified

Example:

mail@customer.kz

pg_user_ip

string

optional

Client's IP address. It is necessary for the analysis of disputable situations in case of suspected fraud.

Example:

127.0.0.1

pg_postpone_payment

integer

optional

Create a postpone payment if "1" is passed in this parameter. If present, pg_user_contact_email must also be specified.

Example:

0

pg_language

string

optional

The language of the payment pages on the {{project}} site and (if possible) payment systems.

Example:

ru

pg_testing_mode

integer

optional

Creating a payment in test mode.

Example:

1

pg_user_id

string

optional

User ID in the merchant system.

Example:

No65GFR755789T

pg_recurring_start

integer

optional

Flag

Example:

1

pg_recurring_lifetime

integer

optional

The amount of time the merchant expects to use the recurring payment profile.

Example:

156

pg_param1

string

optional

Additional parameter 1.

Example:

Additional information

pg_param2

string

optional

Additional parameter 2.

Example:

Additional information

pg_param3

string

optional

Additional parameter 3.

Example:

Additional information

pg_auto_clearing

integer

optional

If 1

Example:

1

pg_generate_qr

boolean

optional

To receive a QR code with a link to the {{project}} payment form in base64 format.

Example:

1

pg_commission_discount

boolean

optional

To use a discount on the commission

Example:

1

pg_commission_discount_fix

number

optional

To use a fixed discount amount.

pg_commission_discount_percentage

number

optional

To use a percentage discount.

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.uz/init_payment.php' \
--form 'pg_order_id="00102"' \
--form 'pg_merchant_id=""' \
--form 'pg_amount="10"' \
--form 'pg_description="Ticket"' \
--form 'pg_salt="some random string"' \
--form 'pg_sig=""' \
--form 'pg_payment_route="frame"' \
--form 'pg_currency="KZT"' \
--form 'pg_check_url=""' \
--form 'pg_result_url=""' \
--form 'pg_request_method="POST"' \
--form 'pg_failure_url=""' \
--form 'pg_failure_url_method="GET"' \
--form 'pg_state_url="http://site.kz/state"' \
--form 'pg_state_url_method="GET"' \
--form 'pg_site_url="http://site.kz/return"' \
--form 'pg_lifetime="86400"' \
--form 'pg_user_phone="77777777777"' \
--form 'pg_user_contact_email="mail@customer.kz"' \
--form 'pg_user_ip="127.0.0.1"' \
--form 'pg_postpone_payment="0"' \
--form 'pg_language="ru"' \
--form 'pg_testing_mode="1"' \
--form 'pg_user_id="No65GFR755789T";type= 25642588' \
--form 'pg_recurring_start="1"' \
--form 'pg_recurring_lifetime="156"' \
--form 'pg_param1="Additional information"' \
--form 'pg_param2="Additional information"' \
--form 'pg_param3="Additional information"' \
--form 'pg_auto_clearing="1"' \
--form 'pg_generate_qr="1"' \
--form 'pg_commission_discount="1"' \
--form 'pg_commission_discount_fix=""' \
--form 'pg_commission_discount_percentage=""' \
--form 'pg_idempotency_key=""' \
--form 'pg_loyalty_id=""' \
--form 'pg_loyalty_amount=""' \
--form 'pg_freedom_id=""'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}