Gateway API | Money transfer

Money transfer

Money transfer is a payment type which uses one request to initiate debiting funds from the sender's card and subsequently crediting these funds to the recipient's card.

Restrictions and special aspects:

In case of unsuccessful payment, the refund occurs automatically
You can use previously saved cards to make a transfer

Making a transfer

Request URL
POST https://api.freedompay.kg/g2g/p2p/transfer

Test Request URL
POST https://test-api.freedompay.kg/g2g/p2p/transfer

Request fields

pg_merchant_id required;Merchant ID.Numbers;integer pg_order_id required;Order ID in the shop system. A unique,monotonically increasing value is recommended. Numbers and Latin characters Example:123;string pg_amount required;Payment amount. Minimum 0.01 Example:: 10;number pg_amount_to required if no pg_amount;Transfer amount in the transfer currency. Minimum 0.01 Example: 10;number pg_currency_from required;The debit currency in which the transfer amount is indicated. KZT, USD, EUR. Currencies Directory link="https://customer.freedompay.kg/dev/currency;string pg_currency_to required;Currency of the transfer. In the case when the currency of debiting and crediting is different, a recalculation is made. The current rate can be obtained by the method link=https://freedompay.money/docs-en/gateway-api/transfer;string pg_commission_amount;Commission charged from the payer in the debit currency. Minimum 0;number pg_description required;Payment description. Displayed to the buyer during the payment process. Passed in pg_encoding. Letters, numbers, dash (-), space Example: Payment description;string pg_user_id required if pg_save_sender_card orpg_save_recipient_card;User ID in the merchant system Example:1234;integer pg_card_token required if no pg_card_pan;Saved card token of the sender;string pg_card_pan required if no pg_card_token;Card number. Example: 4405645000006150; integer pg_card_cvc required if no pg_card_token;CVC/CVC2/CVV card password Example: 653;integer pg_card_year required if no pg_card_token;Card expiration year. Example: 25; integer pg_card_month required if no pg_card_token;Card expiration month. Example: 09;integer pg_card_name required if no pg_card_token;Sender's cardholder name. Example: IVAN IVANOV;string pg_card_recipient required if no pg_card_recipient_token;Recipient's card number. Example: 4405645000006150;integer pg_card_recipient_token required if no pg_card_recipient;Recipient's saved card token; string pg_card_recipient_name;Recipient's cardholder name If not given, then the sender's name from the pg_card_name parameter is used as the recipient’s name Example: IVAN IVANOV;string pg_save_sender_card;Sign of the need to save the card for sending money. Example: 1;string pg_save_recipient_card; Sign of the need to save the cash receipt card. Example: 1;string pg_language;Error text language. Available languages: ru, en, kz, kg, uz, de ;string pg_salt required;Random string. Random numbers and Latin letters Example: some random string;string pg_sig required;Digital signature of the request;string

Response parameters

Additionally.

Special token: 2d0b504c-b95d-4cf6-b782-5a7d13ab2c85, used to indicate which part of the transfer not to carry out.

If a special token is passed in the pg_card_token parameter and passed to pg_card_recipient, then only the payment will be made. In this case, one of the parameters pg_card_name or pg_card_recipient_name is required.
If a special token is passed in the pg_card_token parameter and pg_card_recipient_token is passed, then only the payment will be made.
If a special token is passed in the pg_card_recipient_token parameter, then only reception will be carried out.

Note. If 3ds is installed on the card, a request must be made to the ACS server of the card issuer's bank.

On this page the client enters his 3ds password.

The server url can be obtained from the pg_3d_acsurl parameter.

Request parameters to the ACS server of the issuer's bank:

Making a transfer with 3DSecure

Making a payment with 3DSecure after receiving data from the ACS server

Request URL
POST https://api.freedompay.kg/g2g/p2p/transfer_acs

Test Request URL
POST https://test-api.freedompay.kg/g2g/p2p/transfer_acs

Request fields

Response parameters

Response parameters for a successful request:

In case of errors, there will be additional response parameters:

Getting the transfer status

Request URL
POST https://api.freedompay.kg/g2g/p2p/status

Test Request URL
POST https://test-api.freedompay.kg/g2g/p2p/status

Request fields

Response parameters

Getting rates

Request URL
POST https://api.freedompay.kg/g2g/p2p/rates

Test Request URL
POST https://test-api.freedompay.kg/g2g/p2p/rates

Request fields

Response parameters

In case of errors, there will be additional response parameters:

Test cards

Test cards for transfer charges

Test cards for enrolling a transfer