Token Payout - Freedom Pay

Request

Body Params multipart/form-data

pg_amount

number

required

Transfer amount. Minimum 0.01

Example:

10

pg_merchant_id

integer

required

Merchant ID in the FreedomPay system

Example:

pg_order_id

string

required

Order ID in the merchant system. A unique, monotonically increasing value is recommended

Example:

1234

pg_user_id

integer

required

User ID in the system

Example:

1234

pg_card_token_to

string

optional

Token of the card to transfer money to (returned when registering the card).
Required if no pg_card_id_to

Example:

c92741d9-ddd7-4bad-abd0-5594a79eea1

pg_description

string

required

Payment description

Example:

Payment Description

pg_post_link

string

required

URL to which payment status response is sent

Example:

http://site.kz/post

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

Example:

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.kg/g2g/reg2reg' \
--form 'pg_amount="10"' \
--form 'pg_merchant_id="{{paybox_merchant_id}}"' \
--form 'pg_order_id="1234"' \
--form 'pg_user_id="1234"' \
--form 'pg_card_token_to="c92741d9-ddd7-4bad-abd0-5594a79eea1"' \
--form 'pg_description="Payment Description"' \
--form 'pg_post_link="http://site.kz/post"' \
--form 'pg_order_time_limit="2020-12-31 12:00:00"' \
--form 'pg_salt="some random string"' \
--form 'pg_sig="{{paybox_signature}}"'

Responses

🟢200Success

application/xml

Body

pg_payment_id

integer

required

pg_merchant_id

integer

required

pg_status

string

required

pg_order_id

string

required

pg_balance

number

required

pg_card_hash

string

required

pg_card_token

string

required

pg_payment_amount

number

required

pg_payment_date

string

required

pg_error_code

number

required

pg_error_description

string

required

pg_salt

string

required

pg_sig

string

required

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_payment_id>1234567890</pg_payment_id>
    <pg_merchant_id>9970</pg_merchant_id>
    <pg_status>ok</pg_status>
    <pg_order_id>ABC12345</pg_order_id>
    <pg_balance>5000.75</pg_balance>
    <pg_card_hash>39b32dfc9ed18533ee98b921687ad87a</pg_card_hash>
    <pg_card_token>token-xyz987</pg_card_token>
    <pg_payment_amount>100.00</pg_payment_amount>
    <pg_payment_date>2024-09-02T12:19:01+00:00</pg_payment_date>
    <pg_error_code>0</pg_error_code>
    <pg_error_description>Description</pg_error_description>
    <pg_salt>some random string</pg_salt>
    <pg_sig>signature-abc123</pg_sig>
</response>