Token Payout - Freedom Pay

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

pg_amount

number

required

Payment amount

>= 0.01

pg_description

string

required

Payment description
(These parameters may include parameters from other sections. For the effective operation of SecureBox, it is recommended to follow the validation guidelines and field examples from this section)

pg_order_time_limit

string

required

Time limit for making a payment

pg_user_id

integer

required

User ID in the merchant's system
(These parameters may include parameters from other sections. For the effective operation of SecureBox, it is recommended to follow the validation guidelines and field examples from this section)

pg_post_link

string

required

URL to which payment status response is sent

pg_card_token_to

string

optional

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

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/g2g/reg2reg' \
--form 'pg_merchant_id=""' \
--form 'pg_order_id=""' \
--form 'pg_amount=""' \
--form 'pg_description=""' \
--form 'pg_order_time_limit=""' \
--form 'pg_user_id=""' \
--form 'pg_post_link=""' \
--form 'pg_card_token_to=""' \
--form 'pg_salt=""' \
--form 'pg_sig=""'

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>