Payout page

POST

https://api.freedompay.kg/api/reg2nonreg

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}.

pg_order_id

string

required

Order ID in the merchant system. A unique

Example:

order_1234

pg_amount

number

required

Transfer amount. Minimum 0.01.

Example:

pg_description

string

required

Payment description.

Example:

Payment Description

pg_back_link

string

required

URL to which the user is redirected in case of successful payment.

Example:

http://site.kz/back

pg_post_link

string

required

URL to which payment status response is sent.

pg_order_time_limit

string

required

Time limit for making a payment.

Example:

2020-12-31 12:00:00

pg_salt

string

required

A random string consisting of arbitrary numbers and Latin letters.

Example:

some random string

pg_sig

string

required

Request signature.

pg_user_id

string

optional

User ID in the merchant system.

Example:

pg_payment_route

string

optional

To initialize a frame. In order to use the frame for payments

Example:

frame

pg_user_email

string

optional

Email of the user in the merchant system.

Example:

mail@customer.kz

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.freedompay.kg/api/reg2nonreg' \
--form 'pg_merchant_id=""' \
--form 'pg_order_id="order_1234"' \
--form 'pg_amount="10"' \
--form 'pg_description="Payment Description"' \
--form 'pg_back_link="http://site.kz/back"' \
--form 'pg_post_link=""' \
--form 'pg_order_time_limit="2020-12-31 12:00:00"' \
--form 'pg_salt="some random string"' \
--form 'pg_sig=""' \
--form 'pg_user_id="1"' \
--form 'pg_payment_route="frame"' \
--form 'pg_user_email="mail@customer.kz"'

Responses

🟢200Success

application/xml

Body

pg_status

string

required

Shows the result of the query.

Status Description:

ok: Request was successful.

error: Request was successful.

pg_payment_id

integer

required

The unique identifier of the payment transaction in {{project}}. Serves as a key for all further work with the transaction.

pg_merchant_id

integer

required

Merchant ID in the system {{project}}.

pg_redirect_url

string

required

URL for which a redirect is required.

pg_salt

string

required

Random string.

pg_sig

string

required

Request signature.

Example

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <pg_status>string</pg_status>
  <pg_payment_id>0</pg_payment_id>
  <pg_merchant_id>0</pg_merchant_id>
  <pg_redirect_url>string</pg_redirect_url>
  <pg_salt>string</pg_salt>
  <pg_sig>string</pg_sig>
</root>

Modified at 2025-02-03 10:08:06

Page with amount control

Frame