В этом разделе описана механика, когда FreedomPay выплачивает деньги на банковскую карту пользователя.
Внимание!
Выплаты будут доступны для магазина только после разрешения личного менеджера и применения соответствующих настроек на стороне FreedomPay.
Выплаты не могут быть тестовыми. Тестирование производится только выплатой определенной суммы на боевую карту.
Выплаты по номеру карты
URL запроса POST https://api.freedompay.kz/g2g/p2p2nonreg
Тестовый URL запроса POST https://test-api.freedompay.kz/g2g/p2p2nonreg
Поля запроса
Название;Описание;Тип;
pg_merchant_id <p style="color:#d63384">required</p>;Merchant ID в системе FreedomPay;string
pg_order_id <p style="color:#d63384">required</p>;ID заказа в системе мерчанта. <br>Рекомендуется уникальное, монотонно возрастающее значение.<br>Максимальная длина 50 символов<br><span style="font-size:14px">Пример: 1234</span>;string
pg_amount <p style="color:#d63384">required</p>;Сумма перевода.<br><span style="font-size:14px">Пример:100</span>;number
pg_payment_to <p style="color:#d63384">required</p>;Номер карты получателя.<br><span style="font-size:14px">Пример: 4405645000006150</span>;integer
pg_description <p style="color:#d63384">required</p>;Описание платежа.<br><span style="font-size:14px">Пример: Описание платежа</span>;string
pg_post_link <p style="color:#d63384">required</p>;Url на который отправляется ответ о статусе платежа.<br><span style="font-size:14px">Пример: http://site.kz/post</span>;string
pg_salt <p style="color:#d63384">required</p>;Случайная строка, состоящая из произвольных цифр и латинских букв.<br><span style="font-size:14px">Пример: some random string</span>; string
pg_sig <p style="color:#d63384">required</p>;Подпись запроса;string
pg_user_id;ID пользователя в системе мерчанта.<br><span style="font-size:14px">Пример: 1234</span>;string
pg_card_name;Имя держателя карты.<br><span style="font-size:14px">Пример: Ivan Ivanov</span>;string
pg_currency;Валюта.<br><span style="font-size:14px">Пример: KZT</span>;string
pg_idempotency_key;Ключ идемпотентности. Используется для защиты от создания дубликатов запросов. Уникальное значение в рамках мерчанта, нельзя использовать одинаковый ключ для разных типов операций;string
Параметры ответа
Название;Описание;Тип;
pg_payment_id;Уникальный идентификатор платежной транзакции в Freedom pay. Служит ключом для всей дальнейшей работы с транзакцией;integer
pg_merchant_id;Идентификатор мерчанта в системе FreedomPay;integer
pg_order_id;Идентификатор заказа в системе мерчанта <br>Максимальная длина 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;Статус операции. <br>Enum: <span style="color:#d63384">ok, error</span>;string
pg_merchant_id;ID мерчанта;string
pg_payment_id;ID транзакции в системе FreedomPay;integer
pg_order_id;ID заказа в системе мерчанта <br>Максимальная длина 50 символов;string
pg_payment_status;Статус платежа. <br>Enum: <span style="color:#d63384">success, error, incomplete</span>;string
pg_payment_amount;Сумма выплаты;string
pg_balance;Баланс после проведения платежа;string
pg_payment_date;Дата выплаты;string
pg_salt;Случайная строка, состоящая из произвольных цифр и латинских букв.<br><span style="font-size:14px">Пример: some random string</span>;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 <p style="color:#d63384">required</p>;Сумма перевода.<br><span style="font-size:14px">Пример: 10</span>;number
pg_merchant_id <p style="color:#d63384">required</p>;Merchant ID в системе FreedomPay;integer
pg_order_id <p style="color:#d63384">required</p>;ID заказа в системе мерчанта. <br>Рекомендуется уникальное, монотонно возрастающее значение.<br>Максимальная длина 50 символов<br><span style="font-size:14px">Пример: 1234</span>;integer
pg_recipient_iban <p style="color:#d63384">required</p>;Номер счета IBAN <br><span style="font-size:14px">Пример: KZ123412341234123412</span>;string(20)
pg_recipient_iin <p style="color:#d63384">required</p>; ИИН получателя.<br><span style="font-size:14px">Пример: 761223455678</span>;integer(12)
pg_recipient_name <p style="color:#d63384">required</p>;Наименование получателя.<br><span style="font-size:14px">Пример: ИВАНОВ ИВАН</span>;string
pg_recipient_kbe <p style="color:#d63384">required</p>;КБе получателя.<br><span style="font-size:14px">Пример: 19</span>;integer(2)
;начинается =1;нет доп. параметров
;начинается =2;+доп поле <p>pg_ben_country</p>;например =RU
;;+доп поле <p>pg_ben_jurfl</p>;=0 физ. лицо,<p>=1 юр. лицо</p>
pg_knp <p style="color:#d63384">required</p>;КНП получателя.<br><span style="font-size:14px">Пример: 119</span>;integer(3)
pg_bank_bik <p style="color:#d63384">required</p>;БИК получателя.<br><span style="font-size:14px">Пример: KZZSAE</span>;string(6)
pg_description;*Описание платежа.<br><span style="font-size:14px">Пример: Описание платежа</span>;string
pg_post_link <p style="color:#d63384">required</p>;Url на который отправляется ответ о статусе платежа.<br><span style="font-size:14px">Пример: http://site.kz/post</span>;string
pg_salt <p style="color:#d63384">required</p>;Случайная строка, состоящая из произвольных цифр и латинских букв.<br><span style="font-size:14px">Пример: some random string</span>;string
pg_sig <p style="color:#d63384">required</p>;Подпись запроса;string
pg_idempotency_key;Ключ идемпотентности. Используется для защиты от создания дубликатов запросов. Уникальное значение в рамках мерчанта, нельзя использовать одинаковый ключ для разных типов операций;string
Параметры ответа
Название;Описание;Тип;
pg_payment_id;Уникальный идентификатор платежной транзакции в FreedomPay. Служит ключом для всей дальнейшей работы с транзакцией;integer
pg_merchant_id;Идентификатор мерчанта в системе FreedomPay.;integer
pg_status;Статус запроса;string
pg_order_id;Идентификатор заказа в системе мерчанта <br>Максимальная длина 50 символов;string
pg_payment_amount;Сумма платежа;number
pg_payment_date;Дата и время проведения платежа;datetime
pg_salt;Случайная строка, состоящая из произвольных цифр и латинских букв;string
pg_sig;Подпись запроса;string
pg_datetime;Дата и время запроса;datetime
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 заказа в системе мерчанта <br>Максимальная длина 50 символов;string
pg_status;Статус операции. <br>Enum: <span style="color:#d63384">ok, error</span>;string
pg_salt;Случайная строка, состоящая из произвольных цифр и латинских букв. <span style="font-size:14px">Пример: some random string</span>;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 <p style="color:#d63384">required</p>;Merchant ID в системе FreedomPay.;integer
pg_payment_id;ID транзакции в системе FreedomPay;integer
pg_salt <p style="color:#d63384">required</p>;Случайная строка, состоящая из произвольных цифр и латинских букв;string
pg_sig <p style="color:#d63384">required</p>;Цифровая подпись запроса;string
pg_order_id <p style="color:#d63384">required</p>;ID заказа в системе продавца. <br>Максимальная длина 50 символов;integer
Параметры ответа
Если в ответ на проверку статуса платежа вы получаете payment_id = 0 в течение минуты, значит платежа не существует в нашей системе.
Параметры ответа на успешный запрос:
Название;Валидация;Описание;
pg_payment_id;integer;id транзакции в системе FreedomPay
pg_merchant_id; integer;merchant_id в системе FreedomPay
pg_status;string;Enum: <span style="color:#d63384">"success" "error" "process"</span>. <br>Статус транзакции. <br>Process - это исключительный вариант только в случае, когда банк некорректно ответил, и мы не финализировали статус перевода на своей стороне
pg_order_id;integer;Номер заказа <br>Максимальная длина 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 <p style="color:#d63384">required</p>;Merchant ID в системе FreedomPay.;integer
pg_payment_id;ID транзакции в системе FreedomPay;integer
pg_salt <p style="color:#d63384">required</p>;Случайная строка, состоящая из произвольных цифр и латинских букв;string
pg_sig <p style="color:#d63384">required</p>;Цифровая подпись запроса;string
pg_order_id <p style="color:#d63384">required</p>;ID заказа в системе продавца.<br>Максимальная длина 50 символов;integer
Параметры ответа
Если в ответ на проверку статуса платежа вы получаете payment_id = 0 в течение минуты, значит платежа не существует в нашей системе.
Параметры ответа на успешный запрос:
Название;Валидация;Описание;
pg_payment_id;integer;id транзакции в системе FreedomPay
pg_merchant_id; integer;merchant_id в системе FreedomPay
pg_payment_status;string;<span style="color:#d63384">Enum: "success" "error" "process"</span>. <br>Статус транзакции. <br>Process - это исключительный вариант только в случае, когда банк некорректно ответил, и мы не финализировали статус перевода на своей стороне
pg_status;string;Статус запроса
pg_order_id;integer;Номер заказа<br>Максимальная длина 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 <p style="color:#d63384">required</p>;Сумма перевода. Минимум 0.01<p style="font-size:14px">Пример: 10</p>;number
pg_merchant_id <p style="color:#d63384">required</p>;Merchant ID в системе FreedomPay;integer
pg_order_id<p style="color:#d63384">required</p>;ID заказа в системе мерчанта. <br>Рекомендуется уникальное, монотонно возрастающее значение. <br>Максимальная длина 50 символов<p style="font-size:14px">Пример: order_1234</p>;string
pg_user_id<p style="color:#d63384">required</p>;ID пользователя в системе.<p style="font-size:14px">Пример: 1234</p>;integer
pg_card_token_to<p style="color:#d63384">required</p>;Token карты на которую нужно перевести деньги (возвращается при регистрации карты).<p style="font-size:14px">Пример: c92741d9-ddd7-4bad-abd0-5594a79eea1a</p>;string
pg_description<p style="color:#d63384">required</p>;Описание платежа.<p style="font-size:14px">Пример: Описание платежа</p>;string
pg_post_link<p style="color:#d63384">required</p>;Url на который отправляется ответ о статусе платежа.<p style="font-size:14px">Пример: http://site.kz/post</p>;string
pg_order_time_limit<p style="color:#d63384">required</p>;Лимит времени на проведение платежа.<p style="font-size:14px">Пример: 2020-12-31 12:00:00</p>;datetime
pg_salt<p style="color:#d63384">required</p>;Случайная строка, состоящая из произвольных цифр и латинских букв.<p style="font-size:14px">Пример: some random string</p>;string
pg_sig<p style="color:#d63384">required</p>;Подпись запроса;string
Параметры ответа
Название;Описание;Тип;
pg_payment_id;Уникальный идентификатор платежной транзакции в FreedomPay. Служит ключом для всей дальнейшей работы с транзакцией;integer
pg_merchant_id;Идентификатор мерчанта в системе FreedomPay.;integer
pg_status;Статус запроса:<br>Статус: — Описание:<br>ok — Запрос завершен успешно,<br>error — Запрос завершился с ошибкой,<br>process — Финальный статус выплаты нужно;string
pg_order_id;Идентификатор заказа в системе мерчанта<br>Максимальная длина 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<p style="color:#d63384">required</p>;Merchant ID в системе FreedomPay.;integer
pg_currency;Валюта баланса. См. в разделе Справочник валют. <p style="font-size:14px">Пример: KZT</p>;string
pg_salt<p style="color:#d63384">required</p>;Случайная строка, состоящая из произвольных цифр и латинских букв. <p style="font-size:14px">Пример: some random string</p>;string
pg_sig<p style="color:#d63384">required</p>;Подпись запроса;string
Параметры ответа
Название;Описание;Тип;
pg_balance;Баланс;number
pg_status;Статус запроса;string
pg_salt;Случайная строка, состоящая из произвольных цифр и латинских букв;string
pg_currency;Валюта баланса.;string
pg_sig;Подпись запроса;string