ПростоКасса | API для разработчиков

Версия 2.0.4

PROSTOKASSA API

1. Термины и определения
2. Описание интерфейса
- Форма создания счета
- Форма оповещения
- Форма возврата
3. Настройки Продавца
4. Проверка платежа
5. Контрольная подпись
6. Прочие параметры

1. Термины и определения

Платежная страница - Веб-страница на сайте Сервиса, на которой производится обработка платежей
Продавец - Физическое или юридическое лицо, в адрес которого производится платеж
Кошелек - Учетная запись Продавца на Веб-сайте Сервиса
Сервис - Платежный сервис Простокасса.ру

2. Описание интерфейса

Взаимодействие между Продавцом и Сервисом осуществляется при помощи HTML-форм:

- Форма создания счета - Формирует запрос на создание счета, перенаправляет Покупателя на Платежную страницу
- Форма оповещения - Передает информацию о результате платежа на сервер Продавца без участия Покупателя
- Форма возврата - Перенаправляет Покупателя обратно на сайт Продавца после совершения оплаты

Форма создания счета

Параметры формы:

Параметр	Описание
PMI_MERCHANT_ID	Идентификатор Продавца
PMI_PAYMENT_NO	Номер заказа в системе Продавца
PMI_PAYMENT_AMOUNT	Сумма платежа в рублях
PMI_PAYMENT_DESC	Назначение платежа (base64)
PMI_PAYMENT_DATA	Дополнительный параметр продавца

Пример формы:

<form action="https://prostokassa.ru/pmi/" method="POST">

<input type="hidden" name="PMI_MERCHANT_ID" value="10000000010">
<input type="hidden" name="PMI_PAYMENT_NO" value="123456789">
<input type="hidden" name="PMI_PAYMENT_AMOUNT" value="150.25">
<input type="hidden" name="PMI_PAYMENT_DESC" value="MjE0MTI0MTI=">
<input type="hidden" name="PMI_PAYMENT_DATA" value="param1">

<input type="submit" value="Оплатить"></form>

Форма оповещения

Параметры формы:

Параметр	Описание
PMI_MERCHANT_ID	Идентификатор Продавца
PMI_PAYMENT_NO	Номер заказа в системе Продавца
PMI_PAYMENT_AMOUNT	Сумма платежа
PMI_PAYMENT_DATA	Дополнительный параметр продавца
PMI_PAYMENT_TYPE	Способ оплаты
PMI_PAYMENT_ID	Номер транзакции в Сервисе
PMI_PAYMENT_STATUS	Код результата платежа
PMI_HASH	Контрольная подпись

Пример формы:

<form action="PMI_NOTIFY_URL" method="POST">

<input type="hidden" name="PMI_MERCHANT_ID" value="10000000010">
<input type="hidden" name="PMI_PAYMENT_NO" value="123456789">
<input type="hidden" name="PMI_PAYMENT_AMOUNT" value="150.25">
<input type="hidden" name="PMI_PAYMENT_DATA" value="param1">
<input type="hidden" name="PMI_PAYMENT_TYPE" value="115">
<input type="hidden" name="PMI_PAYMENT_ID" value="69247695862385053520">
<input type="hidden" name="PMI_PAYMENT_STATUS" value="100">
<input type="hidden" name="PMI_HASH" value="EC468199560f498AADD3101A0E0E985F">

</form>

Форма возврата

Параметры формы:

Параметр	Описание
PMI_MERCHANT_ID	Идентификатор Продавца
PMI_PAYMENT_NO	Номер заказа в системе Продавца
PMI_PAYMENT_ID	Номер транзакции в Сервисе
PMI_PAYMENT_STATUS	Код результата платежа

Пример формы:

<form action="PMI_FAIL/SUCCESS_URL" method="POST" name="PMI">

<input type="hidden" name="PMI_MERCHANT_ID" value="10000000010">
<input type="hidden" name="PMI_PAYMENT_NO" value="123456789">
<input type="hidden" name="PMI_PAYMENT_ID" value="69247695862385053520">
<input type="hidden" name="PMI_PAYMENT_STATUS" value="100">

</form>

3. Настройки Продавца

Перед началом приема платежей необходимо произвести настройки в Кошельке Продавца. Описание параметров настроек приведено в таблице:

Параметр	Описание
Название магазина	Идентификатор Продавца
Описание магазина	Номер заказа в системе Продавца
Электронная почта	Номер транзакции в Сервисе
PMI_SUCCESS_URL	URL-адрес для перенаправления успешного платежа
PMI_FAIL_URL	URL-адрес для перенаправления неуспешного платежа
PMI_NOTIFY_URL	URL-адрес для отправки оповещений о статусе платежа
SHARED_SECRET	Ключ, используемый для проверки контрольной подписи

4. Проверка платежа

Проверка платежа осуществляется при передаче данных со стороны Сервера на веб-сайт Продавца через Форму оповещения. Информация о платеже передается на адрес, указанный Продавцом в настройках Кошелька (PMI_NOTIFY_URL)

Ответ на запрос при успешной проверке данных должен содержать 2 символа латиницей: ОК

5. Контрольная подпись

Контрольная подпись представляет из себя MD5-хеш (в ВЕРХНЕМ регистре) строки, составленной из указанных значений параметров без пробелов и дополнительных символов:

MD5(SHARED_SECRET + PMI_MERCHANT_ID + PMI_PAYMENT_NO + PMI_PAYMENT_AMOUNT + PMI_PAYMENT_DATA + PMI_PAYMENT_TYPE + PMI_PAYMENT_ID + PMI_PAYMENT_STATUS)

6. Прочие параметры

Код ответа PMI_PAYMENT_STATUS при успешном платеже равен 100, в остальных случаях платеж считается неуспешным