Правила формування запиту

Необхідні 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( sha1( private_key + data + private_key) ),

base64_encode - повертає рядок, закодований методом base64,

sha1 - повертається хеш у вигляді бінарного рядку з 20 символів.

Формування data і signature, приклад:

Для підключення прийому оплати через LiqPay, формуємо json рядок з параметрами виклику апі, де:

Parameter	Required	Type	Description
version	Required	Number	Версія API. Наприклад: 3
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, RUB, UAH, BYN, KZT. Додаткові валюти можуть бути встановлені за запитом компанії.
description	Required	String	Призначення платежу.
order_id	Required	String	Унікальний ID покупки у Вашому магазині. Максимальна довжина 255 символів.

Більше параметрів в документації

Інструмент формування data і signature

Приклад створення json_string:

json_string = {"public_key":"i00000000","version":"3","action":"pay","amount":"3","currency":"UAH","description":"test","order_id":"000001"}

Приклад кодування json_string функцією base64_encode, компанія отримує data:

data = eyJwdWJsaWNfa2V5IjoiaTAwMDAwMDAwIiwidmVyc2lvbiI6IjMiLCJhY3Rpb24iOiJwYXkiLCJhbW91bnQiOiIzIiwiY3VycmVuY3kiOiJVQUgiLCJkZXNjcmlwdGlvbiI6InRlc3QiLCJvcmRlcl9pZCI6IjAwMDAwMSJ9

Приклад формування signature, компанія формує рядок sign_string шляхом конкатенації private_key + data + private_key:

sign_string = a4825234f4bae72a0be04eafe9e8e2bada209255eyJwdWJsaWNfa2V5IjoiaTAwMDAwMDAwIiwidmVyc2lvbiI6IjMiLCJhY3Rpb24iOiJwYXkiLCJhbW91bnQiOiIzIiwiY3VycmVuY3kiOiJVQUgiLCJkZXNjcmlwdGlvbiI6InRlc3QiLCJvcmRlcl9pZCI6IjAwMDAwMSJ9a4825234f4bae72a0be04eafe9e8e2bada209255

Після застосування функцій base64_encode( sha1( sign_string) ) отримуємо рядок:

signature = wR+UZDC4jjeL/qUOvIsofIWpZh8=

Приклад відправки запиту до LiqPay:

1. Для перенаправлення клієнта на сторінку оплати LiqPay (Client - Server) необхідно сформувати HTML-форму:

2. Для взаємодії (Server - Server) отримані data і signature необхідно відправити на url https://www.liqpay.ua/api/request:

curl --silent -XPOST https://www.liqpay.ua/api/request --data-urlencode
data="eyJwdWJsaWNfa2V5IjoiaTAwMDAwMDAwIiwidmVyc2lvbiI6IjMiLCJhY3Rpb24iOiJwYXkiLCJhbW91bnQiOiIzIiwiY3VycmVuY3kiOiJVQUgiLCJkZXNjcmlwdGlvbiI6InRlc3QiLCJvcmRlcl9pZCI6IjAwMDAwMSJ9" --data-urlencode
signature="wR+UZDC4jjeL/qUOvIsofIWpZh8="

3. Статус операції буде відправлений на server_url.

4. Успішне завершення оплати.