Выплаты

В этом разделе описана механика, когда FreedomPay выплачивает деньги на банковскую карту пользователя.

Внимание!

Выплаты будут доступны для магазина только после разрешения личного менеджера и применения соответствующих настроек на стороне FreedomPay.

Выплаты не могут быть тестовыми. Тестирование производится только выплатой определенной суммы на боевую карту.

Выплаты по номеру карты

URL запроса
POST https://api.freedompay.kz/g2g/p2p2nonreg

Тестовый URL запроса
POST https://test-api.freedompay.kz/g2g/p2p2nonreg

Поля запроса

Название	Описание	Тип
pg_merchant_id required	Merchant ID в системе FreedomPay	string
pg_order_id required	ID заказа в системе мерчанта. Рекомендуется уникальное, монотонно возрастающее значение. Максимальная длина 50 символов Пример: 1234	string
pg_amount required	Сумма перевода. Пример:100	number
pg_payment_to required	Номер карты получателя. Пример: 4405645000006150	integer
pg_description required	Описание платежа. Пример: Описание платежа	string
pg_post_link required	Url на который отправляется ответ о статусе платежа. Пример: http://site.kz/post	string
pg_salt required	Случайная строка, состоящая из произвольных цифр и латинских букв. Пример: some random string	string
pg_sig required	Подпись запроса	string
pg_user_id	ID пользователя в системе мерчанта. Пример: 1234	string
pg_card_name	Имя держателя карты. Пример: Ivan Ivanov	string
pg_currency	Валюта. Пример: KZT	string
pg_idempotency_key	Ключ идемпотентности. Используется для защиты от создания дубликатов запросов. Уникальное значение в рамках мерчанта, нельзя использовать одинаковый ключ для разных типов операций	string

pg_merchant_id required;Merchant ID в системе FreedomPay;string pg_order_id required;ID заказа в системе мерчанта. Рекомендуется уникальное, монотонно возрастающее значение. Максимальная длина 50 символов Пример: 1234;string pg_amount required;Сумма перевода. Пример:100;number pg_payment_to required;Номер карты получателя. Пример: 4405645000006150;integer pg_description required;Описание платежа. Пример: Описание платежа;string pg_post_link required;Url на который отправляется ответ о статусе платежа. Пример: http://site.kz/post;string pg_salt required;Случайная строка, состоящая из произвольных цифр и латинских букв. Пример: some random string; string pg_sig required;Подпись запроса;string pg_user_id;ID пользователя в системе мерчанта. Пример: 1234;string pg_card_name;Имя держателя карты. Пример: Ivan Ivanov;string pg_currency;Валюта. Пример: KZT;string pg_idempotency_key;Ключ идемпотентности. Используется для защиты от создания дубликатов запросов. Уникальное значение в рамках мерчанта, нельзя использовать одинаковый ключ для разных типов операций;string

Параметры ответа

Название	Описание	Тип
pg_payment_id	Уникальный идентификатор платежной транзакции в Freedom pay. Служит ключом для всей дальнейшей работы с транзакцией	integer
pg_merchant_id	Идентификатор мерчанта в системе FreedomPay	integer
pg_order_id	Идентификатор заказа в системе мерчанта Максимальная длина 50 символов	string
pg_status	Показывает результат выполнения запроса	string
pg_balance	Баланс мерчанта в системе FreedomPay	number
pg_payment_amount	Сумма платежа	number
pg_payment_date	Дата и время проведения платежа	datetime
pg_salt	Случайная строка, состоящая из произвольных цифр и латинских букв	string
pg_sig	Подпись запроса	string
pg_datetime	Дата и время запроса	datetime

Post link запрос для мерчанта

После выплаты, будет вызван URL, указанный в pg_post_link

Сервер мерчанта должен ответить статусом 200

Post link на стороне мерчанта должен быть общедоступным, без авторизации.

URL запроса
POST {{post_link}}

Headers

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

Название	Описание	Тип
pg_status	Статус операции. Enum: ok, error	string
pg_merchant_id	ID мерчанта	string
pg_payment_id	ID транзакции в системе FreedomPay	integer
pg_order_id	ID заказа в системе мерчанта Максимальная длина 50 символов	string
pg_payment_status	Статус платежа. Enum: success, error, incomplete	string
pg_payment_amount	Сумма выплаты	string
pg_balance	Баланс после проведения платежа	string
pg_payment_date	Дата выплаты	string
pg_salt	Случайная строка, состоящая из произвольных цифр и латинских букв. Пример: some random string	string
pg_sig	Подпись запроса	string

На банковский счет (IBAN)

Выплата на банковский счет KZT

Для использования данных запросов Вам следует обратиться к своему менеджеру.

URL запроса
POST https://api.freedompay.kz/g2g/to_iban

Тестовый URL запроса
POST https://test-api.freedompay.kz/g2g/to_iban

Поля запроса

Название	Описание	Тип
pg_amount required	Сумма перевода. Пример: 10	number
pg_merchant_id required	Merchant ID в системе FreedomPay	integer
pg_order_id required	ID заказа в системе мерчанта. Рекомендуется уникальное, монотонно возрастающее значение. Максимальная длина 50 символов Пример: 1234	integer
pg_recipient_iban required	Номер счета IBAN Пример: KZ123412341234123412	string(20)
pg_recipient_iin required	ИИН получателя. Пример: 761223455678	integer(12)
pg_recipient_name required	Наименование получателя. Пример: ИВАНОВ ИВАН	string
pg_recipient_kbe required	КБе получателя. Пример: 19	integer(2)
	начинается =1	нет доп. параметров
	начинается =2	+доп поле pg_ben_country	например =RU
		+доп поле pg_ben_jurfl	=0 физ. лицо, =1 юр. лицо
pg_knp required	КНП получателя. Пример: 119	integer(3)
pg_bank_bik required	БИК получателя. Пример: KZZSAE	string(6)
pg_description	*Описание платежа. Пример: Описание платежа	string
pg_post_link required	Url на который отправляется ответ о статусе платежа. Пример: http://site.kz/post	string
pg_salt required	Случайная строка, состоящая из произвольных цифр и латинских букв. Пример: some random string	string
pg_sig required	Подпись запроса	string
pg_idempotency_key	Ключ идемпотентности. Используется для защиты от создания дубликатов запросов. Уникальное значение в рамках мерчанта, нельзя использовать одинаковый ключ для разных типов операций	string

pg_amount required;Сумма перевода. Пример: 10;number pg_merchant_id required;Merchant ID в системе FreedomPay;integer pg_order_id required;ID заказа в системе мерчанта. Рекомендуется уникальное, монотонно возрастающее значение. Максимальная длина 50 символов Пример: 1234;integer pg_recipient_iban required;Номер счета IBAN Пример: KZ123412341234123412;string(20) pg_recipient_iin required; ИИН получателя. Пример: 761223455678;integer(12) pg_recipient_name required;Наименование получателя. Пример: ИВАНОВ ИВАН;string pg_recipient_kbe required;КБе получателя. Пример: 19;integer(2) ;начинается =1;нет доп. параметров ;начинается =2;+доп поле pg_ben_country;например =RU ;;+доп поле pg_ben_jurfl;=0 физ. лицо,=1 юр. лицо pg_knp required;КНП получателя. Пример: 119;integer(3) pg_bank_bik required;БИК получателя. Пример: KZZSAE;string(6) pg_description;*Описание платежа. Пример: Описание платежа;string pg_post_link required;Url на который отправляется ответ о статусе платежа. Пример: http://site.kz/post;string pg_salt required;Случайная строка, состоящая из произвольных цифр и латинских букв. Пример: some random string;string pg_sig required;Подпись запроса;string pg_idempotency_key;Ключ идемпотентности. Используется для защиты от создания дубликатов запросов. Уникальное значение в рамках мерчанта, нельзя использовать одинаковый ключ для разных типов операций;string

Параметры ответа

Название	Описание	Тип
pg_payment_id	Уникальный идентификатор платежной транзакции в FreedomPay. Служит ключом для всей дальнейшей работы с транзакцией	integer
pg_merchant_id	Идентификатор мерчанта в системе FreedomPay.	integer
pg_status	Статус запроса	string
pg_order_id	Идентификатор заказа в системе мерчанта Максимальная длина 50 символов	string
pg_payment_amount	Сумма платежа	number
pg_payment_date	Дата и время проведения платежа	datetime
pg_salt	Случайная строка, состоящая из произвольных цифр и латинских букв	string
pg_sig	Подпись запроса	string
pg_datetime	Дата и время запроса	datetime

Post link запрос для мерчанта

Ответ на post_link от мерчанта

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

Сервер мерчанта должен ответить статусом 200

Post link на стороне мерчанта должен быть общедоступным, без авторизации.

URL запроса
POST {{post_link}}

Headers

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

Поля запроса

Название	Описание	Тип
pg_type	Тип транзакции	string
pg_payment_id	ID транзакции в системе FreedomPay	integer
pg_order_id	ID заказа в системе мерчанта Максимальная длина 50 символов	string
pg_status	Статус операции. Enum: ok, error	string
pg_salt	Случайная строка, состоящая из произвольных цифр и латинских букв. Пример: some random string	string
pg_sig	Подпись запроса	string

Статус выплаты

URL запроса
POST https://api.freedompay.kz/g2g/payout_status

Тестовый URL запроса
POST https://test-api.freedompay.kz/g2g/payout_status

Поля запроса

Название	Описание	Тип
pg_merchant_id required	Merchant ID в системе FreedomPay.	integer
pg_payment_id	ID транзакции в системе FreedomPay	integer
pg_salt required	Случайная строка, состоящая из произвольных цифр и латинских букв	string
pg_sig required	Цифровая подпись запроса	string
pg_order_id required	ID заказа в системе продавца. Максимальная длина 50 символов	integer

Параметры ответа

Если в ответ на проверку статуса платежа вы получаете payment_id = 0 в течение минуты, значит платежа не существует в нашей системе.

Параметры ответа на успешный запрос:

Название	Валидация	Описание
pg_payment_id	integer	id транзакции в системе FreedomPay
pg_merchant_id	integer	merchant_id в системе FreedomPay
pg_status	string	Enum: "success" "error" "process". Статус транзакции. Process - это исключительный вариант только в случае, когда банк некорректно ответил, и мы не финализировали статус перевода на своей стороне
pg_order_id	integer	Номер заказа Максимальная длина 50 символов
pg_amount	integer	Сумма перевода
pg_salt	string	Случайная строка, состоящая из произвольных цифр и латинских букв
pg_sig	string	Сигнатура
pg_datetime	datetime	Дата и время запроса

Статус выплаты v2

URL запроса
POST https://api.freedompay.kz/g2g/payout_status2

Тестовый URL запроса
POST https://test-api.freedompay.kz/g2g/payout_status2

Поля запроса

Название	Описание	Тип
pg_merchant_id required	Merchant ID в системе FreedomPay.	integer
pg_payment_id	ID транзакции в системе FreedomPay	integer
pg_salt required	Случайная строка, состоящая из произвольных цифр и латинских букв	string
pg_sig required	Цифровая подпись запроса	string
pg_order_id required	ID заказа в системе продавца. Максимальная длина 50 символов	integer

Параметры ответа

Если в ответ на проверку статуса платежа вы получаете payment_id = 0 в течение минуты, значит платежа не существует в нашей системе.

Параметры ответа на успешный запрос:

Название	Валидация	Описание
pg_payment_id	integer	id транзакции в системе FreedomPay
pg_merchant_id	integer	merchant_id в системе FreedomPay
pg_payment_status	string	Enum: "success" "error" "process". Статус транзакции. Process - это исключительный вариант только в случае, когда банк некорректно ответил, и мы не финализировали статус перевода на своей стороне
pg_status	string	Статус запроса
pg_order_id	integer	Номер заказа Максимальная длина 50 символов
pg_amount	integer	Сумма перевода
pg_salt	string	Случайная строка, состоящая из произвольных цифр и латинских букв
pg_sig	string	Сигнатура
pg_datetime	datetime	Дата и время запроса
pg_error_code	integer	ID кода ошибки
pg_error_description	string	Текстовое описание ошибки

Выплата на сохраненную карту

URL запроса
POST https://api.freedompay.kz/g2g/reg2reg

Поля запроса

Название	Описание	Тип
pg_amount required	Сумма перевода. Минимум 0.01 Пример: 10	number
pg_merchant_id required	Merchant ID в системе FreedomPay	integer
pg_order_id required	ID заказа в системе мерчанта. Рекомендуется уникальное, монотонно возрастающее значение. Максимальная длина 50 символов Пример: order_1234	string
pg_user_id required	ID пользователя в системе. Пример: 1234	integer
pg_card_token_to required	Token карты на которую нужно перевести деньги (возвращается при регистрации карты). Пример: c92741d9-ddd7-4bad-abd0-5594a79eea1a	string
pg_description required	Описание платежа. Пример: Описание платежа	string
pg_post_link required	Url на который отправляется ответ о статусе платежа. Пример: http://site.kz/post	string
pg_order_time_limit required	Лимит времени на проведение платежа. Пример: 2020-12-31 12:00:00	datetime
pg_salt required	Случайная строка, состоящая из произвольных цифр и латинских букв. Пример: some random string	string
pg_sig required	Подпись запроса	string

Параметры ответа

Название	Описание	Тип
pg_payment_id	Уникальный идентификатор платежной транзакции в FreedomPay. Служит ключом для всей дальнейшей работы с транзакцией	integer
pg_merchant_id	Идентификатор мерчанта в системе FreedomPay.	integer
pg_status	Статус запроса: Статус: — Описание: ok — Запрос завершен успешно, error — Запрос завершился с ошибкой, process — Финальный статус выплаты нужно	string
pg_order_id	Идентификатор заказа в системе мерчанта Максимальная длина 50 символов	string
pg_balance	Баланс мерчанта в системе FreedomPay	number
pg_card_hash	Карта, на которую был совершен платеж	string
pg_card_token	Идентификатор карты получателя	integer
pg_payment_amount	Сумма выплаты	number
pg_payment_date	Дата и время проведения выплаты	datetime
pg_error_code	Код ошибки	integer
pg_error_description	Описание ошибки	string
pg_salt	Случайная строка, состоящая из произвольных цифр и латинских букв	string
pg_sig	Подпись запроса	string

Получение баланса

URL запроса
POST https://api.freedompay.kz/g2g/balance_status

Поля запроса

Название	Описание	Тип
pg_merchant_id required	Merchant ID в системе FreedomPay.	integer
pg_currency	Валюта баланса. См. в разделе Справочник валют. Пример: KZT	string
pg_salt required	Случайная строка, состоящая из произвольных цифр и латинских букв. Пример: some random string	string
pg_sig required	Подпись запроса	string

Параметры ответа

Название	Описание	Тип
pg_balance	Баланс	number
pg_status	Статус запроса	string
pg_salt	Случайная строка, состоящая из произвольных цифр и латинских букв	string
pg_currency	Валюта баланса.	string
pg_sig	Подпись запроса	string