Card - Freedom Pay

Request

Body Params multipart/form-data

pg_merchant_id

string

required

Merchant ID in the system

pg_order_id

integer

required

Order ID in the shop system. A unique

pg_amount

number

required

Payment amount. Minimum 0.01||number

pg_amount_to

number

optional

Transfer amount in the transfer currency.
Required if no pg_amount ||number

pg_currency_from

string

required

The debit currency in which the transfer amount is indicated. KZT

pg_currency_to

string

required

Currency of the transfer||string

pg_commission_amount

number

optional

Commission charged from the payer||number

pg_description

string

required

Payment description displayed to the buyer||string

pg_user_id

integer

optional

User ID in the merchant system
Required if pg_save_sender_card or
pg_save_recipient_card ||integer

pg_card_token

string

optional

Saved card token of the sender
Required if no pg_card_pan||string

pg_card_pan

integer

optional

Sender's card number
Required if no pg_card_token||integer

pg_card_cvc

integer

optional

CVC/CVV card password
Required if no pg_card_token||integer

pg_card_year

integer

optional

Card expiration year
Required if no pg_card_token||integer

pg_card_month

integer

optional

Card expiration month
Required if no pg_card_token||integer

pg_card_name

string

optional

Sender's cardholder name
Required if no pg_card_token||string

pg_card_recipient

integer

optional

Recipient's card number
Required if no pg_card_recipient_token||integer

pg_card_recipient_token

string

optional

Recipient's saved card token
Required if no pg_card_recipient||string

pg_card_recipient_name

string

optional

Recipient's cardholder name||string

pg_save_sender_card

string

optional

Sign of the need to save the card for sending money||string

pg_save_recipient_card

string

optional

Sign of the need to save the recipient's card||string

pg_language

string

optional

Error text language||string

pg_salt

string

required

Random string consisting of arbitrary numbers and Latin letters||string

pg_sig

string

required

Digital signature of the request||string

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/p2p/transfer' \
--form 'pg_merchant_id="";type=false' \
--form 'pg_order_id="";type=false' \
--form 'pg_amount="";type=false' \
--form 'pg_amount_to="";type=false' \
--form 'pg_currency_from="";type=false' \
--form 'pg_currency_to="";type=false' \
--form 'pg_commission_amount="";type=false' \
--form 'pg_description="";type=false' \
--form 'pg_user_id="";type=false' \
--form 'pg_card_token="";type=false' \
--form 'pg_card_pan="";type=false' \
--form 'pg_card_cvc="";type=false' \
--form 'pg_card_year="";type=false' \
--form 'pg_card_month="";type=false' \
--form 'pg_card_name="";type=false' \
--form 'pg_card_recipient="";type=false' \
--form 'pg_card_recipient_token="";type=false' \
--form 'pg_card_recipient_name="";type=false' \
--form 'pg_save_sender_card="";type=false' \
--form 'pg_save_recipient_card="";type=false' \
--form 'pg_language="";type=false' \
--form 'pg_salt="";type=false' \
--form 'pg_sig="";type=false'

Responses

🟢200Success

application/xml

Body

pg_payment_id

integer

required

pg_status

string

required

pg_payment_status

string

optional

pg_3ds

boolean

optional

pg_3d_acsurl

string

optional

pg_order_id

string

required

pg_payment_amount

number

required

pg_payout_amount

number

optional

pg_currency_from

string

optional

pg_currency_to

string

optional

pg_card_mask

string

required

Saved card mask

pg_card_token

string

optional

Saved card token

pg_card_recipient_token

string

optional

Saved recipient card token

pg_card_recipient_mask

string

optional

Recipient card mask

pg_payment_date

string

required

pg_datetime

string

required

pg_salt

string

required

pg_sig

string

required

Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <pg_payment_id>7777777777</pg_payment_id>
    <pg_status>ok</pg_status>
    <pg_payment_status>success</pg_payment_status>
    <pg_3ds>1</pg_3ds>
    <pg_3d_acsurl>https://bank-issuer-url.com/3ds-verify</pg_3d_acsurl>
    <pg_order_id>ORD12345</pg_order_id>
    <pg_payment_amount>1000.00</pg_payment_amount>
    <pg_payout_amount>950.00</pg_payout_amount>
    <pg_currency_from>KZT</pg_currency_from>
    <pg_currency_to>USD</pg_currency_to>
    <pg_card_token>abcd1234token</pg_card_token>
    <pg_card_recipient_token>xyz9876token</pg_card_recipient_token>
    <pg_card_mask>411111-XXXXXX-1111</pg_card_mask>
    <pg_card_recipient_mask>422222-XXXXXX-2222</pg_card_recipient_mask>
    <pg_payment_date>2024-09-02T12:19:01+00:00</pg_payment_date>
    <pg_salt>YtfwCGiBHsFLpYGk</pg_salt>
    <pg_sig>ccee466c01c2332d8a065d6108fd686b</pg_sig>
    <pg_datetime>2024-09-02T12:19:01+00:00</pg_datetime>
</response>

🟢200Process

🟢200Error

🟢200Invalid Signature