Документация по API онлайн кассы Pay-pie.

В данной документации описаны все доступные методы/запросы для работы с кассой.

Возможные ошибки

Ошибка	Описание
`auth`: “error”	Неверно указан секретный ключ 1, либо логин кассы.
`error`: true	Возникла ошибка при выполнении запроса, возможно не соблюдены условия.
`error_message`: “message…”	Текст ошибки.

• Генерация ссылки для оплаты (Invoice)

Параметр	Описание
o	Операция (invoice-create)
n	Имя/Логин кассы
s	Секретный ключ 1
amount	Сумма в рублях или другой валюте (см. ниже)
*currency*	Валюта суммы (конвертируется в рубли) (USD, BTC, ETH, LTC…) (необязательно)
*lifetime*	Время жизни счёта для оплаты, в минутах (необязательно)
*redirect*	Ссылка для перенаправления после оплаты (необязательно)
*callback*	Ссылка на скрипт, на который будет отправлен запрос, после успешного зачисления средств на счёт кассы (необязательно)
*extra*	Любые текстовые данные, пометка/комментарий. Будет передано в callback или при проверке статуса платежа (необязательно)

GET Пример запроса:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=invoice-create&amount=100&lifetime=1440&callback=http://mysite.site/process.php&redirect=http://mysite.site&extra=mypayid1234

GET Пример запроса без redirect, callback и extra:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=invoice-create&amount=100&lifetime=60

JSON Ответ:

{"id":"1_gdTSSewzsE","url":"https:\/\/pay.pay-pie.ru\/?i=1_gdTSSewzsE","error":false,"auth":"ok"}

Если необходимо принудительно указать платёжную систему, то можно добавить к ссылке &m=btc, где btc - код платёжной системы: https://pay.pay-pie.ru/?i=1_gdTSSewzsE&m=btc

PHP (CALLBACK) Передаваемые параметры:

$id = $_GET["ID"]; //ID Чека.
$amount = $_GET["AMOUNT"]; //Сумма, на которую был выставлен счёт.
$payamount = $_GET["PAYAMOUNT"]; //Сумма, которую оплатил пользователь, в валюте.
$paymethod = $_GET["PAYMETHOD"]; //btc, lztm, eth...
$currency = $_GET["CURRENCY"]; //BITCOIN, LZTMARKET, ETHEREUM...
$hash = $_GET["HASH"]; //Хэш операции, для проверки подлинности.
$extra = $_GET["EXTRA"]; //Пометка/комментарий, если был указан при создании.

if (empty($id) or empty($currency) or empty($hash))
   exit();

$secret2 = "7551ffeba39ddbf705d238c97ed9d26986f4c0f9"; //Секретный ключ 2
$checkHash = sha1($id.':'.$currency.':'.$secret2);

if ($hash != $checkHash) //Проверка подлинности запроса, путём проверки хэша.
   exit();

//Ваш код...
{...}

• Получение статуса оплаты (Invoice)

Параметр	Описание
o	Операция (invoice-check)
n	Имя/Логин кассы
s	Секретный ключ 1
i	ID Чека (Операции)

GET Пример запроса:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=invoice-check&i=1_gdTSSewzsE

JSON Ответ state = notpayed:

{"amount":100,"payamount":105,"state":"notpayed","paymethod":null,"extra":"","error":false,"auth":"ok"}

JSON Ответ state = processing:

{"amount":100,"payamount":105,"state":"processing","paymethod":"btc","extra":"","error":false,"auth":"ok"}

JSON Ответ state = payed - конечный статус:

{"amount":100,"payamount":105,"state":"payed","paymethod":"btc","extra":"","error":false,"auth":"ok"}

JSON Ответ state = payed + поле extra - конечный статус:

{"amount":100,"payamount":105,"state":"payed","paymethod":"btc","extra":"mypayid1234","error":false,"auth":"ok"}

• Получение баланса кассы

Параметр	Описание
o	Операция (balance)
n	Имя/Логин кассы
s	Секретный ключ 1

GET Пример запроса:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=balance

JSON Ответ:

{"balance":{"DASH":"0.01046131","QIWI":"105","LITECOIN":"5.01246131"},"auth":"ok"}

• Создание заявки на вывод средств с кассы (Withdraw)

Параметр	Описание
o	Операция (withdraw)
n	Имя/Логин кассы
s	Секретный ключ 1
secret	Секретный ключ для вывода средств
amount	Сумма в валюте
*rubamount*	Сумма в рублях (приоритет выше, чем у параметра amount) (необязательно)
wallet	Номер кошелька
currency	Сервис (тип валюты) для вывода, используются названия из полученного баланса

GET Пример запроса:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=withdraw&wallet=79999999999999&amount=100&currency=QIWI&callback=http://mysite.site/process.php&secret=%СЕКРЕТНЫЙ_КЛЮЧ%

GET Пример запроса без callback:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=withdraw&wallet=79999999999999&amount=100&currency=QIWI&secret=%СЕКРЕТНЫЙ_КЛЮЧ%

JSON Ответ state = processing:

{"error":false,"auth":"ok","state":"processing","id":"381387314_kwodmmWbchtUhCgirVIo","amount":100,"commission":1,"currency":"QIWI","wallet":"79000*****"}

JSON Ответ state = failed - конечный статус:

{"error":false,"auth":"ok","state":"failed","id":"381387314_kwodmmWbchtUhCgirVIo","amount":100,"commission":1,"currency":"QIWI","wallet":"79000*****"}

JSON Ответ state = payed - конечный статус:

{"error":false,"auth":"ok","state":"payed","id":"381387314_kwodmmWbchtUhCgirVIo","amount":100,"commission":1,"currency":"QIWI","wallet":"79000*****"}

JSON Ответ state = payed + поле message - конечный статус:

{"error":false,"auth":"ok","state":"payed","id":"381387314_kwodmmWbchtUhCgirVIo","amount":100,"commission":1,"currency":"LITECOIN","wallet":"MPgLpUZtkZdPDjHf7DQufM******","message":"Transaction: https://blockchair.com/ru/litecoin/transaction/..."}

PHP Пример генерации секретного ключа для вывода:

$wallet = "79999999999999";
$amount = 100;
$secret2 = "7551ffeba39ddbf705d238c97ed9d26986f4c0f9"; //Секретный ключ 2

$withdraw_secret = md5($wallet.'-'.$amount.'-'.$secret2);

PHP (CALLBACK) Передаваемые параметры:

$id = $_GET["ID"]; //ID Заявки.
$amount = $_GET["AMOUNT"]; //Сумма заявки.
$commission = $_GET["COMMISSION"]; //Комиссия вывода, вычетается из суммы заявки.
$wallet = $_GET["WALLET"]; //Кошелёк вывода.
$currency = $_GET["CURRENCY"]; //YANDEX, QIWI, VISAMASTER.RUR...
$state = $_GET["STATE"]; //Статус заявки - failed/payed.
$message = $_GET["MESSAGE"]; //Сообщение, если есть.
$hash = $_GET["HASH"]; //Хэш операции, для проверки подлинности.

if (empty($id) or empty($amount) or empty($wallet) or empty($currency) or empty($state) or empty($hash))
   exit();

$secret2 = "7551ffeba39ddbf705d238c97ed9d26986f4c0f9"; //Секретный ключ 2
$checkHash = sha1($id.':'.$amount.':'.$currency.':'.$wallet.':'.$secret2);

if ($hash != $checkHash) //Проверка подлинности запроса, путём проверки хэша.
   exit();

//Ваш код...
{...}

• Получение статуса заявки на вывод средств с кассы (Withdraw)

Параметр	Описание
o	Операция (withdraw-status)
n	Имя/Логин кассы
s	Секретный ключ 1
i	ID Заявки на вывод

GET Пример запроса:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=withdraw-status&i=381387314_kwodmmWbchtUhCgirVIo

JSON Ответ state = processing:

{"error":false,"auth":"ok","state":"processing","amount":100,"commission":1,"currency":"QIWI","wallet":"79000*****"}

JSON Ответ state = failed - конечный статус:

{"error":false,"auth":"ok","state":"failed","amount":100,"commission":1,"currency":"QIWI","wallet":"79000*****"}

JSON Ответ state = payed - конечный статус:

{"error":false,"auth":"ok","state":"payed","amount":100,"commission":1,"currency":"QIWI","wallet":"79000*****"}

JSON Ответ state = payed + поле message - конечный статус:

{"error":false,"auth":"ok","state":"payed","amount":100,"commission":1,"currency":"LITECOIN","wallet":"MPgLpUZtkZdPDjHf7DQufM******","message":"Transaction: https://blockchair.com/ru/litecoin/transaction/..."}

• Перевод средств на другую кассу (P2P)

Параметр	Описание
o	Операция (p2p-transfer)
n	Имя/Логин кассы
s	Секретный ключ 1
secret	Секретный ключ для P2P операции
login	Логин кассы получателя
amount	Сумма
currency	Сервис (тип валюты) для оплаты, используются названия из полученного баланса

GET Пример запроса:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=p2p-transfer&login=friendkassa&amount=100&currency=VISAMASTER.RUR&secret=%СЕКРЕТНЫЙ_КЛЮЧ%

JSON Ответ:

{"error":false,"auth":"ok"}

PHP Пример генерации секретного ключа для P2P операции:

$currency = "VISAMASTER.RUR";
$amount = 100;
$login = "friendkassa";
$secret2 = "7551ffeba39ddbf705d238c97ed9d26986f4c0f9"; //Секретный ключ 2

$p2p_secret = md5($currency.'@'.$amount.'@'.$login.'@'.$secret2);

• Создание ваучера (Voucher)

Параметр	Описание
o	Операция (voucher-create)
n	Имя/Логин кассы
s	Секретный ключ 1
secret	Секретный ключ для создания ваучера
amount	Сумма
currency	Сервис (тип валюты) для оплаты, используются названия из полученного баланса
*comment*	Комментарий к ваучеру (необязательно)

GET Пример запроса:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=voucher-create&amount=100&currency=VISAMASTER.RUR&comment=Test123&secret=%СЕКРЕТНЫЙ_КЛЮЧ%

GET Пример запроса без comment:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=voucher-create&amount=100&currency=VISAMASTER.RUR&secret=%СЕКРЕТНЫЙ_КЛЮЧ%

JSON Ответ:

{"code":"Z7YK3SMTWAZ6SDGGVVXZ25H32","error":false,"auth":"ok"}

PHP Пример генерации секретного ключа для создания ваучера:
$currency = "VISAMASTER.RUR";
$amount = 100;
$secret2 = "7551ffeba39ddbf705d238c97ed9d26986f4c0f9"; //Секретный ключ 2

$voucher_secret = md5($currency.'&'.$amount.'&'.$secret2);

• Получение информации о ваучере (Voucher)

Параметр	Описание
o	Операция (voucher-info)
n	Имя/Логин кассы
s	Секретный ключ 1
code	Код ваучера

GET Пример запроса:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=voucher-info&code=Z7YK3SMTWAZ6SDGGVVXZ25H32

JSON Ответ без комментария:

{"amount":100,"currency":"VISAMASTER.RUR","comment":null,"error":false,"auth":"ok"}

JSON Ответ с комментарием:

{"amount":100,"currency":"VISAMASTER.RUR","comment":"Test123","error":false,"auth":"ok"}

• Активация ваучера (Voucher)

Параметр	Описание
o	Операция (voucher-activate)
n	Имя/Логин кассы
s	Секретный ключ 1
code	Код ваучера

GET Пример запроса:

https://api.pay-pie.ru/v1/?s=0f5601d7150d663cc1dd05bbe035c0cb02b4bc8f&n=testkassa&o=voucher-activate&code=Z7YK3SMTWAZ6SDGGVVXZ25H32

JSON Ответ без комментария:

{"amount":100,"currency":"VISAMASTER.RUR","comment":null,"error":false,"auth":"ok"}

JSON Ответ с комментарием:

{"amount":100,"currency":"VISAMASTER.RUR","comment":"Test123","error":false,"auth":"ok"}