Публічний
ОТП підтвердження
Підтвердження операції за допомогою одноразового пароля на номер телефону клієнта
Що таке підтвердження з ОТП?
Підтвердження оплати на Вашому сайті за технологією одноразового пароля на номер телефону клієнта. Ви отримуєте статус otp_verify у відповіді від LiqPay, згідно з яким LiqPay відправив на номер телефону клієнта ОТП. Ви запитуєте у клієнта пароль і передаєте в запиті на APi LiqPay.
Як працює підтвердження з ОТП
- Клієнт оплачує товар або послугу на Вашому сайті.
- Ви відправляєте запит на списання з картки клієнта по одному з APIs LiqPay.
- У відповідь від API LiqPay повертає на Ваш сервер статус otp_verify - тобто необхідно підтвердження ОТП паролем для завершення оплати.
- LiqPay відправляє на номер телефону клієнта одноразовий пароль у форматі ХХ-ХХ-ХХ-ХХ.
- Ви запитуєте у клієнта на сторінці сайту пароль і направляєте його в запиті на API LiqPay.
- LiqPay повертає статус транзакції на server-url компанії.
У яких API використовується статус otp_verify:
Є питання?
Звертайтесь до нашого технічного відділу на пошту:
liqpay.support@privatbank.ua
Схема роботи 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\" : \"confirm\",
\"version\" : 3,
\"public_key\" : \"${PUBLIC_KEY}\",
\"confirm_token\" : \"JmV2qDgC3LotB8njGDcEYjHFpmpAZR\",
\"otp\" : \"12345678\"
}"
# 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' => 'confirm',
'version' => '3',
'confirm_token' => 'JmV2qDgC3LotB8njGDcEYjHFpmpAZR',
'otp' => '12345678'
));
HashMap<String, String> params = new HashMap<String, String>();
params.put("action", "confirm");
params.put("version", "3");
params.put("confirm_token", "JmV2qDgC3LotB8njGDcEYjHFpmpAZR");
params.put("otp", "12345678");
LiqPay liqpay = new LiqPay(PUBLIC_KEY, PRIVATE_KEY);
HashMap<String, Object> res = liqpay.api("request", params);
System.out.println(res.get("status"));
liqpay = LiqPay(public_key, private_key)
res = liqpay.api("request", {
"action" : "confirm",
"version" : "3",
"confirm_token" : "JmV2qDgC3LotB8njGDcEYjHFpmpAZR",
"otp" : "12345678"
})
liqpay = Liqpay::Liqpay.new(
:public_key => 'public_key',
:private_key => 'private_key'
)
res = liqpay.api("request", {
:action => "confirm",
:version => "3",
:confirm_token => "JmV2qDgC3LotB8njGDcEYjHFpmpAZR",
:otp => "12345678"
})
LiqPay = liqpay:init(PublicKey, PrivateKey),
Res = liqpay:api("request", [
{<<"action">>, <<"confirm">>},
{<<"version">>, <<"3">>},
{<<"confirm_token">>, <<"JmV2qDgC3LotB8njGDcEYjHFpmpAZR">>},
{<<"otp">>, <<"12345678">>},
], LiqPay)
var LiqPay = require('liqpay');
var liqpay = new LiqPay(public_key, private_key);
liqpay.api("request", {
"action" : "confirm",
"version" : "3",
"confirm_token" : "JmV2qDgC3LotB8njGDcEYjHFpmpAZR",
"otp" : "12345678"
}, function( json ){
console.log( json.status );
});
my $liqpay = Liqpay->new($public_key,$private_key);
my $res = $liqpay->api("request",
{
'action' => 'confirm',
'version' => '3',
'confirm_token' => 'JmV2qDgC3LotB8njGDcEYjHFpmpAZR',
'otp' => '12345678'
}
);
var c = liqpay.New("my_public_key", "my_private_key", nil)
// Creating the request map with all necessary parameters
request:=map[string]interface{}{
"action": "confirm",
"version": 3,
"public_key": "my_public_key",
"confirm_token": "JmV2qDgC3LotB8njGDcEYjHFpmpAZR",
"otp": "12345678",
}
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 | confirm | |
| otp | Required | String | Одноразовий OTP пароль, який Клієнт отримав на свій телефон | |
| confirm_token | Required | String | Токен платежу |
Параметри відповіді:
| 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 | |
| authcode_credit | String | Код авторизації по транзакції credit | |
| authcode_debit | String | Код авторизації по транзакції debit | |
| bonus_procent | Number | Розмір знижки в процентах | |
| bonus_type | String | Тип бонусу, можливі значення bonusplus, discount_club, personal, promo | |
| card_token | String | Token картки відправника | |
| 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 | Дата завершення/зміни платежу | |
| ip | String | IP адреса відправника | |
| 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 | |
| paytype | String | Спосіб оплати. Можливі значення card - оплата картою, privat24 - через кабінет Приват24, moment_part - розстрочка, invoice - рахунок на e-mail, qr - сканування qr-коду | |
| public_key | String | Публічний ключ магазину | |
| receiver_commission | Number | Комісія з одержувача у валюті платежу | |
| rrn_credit | String | Унікальний номер транзакції в системі авторизації і розрахунків обслуговуючого банку Retrieval Reference number | |
| rrn_debit | String | Унікальний номер транзакції в системі авторизації і розрахунків обслуговуючого банку Retrieval Reference number | |
| sender_bonus | Number | Бонус відправника у валюті платежу | |
| sender_card_bank | String | Банк відправника | |
| sender_card_country | String | Країна картки відправника. Цифровий ISO 3166-1 код | |
| sender_card_mask2 | String | Карта відправника | |
| sender_card_type | String | Тип картки відправника MC/Visa | |
| sender_commission | Number | Комісія з відправника у валюті платежу | |
| sender_first_name | String | Ім'я відправника | |
| sender_last_name | String | Прізвище відправника | |
| sender_phone | String | Телефон відправника | |
| status | String | Статус платежу. Можливі значення: Кінцеві статуси платежу error - Неуспішний платіж. Некоректно заповнені дані failure - Неуспішний платіж reversed - Платіж повернений success - Успішний платіж Статуси що потребують підтвердження платежу 3ds_verify - Потрібна 3DS верифікація. Для завершення платежу, потрібно виконати 3ds_verify Інші статуси платежу wait_accept - Кошти з клієнта списані, але магазин ще не пройшов перевірку. Якщо магазин не пройде активацію протягом 60 днів, платежі будуть автоматично скасовані wait_secure - Платіж на перевірці | |
| transaction_id | Number | Id транзакції в системі LiqPay | |
| confirm_phone | String | Телефон платника. На цей номер було відправлено OTP пароль підтвердження платежу та підв‘язаний кабінет платника LiqPay. Телефон вказується в міжнародному форматі (Україна +380). Наприклад: +380950000001 (з +) або 380950000001 (без +) | |
| language | String | Мова клієнта uk, en | |
| result | String | Результат виконання запиту ok, error | |
| type | String | Тип платежу | |
| version | Number | Версія API. Поточне значення - 7 |
Приклад відповіді:
{
"action": "pay",
"payment_id": 165193,
"status": "success",
"version": 7,
"type": "buy",
"paytype": "card",
"public_key": "i000000000",
"acq_id": 414963,
"order_id": "98R1U1OV1485849059893399",
"liqpay_order_id": "NYMK3AE61501685438251925",
"description": "description",
"sender_phone": "380950000001",
"sender_first_name": "first name",
"sender_last_name": "last name",
"sender_card_mask2": "473118*55",
"sender_card_bank": "pb",
"sender_card_type": "visa",
"sender_card_country": 804,
"ip": "8.8.8.8",
"card_token": "2DFBFE626B734161130DE81E971E948D6F260",
"amount": 0.02,
"currency": "UAH",
"sender_commission": 0.0,
"receiver_commission": 0.0,
"agent_commission": 0.0,
"amount_debit": 0.02,
"amount_credit": 0.02,
"commission_debit": 0.0,
"commission_credit": 0.0,
"currency_debit": "UAH",
"currency_credit": "UAH",
"sender_bonus": 0.0,
"amount_bonus": 0.0,
"bonus_type": "bonusplus",
"bonus_procent": 7.0,
"authcode_debit": "988083",
"authcode_credit": "504979",
"rrn_debit": "000663782982",
"rrn_credit": "000663782985",
"mpi_eci": "5",
"is_3ds": true,
"create_date": 1501688827926,
"end_date": 1501688827926,
"transaction_id": 165193
"confirm_phone":"380674957395",
"language":"uk",
"result":"ok",
}