Token payout

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

Example:

550e8400-e29b-41d4-a716-446655440000

pg_amount

number

required

Payment amount

>= 0.01<= 99999999

pg_description

string

required

Payment description

pg_order_time_limit

string <date-time>

required

Time limit for making a payment

Match pattern:

Y-m-d H:i:s

pg_user_id

string

required

User ID in the system

<= 50 characters

Example:

No65GFR755789T

Match pattern:

^[a-zA-Z0-9_-]+$

pg_post_link

string

required

URL to which payment status response is sent

<= 255 characters

Example:

https://site.com/post

pg_card_token_to

string

required

Token of the card to transfer money to (returned when registering the card)

Example:

ef741cfc-f85e-41a0-84e6-2ba964912182

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/reg2reg' \
--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_user_id="No65GFR755789T"' \
--form 'pg_post_link="https://site.com/post"' \
--form 'pg_card_token_to="ef741cfc-f85e-41a0-84e6-2ba964912182"' \
--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 {{project}} system.

pg_status

string

required

Request status.

Status Description:

ok: Request completed successfully.

error: Request completed with an error.

process: Final payment status need.

pg_order_id

string

optional

Order ID in the merchant system.

pg_balance

number

optional

Merchant's balance in the {{project}} system.

pg_card_hash

string

optional

The card to which the payment was made.

pg_card_id

integer

optional

Recipient's card ID.

pg_payment_amount

number

optional

Payment amount.

pg_payment_date

string <date-time>

required

Date and time of the payment.

pg_error_code

integer

optional

Error code.

pg_error_description

string

optional

Description of the 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_status>string</pg_status>
  <pg_order_id>string</pg_order_id>
  <pg_balance>0</pg_balance>
  <pg_card_hash>string</pg_card_hash>
  <pg_card_id>0</pg_card_id>
  <pg_payment_amount>0</pg_payment_amount>
  <pg_payment_date>2019-08-24T14:15:22Z</pg_payment_date>
  <pg_error_code>0</pg_error_code>
  <pg_error_description>string</pg_error_description>
  <pg_salt>string</pg_salt>
  <pg_sig>string</pg_sig>
</root>

Interaction diagram#

Request

Request samples

Responses

Interaction diagram