1382
правки
Изменения
Новая страница: «Универсальный API для подключения платежных шлюзов позволит шлюзам подключаться к нашей…»
Универсальный API для подключения платежных шлюзов позволит шлюзам подключаться к нашей системе по единой схеме.
=Общая информация=
{| class="wikitable"
! Название запроса !! Описание !! Особенности
|-
| register.do || Запрос регистрации заказа (без предавторизации)|| -
|-
| registerPreAuth.do || Запрос регистрации заказа c предавторизацией || -
|-
| deposit.do || Запрoс завершения oплаты заказа || -
|-
| reverse.do || Запрос отмены оплаты заказа || -
|-
| refund.do || Запрос возврата средств оплаты заказа || -
|-
| getOrderStatusExtended.do || Расширенный запрос состояния заказа || -
|-
|}
* Запросы использующиеся при двухстадийной оплате (с предавторизацией): registerPreAuth.do, deposit.do.
* Запросы использующиеся при одностадийной оплате (без предавторизации): register.do.
* Запросы reverse.do, refund.do и getOrderStatusExtended.do могут быть использованы при любой схеме оплаты.
* Когда юзер хочет вернуть деньги, мы посылаем запрос обновления заказа в ПШ. Если полученный статус заказа orderStatus=1, то посылается запрос reverse.do, если orderStatus=2, то посылается refund.do.
=Настройка шлюза=
Доступные настройки:
* URL клиентского сервера для запросов - указывается адрес запросов, например http://test.com/test
* API логин - от ПШ
* Пароль - от ПШ
* Валюта
* Использовать двухстадийную оплату - если параметр включен, будет использована схема запросов с преавторизацией. Если выключен - схема запросов без преавторизации.
* Разрешить оплату только картами Visa Electron и MasterCard Maestro Сбербанка
* Добавить локатор в начало идентификатора платежа при передаче в ПШ - в orderNumber добавляет префикс с локатором.
* Отображать фрэйм со страницей оплаты на странице информации о заказе
* Высота фрэйма со страницей оплаты
=Формат запросов/ответов=
Универсальный API для подключения платежных шлюзов реализован с помощью HTTP запросов/ответов методом POST.
* register.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderNumber, amount, returnUrl, currency, description, language, jsonParams
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderNumber || Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы || Номер биллинга
|-
| amount || Сумма к оплате || Сумма платежа в копейках (или центах)
|-
| returnUrl || Адрес, на который требуется перенаправить пользователя в случае успешной оплаты. Значение должно представлять собой абсолютную ссылку. || Пример: "http://test.com/universal_nemo_pay__after_authorisation?billing_id=111111111".
|-
| currency || Валюта || Код валюты платежа ISO 4217.
|-
| description || Описание заказа в свободной форме || Пример: "Оплата заказа №586578 (1X96WD) с сайта http://test.com".
|-
| language || Язык в кодировке ISO 639-1. || Пример: "ru".
|-
| jsonParams || Блок для передачи дополнительных параметров мерчанта. || Пример данных передаваемых Немо: {"onlyMaestro":"false","email":"test@mutelab.com","phone":"79270099000"}
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: orderId, formUrl, errorCode, errorMessage.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
| formUrl || URL платежной формы, на который надо перенаправить браузер клиента. || -
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
|}
</div></div>
* registerPreAuth.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderNumber, amount, returnUrl, currency, description, language, jsonParams
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderNumber || Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы || Номер биллинга
|-
| amount || Сумма к оплате || Сумма платежа в копейках (или центах)
|-
| returnUrl || Адрес, на который требуется перенаправить пользователя в случае успешной оплаты. Значение должно представлять собой абсолютную ссылку. || Пример: "http://test.com/universal_nemo_pay__after_authorisation?billing_id=111111111".
|-
| currency || Валюта || Код валюты платежа ISO 4217.
|-
| description || Описание заказа в свободной форме || Пример: "Оплата заказа №586578 (1X96WD) с сайта http://test.com".
|-
| language || Язык в кодировке ISO 639-1. || Пример: "ru".
|-
| jsonParams || Блок для передачи дополнительных параметров мерчанта. || Пример данных передаваемых Немо: {"onlyMaestro":"false","email":"test@mutelab.com","phone":"79270099000"}
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: orderId, formUrl, errorCode, errorMessage.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
| formUrl || URL платежной формы, на который надо перенаправить браузер клиента. || -
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
|}
</div></div>
* deposit.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderId, amount.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
| amount || Сумма к оплате || Сумма платежа в копейках (или центах)
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: errorCode, errorMessage.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
|}
</div></div>
* reverse.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderId.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: errorCode, errorMessage.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
|}
</div></div>
* refund.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderId.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: errorCode, errorMessage.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
|}
</div></div>
* getOrderStatusExtended.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderId, language, orderNumber.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
| orderNumber || Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы || Номер биллинга
|-
| language || Язык в кодировке ISO 639-1. || Пример: "ru".
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: errorCode, errorMessage, orderStatus и cardAuthInfo(expiration, cardholderName, approvalCode, pan).
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
| orderStatus || Состояние заказа в платежной системе. ||
* 0 - Заказ зарегистрирован, но не оплачен
* 1 - Предавторизованная сумма захолдирована (для двухстадийных платежей)
* 2 - Проведена полная авторизация суммы заказа
* 6 - Авторизация отклонена
|-
| cardAuthInfo || Тэг с атрибутами платежа. ||
* expiration - Срок истечения действия карты в формате YYYYMM.
* cardholderName - Имя держателя карты.
* approvalCode - Код авторизации платежа. Поле фиксированной длины (6 символов), может содержать цифры и латинские буквы.
* pan - Маскированный номер карты, которая использовалась для оплаты.
|-
|}
</div></div>
=Общая информация=
{| class="wikitable"
! Название запроса !! Описание !! Особенности
|-
| register.do || Запрос регистрации заказа (без предавторизации)|| -
|-
| registerPreAuth.do || Запрос регистрации заказа c предавторизацией || -
|-
| deposit.do || Запрoс завершения oплаты заказа || -
|-
| reverse.do || Запрос отмены оплаты заказа || -
|-
| refund.do || Запрос возврата средств оплаты заказа || -
|-
| getOrderStatusExtended.do || Расширенный запрос состояния заказа || -
|-
|}
* Запросы использующиеся при двухстадийной оплате (с предавторизацией): registerPreAuth.do, deposit.do.
* Запросы использующиеся при одностадийной оплате (без предавторизации): register.do.
* Запросы reverse.do, refund.do и getOrderStatusExtended.do могут быть использованы при любой схеме оплаты.
* Когда юзер хочет вернуть деньги, мы посылаем запрос обновления заказа в ПШ. Если полученный статус заказа orderStatus=1, то посылается запрос reverse.do, если orderStatus=2, то посылается refund.do.
=Настройка шлюза=
Доступные настройки:
* URL клиентского сервера для запросов - указывается адрес запросов, например http://test.com/test
* API логин - от ПШ
* Пароль - от ПШ
* Валюта
* Использовать двухстадийную оплату - если параметр включен, будет использована схема запросов с преавторизацией. Если выключен - схема запросов без преавторизации.
* Разрешить оплату только картами Visa Electron и MasterCard Maestro Сбербанка
* Добавить локатор в начало идентификатора платежа при передаче в ПШ - в orderNumber добавляет префикс с локатором.
* Отображать фрэйм со страницей оплаты на странице информации о заказе
* Высота фрэйма со страницей оплаты
=Формат запросов/ответов=
Универсальный API для подключения платежных шлюзов реализован с помощью HTTP запросов/ответов методом POST.
* register.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderNumber, amount, returnUrl, currency, description, language, jsonParams
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderNumber || Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы || Номер биллинга
|-
| amount || Сумма к оплате || Сумма платежа в копейках (или центах)
|-
| returnUrl || Адрес, на который требуется перенаправить пользователя в случае успешной оплаты. Значение должно представлять собой абсолютную ссылку. || Пример: "http://test.com/universal_nemo_pay__after_authorisation?billing_id=111111111".
|-
| currency || Валюта || Код валюты платежа ISO 4217.
|-
| description || Описание заказа в свободной форме || Пример: "Оплата заказа №586578 (1X96WD) с сайта http://test.com".
|-
| language || Язык в кодировке ISO 639-1. || Пример: "ru".
|-
| jsonParams || Блок для передачи дополнительных параметров мерчанта. || Пример данных передаваемых Немо: {"onlyMaestro":"false","email":"test@mutelab.com","phone":"79270099000"}
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: orderId, formUrl, errorCode, errorMessage.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
| formUrl || URL платежной формы, на который надо перенаправить браузер клиента. || -
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
|}
</div></div>
* registerPreAuth.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderNumber, amount, returnUrl, currency, description, language, jsonParams
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderNumber || Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы || Номер биллинга
|-
| amount || Сумма к оплате || Сумма платежа в копейках (или центах)
|-
| returnUrl || Адрес, на который требуется перенаправить пользователя в случае успешной оплаты. Значение должно представлять собой абсолютную ссылку. || Пример: "http://test.com/universal_nemo_pay__after_authorisation?billing_id=111111111".
|-
| currency || Валюта || Код валюты платежа ISO 4217.
|-
| description || Описание заказа в свободной форме || Пример: "Оплата заказа №586578 (1X96WD) с сайта http://test.com".
|-
| language || Язык в кодировке ISO 639-1. || Пример: "ru".
|-
| jsonParams || Блок для передачи дополнительных параметров мерчанта. || Пример данных передаваемых Немо: {"onlyMaestro":"false","email":"test@mutelab.com","phone":"79270099000"}
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: orderId, formUrl, errorCode, errorMessage.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
| formUrl || URL платежной формы, на который надо перенаправить браузер клиента. || -
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
|}
</div></div>
* deposit.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderId, amount.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
| amount || Сумма к оплате || Сумма платежа в копейках (или центах)
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: errorCode, errorMessage.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
|}
</div></div>
* reverse.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderId.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: errorCode, errorMessage.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
|}
</div></div>
* refund.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderId.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: errorCode, errorMessage.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
|}
</div></div>
* getOrderStatusExtended.do
<div class="toccolours mw-collapsible mw-collapsed">
Параметры запроса: userName, password, orderId, language, orderNumber.
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| userName || API логин || Логин магазина, полученный при подключении
|-
| password || Пароль || Пароль магазина, полученный при подключении
|-
| orderId || Номер заказа в платежной системе. Уникален в пределах системы. || -
|-
| orderNumber || Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы || Номер биллинга
|-
| language || Язык в кодировке ISO 639-1. || Пример: "ru".
|-
|}
</div></div>
<div class="toccolours mw-collapsible mw-collapsed">
Параметры ответа: errorCode, errorMessage, orderStatus и cardAuthInfo(expiration, cardholderName, approvalCode, pan).
<div class="mw-collapsible-content">
{| class="wikitable"
! Название параметра !! Описание !! Особенности
|-
| errorCode || Код ошибки. || Любое значение отличное от "0" воспринимается нашей системой как неуспешный ответ.
|-
| errorMessage || Описание ошибки на языке, переданном в параметре language в запросе. || -
|-
| orderStatus || Состояние заказа в платежной системе. ||
* 0 - Заказ зарегистрирован, но не оплачен
* 1 - Предавторизованная сумма захолдирована (для двухстадийных платежей)
* 2 - Проведена полная авторизация суммы заказа
* 6 - Авторизация отклонена
|-
| cardAuthInfo || Тэг с атрибутами платежа. ||
* expiration - Срок истечения действия карты в формате YYYYMM.
* cardholderName - Имя держателя карты.
* approvalCode - Код авторизации платежа. Поле фиксированной длины (6 символов), может содержать цифры и латинские буквы.
* pan - Маскированный номер карты, которая использовалась для оплаты.
|-
|}
</div></div>