Create payment

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}
Issued upon connection

pg_order_id

string

required

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

<= 50 characters

Example:

550e8400-e29b-41d4-a716-446655440000

pg_amount

number

required

Payment amount

>= 0.01<= 99999999

pg_description

string

required

Payment description

>= 1 characters<= 255 characters

pg_order_time_limit

string

required

Time limit for making a payment

Match pattern:

Y-m-d H:i:s

pg_payment_route

string

optional

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

Example:

frame

pg_user_id

string

optional

User ID in the merchant system

<= 50 characters

pg_user_email

string <email>

optional

User's contact email address

pg_back_link

string

required

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

<= 255 characters

Example:

https://site.com/back

pg_post_link

string

required

URL to which payment status response is sent

<= 255 characters

Example:

https://site.com/post

pg_salt

string

required

A random string consisting of arbitrary numbers and Latin letters

pg_sig

string

required

Request signature

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.kz/api/reg2nonreg' \
--form 'pg_merchant_id=""' \
--form 'pg_order_id="550e8400-e29b-41d4-a716-446655440000"' \
--form 'pg_amount=""' \
--form 'pg_description=""' \
--form 'pg_order_time_limit=""' \
--form 'pg_payment_route="frame"' \
--form 'pg_user_id=""' \
--form 'pg_user_email=""' \
--form 'pg_back_link="https://site.com/back"' \
--form 'pg_post_link="https://site.com/post"' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

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>

Interaction diagram#

Request

Request samples

Responses

Interaction diagram