Приватний
Переказ коштів з рахунку на картку
Переказ грошових коштів з рахунку компанії будь-якій кількості одержувачів на картку, рахунок
Що таке виплата?
Переказ грошових коштів з рахунку компанії на реквізити отримувача. Ви можете проводити як масові так і потранзакційні виплати.
Можливості
Переказ коштів з рахунку компанії на будь-які з доступних реквізитів одержувача:
- на картку - виплата на картку одержувача будь-якого українського банку,
- по токену - виплата на картку одержувача по токену,
- на розрахунковий рахунок - виплата за реквізитами розрахункового рахунку всередині України.
Робити масові виплати використовуючи Бізнес кабінет LiqPay.
Як працює API потранзакційні виплати
- Для зарахування коштів клієнту, компанія відправляє запит з необхідним набором обов'язкових параметрів, згідно документації.
- LiqPay проводить відшкодування на зазначені реквізити отримувача:- якщо Ви передали в запиті номер картки, токен картки або реквізити розрахункового рахунку клієнта - LiqPay автоматично проводить транзакцію зарахування коштів.- якщо Ви передали в запиті тільки номер телефону клієнта або email - LiqPay відправляє повідомлення на email/телефон про необхідність прив'язати платіжну картку клієнта в персональному кабінеті LiqPay. Клієнт може прив'язати картку протягом 7 днів - по закінченню терміну виплата скасовується.
- LiqPay повертає статус виплати по кожній транзакції на server-url компанії.
Як працює API масові виплати
- Ви поповнюєте технічний рахунок у банку, відкритий під проект, на суму виплат.
- Формуєте реєстр одержувачів виплат згідно шаблону, в якому вказуєте реквізити одержувачів і суми виплат.
- Після успішного завантаження реєстру, у разі якщо є помилки в заповненому форматі, у вас є можливість їх виправити, про що буде сигналізувати список рядків, в яких є розбіжності з стандартним форматом.
- Після запуску виплат, який ініціюється з боку компанії, LiqPay в режимі online процесує виплати за реквізитами одержувачів згідно реєстру.
- Статус виплат і можливість повторного проведення неуспішних доступний в кабінеті Бізнес.
Які компанії можуть підключити API виплат
- компанії, які надають фінансові послуги клієнта, при наявності відповідного дозволу, згідно законодавства України.
- фінансові компанії, зареєстровані в НБУ.
- міжнародні сервіси, які здійснюють діяльність в Україні.
Буде корисно компаніям, які виконують такі виплати:
- Онлайн-кредитування,
- Здійснення миттєвих повернень коштів клієнтам, які здійснювали покупку післяплатою (або іншими методами оплати що не підтримують повернення онлайн).
Для отримання доступу до API необхідно:
- Надіслати запит на підключення.
- Укласти договір/погодитися з офертою на проведення виплат з розрахункового рахунку.
- Відкрити розрахунковий рахунок у ПриватБанку, при його відсутності на момент підключення.
- З боку Банку менеджер відкриває технічний рахунок для моментального проведення виплат (2-3 робочих дні).
- Налаштувати виплати згідно з документацією.
- Запуск проекту.
Відправити запит
Підключення
1
Server-Server
Потранзакційні виплати згідно API виплат.
2
Client-Server
Масові виплати в Бізнес кабінеті LiqPay.
Методи інтеграції
Самостійна інтеграція згідно з документацією
Є питання?
Звертайтесь до нашого технічного відділу на пошту:
liqpay.support@privatbank.ua
Переказ з рахунку магазину на карту Mastercard/Visa або номер рахунку будь-якого українського банку, а також на токен картки одержувача.
Результатом виконання запиту є переказ грошових коштів з рахунку магазину на карту одержувача.
Схема роботи API виплати

Необхідні URL для роботи в залежності від обраної моделі:
- https://www.liqpay.ua/api/request — Server-Server;
- https://www.liqpay.ua/api/3/checkout — Client-Server;
Для виклику API LiqPay необхідно передати параметри data і signature (Server - Server) POST методом або перенаправити клієнта (Client-Server) використовуючи POST метод, де:
data
- json рядок з параметрами APIs закодована функцією base64, base64_encode( json_string ),
signature
- унікальний підпис кожного запиту base64_encode( sha3-256( private_key + data + private_key) ),
base64_encode
- повертає рядок, закодований методом base64,
sha3-256
- повертає хеш у вигляді бінарного рядку з 32 байт (64 символи).
Формування data і signature, приклад:
Для підключення прийому оплати через LiqPay, формуємо json рядок з параметрами виклику апі, де:
| Parameter | Required | Type | Description | |
|---|---|---|---|---|
| version | Required | Number | Версія API. Наприклад: 7 | |
| public_key | Required | String | Публічний ключ - ідентифікатор створеної компанії. Наприклад: i00000000 | |
| private_key | Required | String | Приватний ключ створеної компанії (не надається нікому крім Вашого розробника). Наприклад: a4825234f4bae72a0be04eafe9e8e2bada209255 | |
| action | Required | String | Тип операції. Можливі значення: pay - платіж, hold - блокування коштів на рахунку відправника, subscribe - регулярний платіж, paydonate - пожертва, auth - предавторізація картки | |
| amount | Required | Number | Сума платежу. Наприклад: 5, 7.34 | |
| currency | Required | String | Валюта платежу. Можливі значення:USD, EUR, UAH. Додаткові валюти можуть бути встановлені за запитом компанії | |
| description | Required | String | Призначення платежу | |
| order_id | Required | String | Унікальний ID покупки у Вашому магазині. Максимальна довжина 255 символів |
Більше параметрів в документації
Приклад створення json_string:
json_string =
{"public_key":"i00000000","version":7,"action":"pay","amount":"3","currency":"UAH","description":"test","order_id":"000001"}Приклад кодування json_string функцією base64_encode, компанія отримує data:
data = eyJwdWJsaWNfa2V5IjoiaTAwMDAwMDAwIiwidmVyc2lvbiI6NywiYWN0aW9uIjoicGF5IiwiYW1vdW50IjoiMyIsImN1cnJlbmN5IjoiVUFIIiwiZGVzY3JpcHRpb24iOiJ0ZXN0Iiwib3JkZXJfaWQiOiIwMDAwMDEifQ==
Приклад формування signature, компанія формує рядок sign_string шляхом конкатенації private_key + data + private_key:
sign_string = a4825234f4bae72a0be04eafe9e8e2bada209255eyJwdWJsaWNfa2V5IjoiaTAwMDAwMDAwIiwidmVyc2lvbiI6NywiYWN0aW9uIjoicGF5IiwiYW1vdW50IjoiMyIsImN1cnJlbmN5IjoiVUFIIiwiZGVzY3JpcHRpb24iOiJ0ZXN0Iiwib3JkZXJfaWQiOiIwMDAwMDEifQ==a4825234f4bae72a0be04eafe9e8e2bada209255
Після застосування функцій base64_encode( sha3-256( sign_string) ) отримуємо рядок:
signature = 0adgJ8F2Ds5HCVkcz4AlmdLMRoIJf7IxsL3QmeFRz/s=
Приклад відправки запиту до LiqPay:
1.Для перенаправлення клієнта на сторінку оплати LiqPay (Client - Server) необхідно сформувати HTML-форму:
<form method="POST" action="https://www.liqpay.ua/api/3/checkout" accept-charset="utf-8">
<input type="hidden" name="data"
value="eyJwdWJsaWNfa2V5IjoiaTAwMDAwMDAwIiwidmVyc2lvbiI6NywiYWN0aW9uIjoicGF5IiwiYW1vdW50IjoiMyIsImN1cnJlbmN5IjoiVUFIIiwiZGVzY3JpcHRpb24iOiJ0ZXN0Iiwib3JkZXJfaWQiOiIwMDAwMDEifQ=="/>
<input type="hidden" name="signature" value="0adgJ8F2Ds5HCVkcz4AlmdLMRoIJf7IxsL3QmeFRz/s="/><input
type="image" src="//static.liqpay.ua/buttons/payUk.png"/></form>
<input type="hidden" name="data"
value="eyJwdWJsaWNfa2V5IjoiaTAwMDAwMDAwIiwidmVyc2lvbiI6NywiYWN0aW9uIjoicGF5IiwiYW1vdW50IjoiMyIsImN1cnJlbmN5IjoiVUFIIiwiZGVzY3JpcHRpb24iOiJ0ZXN0Iiwib3JkZXJfaWQiOiIwMDAwMDEifQ=="/>
<input type="hidden" name="signature" value="0adgJ8F2Ds5HCVkcz4AlmdLMRoIJf7IxsL3QmeFRz/s="/><input
type="image" src="//static.liqpay.ua/buttons/payUk.png"/></form>
2.Для взаємодії (Server - Server) отримані data і signature необхідно відправити на url https://www.liqpay.ua/api/request:
curl --silent -XPOST https://www.liqpay.ua/api/request --data-
urlencodedata="eyJwdWJsaWNfa2V5IjoiaTAwMDAwMDAwIiwidmVyc2lvbiI6NywiYWN0aW9uIjoicGF5IiwiYW1vdW50IjoiMyIsImN1cnJlbmN5IjoiVUFIIiwiZGVzY3JpcHRpb24iOiJ0ZXN0Iiwib3JkZXJfaWQiOiIwMDAwMDEifQ=="/>
--data-urlencode
signature="0adgJ8F2Ds5HCVkcz4AlmdLMRoIJf7IxsL3QmeFRz/s="
urlencodedata="eyJwdWJsaWNfa2V5IjoiaTAwMDAwMDAwIiwidmVyc2lvbiI6NywiYWN0aW9uIjoicGF5IiwiYW1vdW50IjoiMyIsImN1cnJlbmN5IjoiVUFIIiwiZGVzY3JpcHRpb24iOiJ0ZXN0Iiwib3JkZXJfaWQiOiIwMDAwMDEifQ=="/>
--data-urlencode
signature="0adgJ8F2Ds5HCVkcz4AlmdLMRoIJf7IxsL3QmeFRz/s="
3.Статус операції буде відправлений на server_url
4.Успішне завершення оплати
Приклад використання SDK:
#!/bin/bash
PUBLIC_KEY='your_public_key'
PRIVATE_KEY='your_private_key'
API_URL='https://www.liqpay.ua/api/request'
JSON="{
\"action\" : \"p2pcredit\",
\"version\" : 3,
\"public_key\" : \"${PUBLIC_KEY}\",
\"amount\" : 1,
\"currency\" : \"USD\",
\"description\" : \"description text\",
\"order_id\" : \"order_id_1\",
\"receiver_card\" : \"4731195301524633\"
}"
# DATA is base64_encode result from JSON string
DATA=$(echo -n ${JSON} | base64)
# SIGNATURE is base64 encode result from sha1 binary hash from concatenate string ${PRIVATE_KEY}${DATA}${PRIVATE_KEY}
SIGNATURE=$(echo -n "${PRIVATE_KEY}${DATA}${PRIVATE_KEY}" | openssl dgst -binary -sha1 | base64)
# REQ is json response from liqpay
REQ=$(curl --silent -XPOST ${API_URL} --data-urlencode data="${DATA}" --data-urlencode signature="${SIGNATURE}")
echo "Result: ${REQ}"
$liqpay = new LiqPay($public_key, $private_key);
$res = $liqpay->api("request", array(
'action' => 'p2pcredit',
'version' => '3',
'amount' => '1',
'currency' => 'USD',
'description' => 'description text',
'order_id' => 'order_id_1',
'receiver_card' => '4731195301524633',
'receiver_last_name' => 'LastName',
'receiver_first_name' => 'FirstName'
));
HashMap<String, String> params = new HashMap<String, String>();
params.put("action", "p2pcredit");
params.put("version", "3");
params.put("amount", "1");
params.put("currency", "USD");
params.put("description", "description text");
params.put("order_id", "order_id_1");
params.put("receiver_card", "4731195301524633");
params.put("receiver_last_name", "LastName");
params.put("receiver_first_name", "FirstName");
LiqPay liqpay = new LiqPay(PUBLIC_KEY, PRIVATE_KEY);
HashMap<String, Object> res = liqpay.api("request", params);
System.out.println(res.get("status"));
from liqpay import LiqPay
liqpay = LiqPay(public_key, private_key)
res = liqpay.api("request", {
"action" : "p2pcredit",
"version" : "3",
"amount" : "1",
"currency" : "USD",
"description" : "description text",
"order_id" : "order_id_1",
"receiver_card" : "4731195301524633",
"receiver_last_name" : "LastName",
"receiver_first_name" : "FirstName"
})
liqpay = Liqpay::Liqpay.new(
:public_key => 'public_key',
:private_key => 'private_key'
)
res = liqpay.api("request", {
:action => "p2pcredit",
:version => "3",
:amount => "1",
:currency => "USD",
:description => "description text",
:order_id => "order_id_1",
:receiver_card => "4731195301524633",
:receiver_last_name => "LastName",
:receiver_first_name => "FirstName"
})
LiqPay = liqpay:init(PublicKey, PrivateKey),
Res = liqpay:api("request", [
{<<"action">>, <<"p2pcredit">>},
{<<"version">>, <<"3">>},
{<<"amount">>, <<"1">>},
{<<"currency">>, <<"USD">>},
{<<"description">>, <<"description text">>},
{<<"order_id">>, <<"order_id_1">>},
{<<"receiver_card">>, <<"4731195301524633">>},
{<<"receiver_last_name">>, <<"LastName">>},
{<<"receiver_first_name">>, <<"FirstName">>}
], LiqPay)
var LiqPay = require('liqpay');
var liqpay = new LiqPay(public_key, private_key);
liqpay.api("request", {
"action" : "p2pcredit",
"version" : "3",
"amount" : "1",
"currency" : "USD",
"description" : "description text",
"order_id" : "order_id_1",
"receiver_card" : "4731195301524633",
"receiver_last_name" : "LastName",
"receiver_first_name" : "FirstName"
}, function( json ){
console.log( json.status );
});
my $liqpay = Liqpay->new($public_key,$private_key);
my $res = $liqpay->api("request",
{
'action' => 'p2pcredit',
'version' => '3',
'amount' => '1',
'currency' => 'USD',
'description' => 'description text',
'order_id' => 'order_id_1',
'receiver_card' => '4731195301524633',
'receiver_last_name' => 'LastName',
'receiver_first_name' => 'FirstName'
}
);
var c = liqpay.New("my_public_key", "my_private_key", nil)
// Creating the request map with all necessary parameters
request:=map[string]interface{}{
"action": "p2pcredit",
"version": 3,
"public_key": "my_public_key",
"amount": 1,
"currency": "UAH",
"description": "Test payment",
"order_id": "order_id_1",
"receiver_card": "4731195301524633",
}
resp, err := c.Send("request", request)
if err != nil {
fmt.Printf("error %v", err.Error())
return
}
fmt.Printf("response: %#v", resp)
Параметри для формування data:
Основні
| Parameter | Required | Type | Description | |
|---|---|---|---|---|
| version | Required | Number | Версія API. Поточне значення - 7 | |
| public_key | Required | String | Публічний ключ - ідентифікатор магазину. Отримати ключ можна в налаштуваннях магазину | |
| action | Required | String | p2pcredit | |
| amount | Required | Number | Сума платежу. Наприклад: 5, 7.34 | |
| currency | Required | String | Валюта платежу. Можливі значення: USD, EUR, UAH | |
| description | Required | String | Призначення платежу | |
| ip | Required | String | IP клієнта | |
| order_id | Required | String | Унікальний ID покупки у Вашому магазині. Максимальна довжина 255 символів | |
| language | Optional | String | Мова клієнта uk, en | |
| server_url | Optional | String | URL API в Вашому магазині для повідомлень про зміну статусу платежу (сервер -> сервер). Максимальна довжина 510 символів. Детальніше | |
| taxed | Optional | String | Ознака сплати податків з платежу. Допустимі значення: Дохід не підлягає оподаткуванню |
Параметри для переказу на розрахунковий рахунок:
| Parameter | Required | Type | Description | |
|---|---|---|---|---|
| receiver_account | Required | String | Номер рахунку отримувача. | |
| receiver_mfo | Required | String | МФО рахунку одержувача. | |
| receiver_okpo | Required | String | ОКПО рахунку одержувача. | |
| receiver_company | Required | String | Найменування розрахункового рахунку отримувача. |
Параметри для переказу на картку:
| Parameter | Required | Type | Description | |
|---|---|---|---|---|
| receiver_card | Required | String | Номер картки одержувача. |
Параметри для переказу на токен картки:
| Parameter | Required | Type | Description | |
|---|---|---|---|---|
| receiver_card_token | Required | String | Токен картки одержувача. Наприклад: B5BВB0D00B88B00ED00A00D0D. |
Параметри відправника:
| Parameter | Required | Type | Description | |
|---|---|---|---|---|
| sender_first_name | Optional | String | Ім'я відправника | |
| sender_last_name | Optional | String | Прізвище відправника | |
| sender_country_code | Optional | String | Код країни відправника. Цифровий ISO 3166-1 код | |
| sender_city | Optional | String | Місто відправника | |
| sender_address | Optional | String | Адреса відправника | |
| sender_postal_code | Optional | String | Поштовий індекс відправника |
Параметри по одержувачу:
| Parameter | Required | Type | Description | |
|---|---|---|---|---|
| receiver_first_name | Optional | String | Ім'я одержувача. | |
| receiver_last_name | Optional | String | Прізвище одержувача. |
Інші параметри:
| Parameter | Required | Type | Description | |
|---|---|---|---|---|
| customer | Optional | String | Унікальний ідентифікатор користувача на сайті мерчанта. Максимальна довжина 100 символів | |
| info | Optional | String | Інформація для додавання даних до платежу. Наприклад: «External information for payments» |
Параметри відповіді:
| Parameter | Type | Description | |
|---|---|---|---|
| acq_id | Number | ID еквайера | |
| action | String | Тип операції. Можливі значення: pay - платіж, hold - блокування коштів на рахунку відправника, paysplit - розщеплення платежу, subscribe - створення регулярного платежу, paydonate - пожертвування, auth - предавторизація картки, regular - регулярний платіж | |
| agent_commission | Number | Комісія агента в валюті платежу | |
| amount | Number | Сума платежу | |
| amount_bonus | Number | Бонус відправника у валюті платежу debit | |
| amount_credit | Number | Сума транзакції credit в валюті currency_credit | |
| amount_debit | Number | Сума транзакції debit у валюті currency_debit | |
| commission_credit | Number | Комісія з одержувача у валюті currency_credit | |
| commission_debit | Number | Комісія з відправника у валюті currency_debit | |
| create_date | String | Дата створення платежу | |
| currency | String | Валюта платежу | |
| currency_credit | String | Валюта транзакції credit | |
| currency_debit | String | Валюта транзакції debit | |
| description | String | Коментар до платежу | |
| end_date | String | Дата завершення/зміни платежу | |
| is_3ds | Boolean | Можливі значення: true - транзакція пройшла з 3DS перевіркою, false - транзакція пройшла без 3DS перевірки | |
| liqpay_order_id | String | Order_id платежу в системі LiqPay | |
| mpi_eci | Number | Можливі значення: 5 - транзакція пройшла з 3DS (емітент і еквайєр підтримують технологію 3D-Secure), 6 - емітент картки платника не підтримує технологію 3D-Secure, 7 - операція пройшла без 3D-Secure | |
| order_id | String | Order_id платежу | |
| payment_id | Number | Id платежу в системі LiqPay | |
| public_key | String | Публічний ключ магазину | |
| receiver_commission | Number | Комісія з одержувача у валюті платежу | |
| redirect_to | String | Посилання на яке необхідно перенаправляти клієнта для проходження 3DS верифікації | |
| sender_bonus | Number | Бонус відправника у валюті платежу | |
| sender_commission | Number | Комісія з відправника у валюті платежу | |
| status | String | Статус платежу. Можливі значення: Кінцеві статуси платежу error - Неуспішний платіж. Некоректно заповнені дані failure - Неуспішний платіж success - Успішний платіж | |
| transaction_id | Number | Id транзакції в системі LiqPay | |
| result | String | Результат виконання запиту ok, error | |
| type | String | Тип платежу | |
| version | Number | Версія API. Поточне значення - 7 |
Приклад відповіді:
{
"action": "p2pcredit",
"payment_id": 165189,
"status": "success",
"version": 7,
"result": "ok",
"type": "p2pcredit",
"public_key": "i000000000",
"acq_id": 414963,
"order_id": "98R1U1OV1485849059893399",
"liqpay_order_id": "NYMK3AE61501685438251925",
"description": "description text",
"amount": 0.1,
"currency": "UAH",
"sender_commission": 0.0,
"receiver_commission": 0.0,
"agent_commission": 0.0,
"amount_debit": 0.1,
"amount_credit": 0.1,
"commission_debit": 0.0,
"commission_credit": 0.0,
"currency_debit": "UAH",
"currency_credit": "UAH",
"sender_bonus": 0.0,
"amount_bonus": 0.0,
"mpi_eci": "7",
"is_3ds": false,
"create_date": 1501687336377,
"end_date": 1501687336377,
"transaction_id": 165189
}