Gateway API | Payout

Freedom Pay Docs
Become a client
Personal area
RU

Freedom Docs

Introduction

Pay In

After payment

Payout

Payout by card number

To a bank account (IBAN)

Home
/
Gateway API - Payout

Payout

This section describes the mechanics when FreedomPay pays money to the user's bank card

Attention!
Payments will be available for the store only after the permission of the personal manager and the application of the appropriate settings on the FreedomPay side

Payments cannot be test. Testing is carried out only by paying a certain amount to a real card

Payout by card number

Request URL
POST https://api.freedompay.money/g2g/p2p2nonreg

Test Request URL
POST https://test-api.freedompay.money/g2g/p2p2nonreg

Request fields

Name;Description;Type;

pg_merchant_id required;Merchant ID in FreedomPay;string pg_order_id required;Order ID in the merchant system. A unique, monotonically increasing value is recommended. Example: 1234;string pg_amount required;Transfer amount. Minimum 0.01 Example:100;number pg_payment_to required;Recipient's card number. Example: 4405645000006150;integer pg_description required;Payment description Example: Payment description;string pg_post_link required;Url to which payment status response is sent Example: http://site.kz/post;string pg_salt required;A random string consisting of arbitrary numbers and Latin letters Example: some random string; string pg_sig required;Request signature;string pg_user_id; User ID in the merchant system Example: 1234;string pg_card_name;Name and surname of card holder Example: Ivan Ivanov;string pg_currency;Currency. Example: KZT;string

Response parameters

Title;Description;Type;

pg_payment_id;The unique identifier of the payment transaction in FreedomPay. Serves as a key for all further work with the transaction;integer pg_merchant_id;Merchant ID in the FreedomPay system.;integer pg_order_id;Order ID in the merchant system;string pg_status;Payment status;string pg_balance;Merchant's balance in the FreedomPay system;number pg_payment_amount;Payment amount;number pg_payment_date;Date and time of the payment;datetime pg_salt;Random string consisting of arbitrary numbers and Latin letters;string pg_sig;Request signature;string pg_datetime; Date and time of the request; datetime

To a bank account (IBAN)

Payout to bank account KZT
To use these requests, you should contact your manager.

Request URL
POST https://api.freedompay.money/g2g/to_iban

Test Request URL
POST https://test-api.freedompay.money/g2g/to_iban

Request fields

Name;Description;Type;

pg_amount required;Transfer amount. Minimum 0.01 Example: 10;number pg_merchant_id required;Merchant ID in FreedomPay;integer pg_order_id required;Order ID in the merchant system. A unique, monotonically increasing value is recommended. Example: 1234;integer pg_recipient_iban required;IBAN account number Example: KZ123412341234123412;string(20) pg_recipient_iin required; Recipient IIN Example: 761223455678;integer(12) pg_recipient_name required;Recipient name Example: IVANOV IVAN ;string pg_recipient_kbe required;Recipient kbe Example: 19;integer(2) pg_knp required;Receiver's KNP Example: 119 ;integer(3) pg_bank_bik required;Receiver's BIC Example: KZZSAE ;string(6) pg_description;*Payment description Example: Payment description ;string pg_post_link required;Url to which payment status response is sent Example: http://site.kz/post ;string pg_salt required;A random string consisting of arbitrary numbers and Latin letters Example: some random string;string pg_sig required;Request signature;string

Response parameters

Title;Description;Type;

pg_payment_id;The unique identifier of the payment transaction in FreedomPay. Serves as a key for all further work with the transaction;integer pg_merchant_id;Merchant ID in the FreedomPay system.;integer pg_status;Request Status;string pg_order_id;Order ID in the merchant system;string pg_payment_amount;Payment amount;number pg_payment_date;Date and time of the payment;datetime pg_salt;Random string consisting of arbitrary numbers and Latin letters;string pg_sig;Request signature;string pg_datetime;Date and time of the request;datetime

Post link request for merchant

Reply to post_link from merchant


<?xml version="1.0" encoding="UTF-8"?>
<pg_status>ok</pg_status>

Merchant server should respond with status 200

Post link on the merchant side must be public, without authorization.

Request URL
POST {{post_link}}

Headers

Content-Type;Value

Content-Type;application/x-www-form-urlencoded

Request fields

Name;Description;Type;

pg_type;Transaction type;string pg_payment_id;Transaction ID in the system FreedomPay.;integer pg_order_id;Order ID in the merchant system;string pg_status;The status of the operation. Enum:ok, error;string pg_salt;A random string consisting of arbitrary numbers and Latin letters. Example: some random string;string pg_sig;Request signature;string

Payment status

Request URL
POST https://api.freedompay.money/g2g/payout_status

Test Request URL
POST https://test-api.freedompay.money/g2g/payout_status

Request fields

Name;Description;Type;

pg_merchant_id required;Merchant ID in FreedomPay.;integer pg_payment_id;Transaction ID in the system FreedomPay.;integer pg_salt required;A random string consisting of arbitrary numbers and Latin letters;string pg_sig required;Digital signature of the request;string pg_order_id required;Order ID in the merchant system.;integer

Response parameters

Response parameters for a successful request:

Title;Validation;Description;

pg_payment_id;integer;transaction id in the system FreedomPay pg_merchant_id; integer;merchant_id on the FreedomPay system pg_status;string;Enum: "success" "error" "process". Transaction status. Process - this is an exceptional option only in the case when the bank answered incorrectly, and we did not finalize the status of the transfer on our side pg_order_id;integer;Order number pg_amount;integer;Transfer amount pg_salt;string;Random string consisting of arbitrary numbers and Latin letters pg_sig;string;Signature pg_datetime;datetime;Date and time of the request

Payment status v2

Request URL
POST https://api.freedompay.money/g2g/payout_status2

Test Request URL
POST https://test-api.freedompay.money/g2g/payout_status2

Request fields

Name;Description;Type;

Response parameters

Response parameters for a successful request:

Title;Validation;Description;

pg_payment_id;integer;transaction id in the system FreedomPay pg_merchant_id; integer;merchant_id on the FreedomPay system pg_payment_status;string;Enum: "success" "error" "process". Transaction status. Process - this is an exceptional option only in the case when the bank answered incorrectly, and we did not finalize the status of the transfer on our side pg_status;string;Request status pg_order_id;integer;Order number pg_amount;integer; Transfer amount pg_salt;string;Random string consisting of arbitrary numbers and Latin letters pg_sig;string;Signature pg_datetime;datetime;Date and time of the request

Payout to saved card

To use these requests, you should contact your manager.

Request URL

POST {{domain}}/g2g/reg2reg

Request fields

Name; Description; Type

pg_amountrequired;Transfer amount. Minimum 0.01Example: 10 ;number pg_merchant_idrequired;Merchant ID in {{project}}; integer pg_order_idrequired;Order ID in the merchant system. A unique, monotonically increasing value is recommended.Example: order_1234; string pg_user_idrequired;User ID in the system .Example: 1234; integer pg_card_token_torequired if no pg_card_id_to ;Token of the card to transfer money to (returned when registering the card).Example: c92741d9-ddd7-4bad-abd0-5594a79eea1a; string pg_descriptionrequired;Payment descriptionExample: Payment Description; string pg_post_linkrequired;Url to which payment status response is sentExample: http://site.kz/post; string pg_order_time_limitrequired;Time limit for making a payment.Example: 2020-12-31 12:00:00; datetime pg_saltrequired;A random string consisting of arbitrary numbers and Latin lettersExample: some random string;string pg_sigrequired;Request signature;string

Response parameters

Title ;Description; Type

pg_payment_id;The unique identifier of the payment transaction in {{project}}. Serves as a key for all further work with the transaction;integer pg_merchant_id;Merchant ID in the {{project}} system.;integer pg_status;Request status: Status: — Description: ok — Request completed successfully, error — Request completed with an error, process — Final payment status need;string pg_order_id; Order ID in the merchant system; string pg_balance; Merchant's balance in the {{project}} system; number pg_card_hash; The card to which the payment was made; string pg_card_token; Recipient's card ID; string pg_payment_amount; Payment amount; number pg_payment_date; Date and time of the payment ;datetime pg_error_code; Error code ;integer pg_error_description; Description of the error; string pg_salt; Random string consisting of arbitrary numbers and Latin letters; string pg_sig ;Request signature; string

Get balance

Example of a successful request

Request URL

POST {{domain}}/g2g/balance_status

Request fields

Name; Description; Type

pg_merchant_idrequired;Merchant ID in {{project}}. ;integer pg_currency; Balance currency See section Currencies directoryExample: KZT; string pg_saltrequired;A random string consisting of arbitrary numbers and Latin lettersExample: some random string; string pg_sigrequired;Request signature; string

Response parameters

Title ;Description; Type

pg_balance; Balance; number pg_status; Request Status; string pg_currency; Balance currency; string pg_salt; Random string consisting of arbitrary numbers and Latin letters; string pg_sig; Request signature; string