Request for payment generation

Request

Body Params multipart/form-data

pg_merchant_id

integer

required

Merchant ID in {{project}}.

pg_phone

string

required

User's phone number to receive the code value without country code.

Example:

7777777777

pg_amount

number

required

Payout amount. Must be a multiple of 2000 KZT if the amount is less than or equal to 4000 KZT

>= 2000<= 300000

pg_order_id

integer

required

Order ID in the merchant system.

Example:

550e8400-e29b-41d4-a716-446655440000

pg_post_link

string <uri>

required

URL to which payment status response is sent.

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/cbc/check' \
--form 'pg_merchant_id=""' \
--form 'pg_phone="7777777777"' \
--form 'pg_amount=""' \
--form 'pg_order_id="550e8400-e29b-41d4-a716-446655440000"' \
--form 'pg_post_link="https://site.com/post"' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

Responses

🟢200Success

application/xml

Body

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_order_id

string

required

Order ID in the merchant system.

pg_status

string

required

Transaction Status.

pg_error_code

string

optional

Shows error code in case of error.

pg_error_description

string

optional

Shows error description in case of error.

pg_salt

string

required

Random string consisting of arbitrary numbers and Latin letters.

pg_sig

string

required

Request signature.

Example

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