URL авторизационного запроса:
https://<SERVER-NAME>/pay/order.cfm
Полный список параметров авторизационного запроса представлен в таблице:
Название | Обяза-тельное поле | Принимаемые значения | Значение по умолчанию | Описание | |
Merchant_ID | Да | Число | Идентификатор предприятия в системе АПК Ассист | ||
OrderNumber | Да | 128 символов | Номер заказа в системе расчетов предприятия. | ||
Delay | Нет | 0 – одностадийный механизм работы | 0 | Признак авторизации банковской карты при двустадийном механизме работы | |
Language | Нет | RU - русский, EN - английский | Язык юр.лица или предприятия | Язык авторизационных страниц | |
OrderComment | Нет | 4000 символов | Комментарий | ||
OrderAmount | Да | Число, 15 знаков, два знака после разделителя (допустимый разделитель «.») | Сумма платежа в оригинальной валюте (например, 10.34) | ||
OrderCurrency | Нет | 3 символа | Валюта юр.лица или предприятия | Код валюты, в которой указана сумма платежа OrderAmount (коды валют см. в Таблице кодов валют) | |
Lastname | Нет | 70 символов | Фамилия покупателя | ||
Firstname | Нет | 70 символов | Имя покупателя | ||
Middlename | Нет | 70 символов | Отчество покупателя | ||
Нет | 128 символа | E-mail покупателя | |||
Address | Нет | 256 символов | Адрес покупателя | ||
HomePhone | Нет | 64 символа | Домашний телефон покупателя | ||
WorkPhone | Нет | 20 символов | Рабочий телефон покупателя | ||
MobilePhone | Нет | 20 символов | Мобильный телефон покупателя | ||
Country | Нет | 3 символа | Код страны покупателя | ||
State | Нет | 3 символа | Код региона покупателя | ||
City | Нет | 70 символов | Город покупателя | ||
Zip | Нет | 25 символов | Индекс предприятия связи покупателя | ||
URL_RETURN | Нет | 255 символов | URL страницы, на которую должен вернуться покупатель после осуществления платежа в системе (должна быть активирована опция «Перейти на страницу магазина» в настройках мерчанта в Личном кабинете). В целях безопасности рекомендуется использовать протокол с шифрованием HTTPS. | ||
URL_RETURN_OK | Нет | 255 символов | Значение параметра URL_RETURN, а при его отсутствии – URL для возврата при успешной авторизации, указанный в Личном кабинете | URL страницы, куда должен вернуться покупатель после успешного осуществления платежа в системе АПК Ассист (должна быть активирована опция «Перейти на страницу магазина» в настройках мерчанта в Личном кабинете). В целях безопасности рекомендуется использовать протокол с шифрованием HTTPS. | |
URL_RETURN_NO | Нет | 255 символов | Значение параметра URL_RETURN, а при его отсутствии – URL для возврата, указанный в Личном кабинете | URL страницы, куда должен вернуться покупатель после неуспешного осуществления платежа в системе АПК Ассист или при отсутствии ответа об окончательном статусе платежа (текущий статус "В процессе"), подробнее см. "Возврат покупателя на страницу интернет-магазина после покупки". Должна быть активирована опция «Возвращаться в магазин по URL для возврата» в Личном кабинете. В целях безопасности рекомендуется использовать протокол с шифрованием HTTPS. | |
CardPayment | Нет | 1 – использовать оплату по банковской карте, | 1 | Покупатель сможет сделать платеж с помощью банковской карты, если передано значение параметра 1 или параметр отсутствует (и оплата по банковским картам доступна для предприятия). | |
ERIPPayment | Нет | 1 – использовать оплату по ЕРИП, | 1 | Покупатель сможет сделать платеж по ЕРИП, если передано значение параметра 1 или параметр отсутствует (и оплата по ЕРИП доступна для предприятия). | |
MobiconPayment | Нет | 1 – использовать платежную систему Mobicon, | 1 | Покупатель сможет сделать платеж с помощью платежной системы Mobicon, если передано значение параметра 1 или параметр отсутствует (и оплата по Mobicon доступна для предприятия) | |
| GooglePayPayment | Нет | 1; 0 | 0 | Признак оплаты через Google Pay (=1) | |
| ApplePayPayment | Нет | 1; 0 | 0 | Признак оплаты через ApplePay (=1) | |
| SamsungPayPayment | Нет | 1; 0 | 0 | Признак оплаты через SamsungPay (=1) | |
Signature | Нет* | строка | Формируется строка по определенным правилам. На базе этой строки алгоритмом MD5 формируется дайджест. Дайджест подписывается закрытым RSA ключом мерчанта. Длина ключа - 1024. Полученная байтовая последовательность является подписью магазина. Подпись передается нам в виде дополнительного параметра, закодированного в виде строки BASE64.
| ||
Checkvalue | Нет* | строка | Контрольный код. Строка формируется по следующей формуле: uppercase(md5(uppercase(md5(SALT) + md5(Х)))), где SALT – секретное слово; Х – строка, сформированная по определенным правилам. Примечание. Если мерчант формирует контрольный код без разделителей, следует сообщить об этом в службу поддержки support@belassist.by.
| ||
MobileDevice | Нет | 0 – использовать настройки мерчанта; | Вид платежных страниц (стандартные или для мобильных устройств). Если параметр не передан в запросе, используется настройка предприятия в системе (по умолчанию - стандартные страницы), для включения режима автоопределения устройства необходимо отправить письмо в службу поддержки support@belassist.by. | ||
RecurringIndicator | Нет | 1 – рекуррентный платеж | 0 | Признак рекуррентного платежа | |
RecurringMinAmount | Нет/Да | Число, 15 знаков, два знака после разделителя (допустимый разделитель «.») | Минимальная сумма рекуррентных платежей. Параметр обязателен при RecurringIndicator = 1 | ||
RecurringMaxAmount | Нет/Да | Число, 15 знаков, два знака после разделителя (допустимый разделитель «.») | Максимальная сумма рекуррентных платежей. Параметр обязателен при RecurringIndicator=1 | ||
RecurringPeriod | Нет/Да | Число, 10 цифр | Периодичность рекуррентных платежей в днях. Параметр обязателен при RecurringIndicator=1 | ||
RecurringMaxDate | Нет/Да | Строковое представление даты в формате DD.MM.YYYY | Дата окончания рекуррентных платежей. Параметр обязателен при RecurringIndicator = 1 |
*Для того, чтобы обезопасить передаваемые данные от возможности их подмены злоумышленниками, необходимо передать один из параметров (Signature или Checkvalue), также должна быть включена настройка проверки контрольного кода (или подписи) в ЛК.
Все параметры, передаваемые в запросе, проходят автоматическую валидацию в АПК Ассист. Правила валидации описаны в табл. "Правила валидации входных параметров". |
В том случае, если более одного параметра, задающего тип платежного средства (CardPayment и т.п.), имеют значение 1, покупателю предоставляется возможность выбрать способ оплаты на платежной странице АПК Ассист. Если эти параметры не передаются, пользователь также сможет выбрать способ оплаты на платежной странице АПК Ассист из всех доступных для данного предприятия. Если все эти параметры имеют значение 0, это приводит к ошибке.
Информация об использовании протокола 3-D Secure 2.0 при создании платежа.
Пример кнопки, содержащей оптимальный набор параметров:
<FORM ACTION="https://<SERVER-NAME>/pay/order.cfm"METHOD="POST"> <INPUT TYPE="HIDDEN" NAME="Merchant_ID" VALUE="Ваш Merchant_ID"> <INPUT TYPE="HIDDEN" NAME="OrderNumber" VALUE="A20042011_28"> <INPUT TYPE="HIDDEN" NAME="OrderAmount" VALUE="237.40"> <INPUT TYPE="HIDDEN" NAME="OrderCurrency" VALUE="USD"> <INPUT TYPE="HIDDEN" NAME="Delay"VALUE="0"> <INPUT TYPE="HIDDEN" NAME="Language"VALUE="RU"> <INPUT TYPE="HIDDEN" NAME="Email"VALUE="test@test.by"> <INPUT TYPE="HIDDEN" NAME="OrderComment" VALUE="Оплата заказа 28-A"> <INPUT TYPE="HIDDEN" NAME="URL_RETURN_OK" VALUE="http://www.URL.by/yes"> <INPUT TYPE="HIDDEN" NAME="URL_RETURN_NO" VALUE="http://www.URL.by/no"> <INPUT TYPE="HIDDEN" NAME="CardPayment"VALUE="1"> <INPUT TYPE="SUBMIT" NAME="Submit"VALUE="Купить"> </FORM> |
После нажатия такой кнопки покупатель перенаправляется на авторизационные страницы АПК Ассист, где может ввести остальные персональные данные и осуществить оплату заказа с помощью банковской карты. Данные об имени, фамилии и адресе электронной почты покупателя являются обязательными (параметры Firstname, Lastname, Email) и должны быть либо переданы в авторизационном запросе, либо введены на платежной странице.
Обращаем ваше внимание, что оригинальная сумма и код валюты, переданные предприятием в параметрах платежа при перенаправлении покупателя на авторизационные страницы АПК Ассист, могут отличаться от суммы и валюты авторизации. Сумма и валюта авторизации – это сумма и код валюты, которые были переданы в Процессинговый центр для авторизации банковской карты (обычно это сумма в белорусских рублях). Например, если оригинальная сумма платежа равна 100 USD (долларов США), то сумма авторизации, совершенной, например, по курсу 1 USD=1,9608 BYN, равна 196,08 BYN (белорусских рублей).
После успешной операции оплаты статус заказа в системе АПК Ассист принимает значение Approved (Оплачен), все возможные статусы заказа см. "Статусы заказа orderstate".
После совершения платежа в системе АПК Ассист покупатель видит страницу с информацией о результате платежа (например, «Завершено успешно») и данными платежа, покупателя и предприятия.
Можно настроить также автоматическое перенаправление покупателя на сайт предприятия после завершения платежа в АПК Ассист. Для этого необходимо выбрать действие после авторизации «Перейти на страницу магазина» в Личном кабинете в разделе «Настройки мерчантов», вкладка «Настройки платежей». В случае удачной авторизации покупатель будет перенаправлен на адрес, указанный в параметре URL_RETURN_OK. Во всех остальных случаях он перенаправляется на адрес, указанный в параметре URL_RETURN или URL_RETURN_NO. При этом при авторизации по банковской карте к этим адресам добавляются параметры Billnumber – полный уникальный номер платежа в системе АПК Ассист и OrderNumber – номер заказа в системе расчетов предприятия, соответствующий данному платежу, в формате:
http://URL возврата/?billnumber=полный_уникальный_номер&ordernumber=номер_заказа |
Параметры URL_RETURN_OK и URL_RETURN (или URL_RETURN_OK и URL_RETURN_NO) можно также передать в авторизационном запросе. Значения параметров URL_RETURN_OK и URL_RETURN, переданных в авторизационном запросе, являются приоритетными по отношению к значениям, введенным в Личном кабинете.
Примечание. При возврате покупателя на сайт предприятия значение номера заказа всегда передается с использованием URL-кодирования, т.е. все не цифровые и не принадлежащие латинскому алфавиту символы (кроме ’-’ и ’_’.) заменяются на знак процентов ’%’ с последующими двумя 16-ричными цифрами кода символа, пробелы заменяются знаками ’+’. Это важно, если номер заказа содержит те или иные специальные символы. |
Если используется опция возврата покупателя в магазин, рекомендуется после получения данных об успешно оплаченном заказе на URL_RETURN_OK дополнительно сделать запрос о результате авторизации на сервер АПК Ассист (о запросе результатов авторизации подробнее) для того чтобы убедиться, что данный заказ действительно оплачен. Также рекомендуется запрашивать результат авторизации при переходе и по адресам URL_RETURN и URL_RETURN_NO, поскольку такой переход выполняется при различных статусах платежа, в том числе и при статусе «В процессе».
Имеется возможность передачи дополнительных произвольных параметров в авторизационном запросе. Для этого необходимо передать перечень полей и их значения в том же порядке, как они были перечислены в параметре ListParameters. Пример
Дополнительные параметры, переданные таким образом, могут быть использованы на пользовательских платежных страницах предприятия (магазина). Для этого в шаблон необходимо добавить тэг с названием параметра, например, <%Field1%> |