Список параметров авторизационного запроса

URL авторизационного запроса:

https://<SERVER-NAME>/pay/order.cfm

Полный список параметров авторизационного запроса представлен в таблице:

Название

Обяза- тельное поле

Принимаемые значения

Значение по умолчанию

Описание

Merchant_ID

Да

Число


Идентификатор предприятия в системе АПК Ассист

OrderNumber

Да

128 символов


Номер заказа в системе расчетов предприятия.

Delay

Нет

0 – одностадийный механизм работы
1- двустадийный механизм

0

Признак авторизации банковской карты при двустадийном механизме работы

Language

Нет

RU - русский,
EN - английский

Язык юр.лица или предприятия

Язык авторизационных страниц

OrderComment

Нет

256 символов


Комментарий

OrderAmount

Да

Число, 15 цифр (разделитель «.»)


Сумма платежа в оригинальной валюте (например, 10.34)

OrderCurrency

Нет

3 символа

Валюта юр.лица или предприятия

Код валюты, в которой указана сумма платежа OrderAmount (Коды валют см. в  Таблице кодов валют )

Lastname

Нет

70 символов


Фамилия покупателя

Firstname

Нет

70 символов


Имя покупателя

Middlename

Нет

70 символов


Отчество покупателя

Email

Нет

128 символов


E-mail покупателя

Address

Нет

256 символов


Адрес покупателя

HomePhone

Нет

64 символа


Домашний телефон покупателя

WorkPhone

Нет

20 символов


Рабочий телефон покупателя

MobilePhone

Нет

20 символов


Мобильный телефон покупателя

Fax

Нет

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 – использовать оплату по банковской карте,
0 – не использовать

1

Покупатель сможет сделать платеж с помощью банковской карты, если передано значение параметра 1 или параметр отсутствует (и оплата по банковским картам доступна для предприятия)

YMPayment

Нет

1 – использовать платежную систему YandexMoney,
0 – не использовать

1

Покупатель сможет сделать платеж с помощью платежной системы YandexMoney, если передано значение параметра 1 или параметр отсутствует (и оплата по YandexMoney доступна для предприятия)

WMPayment

Нет

1 – использовать платежную систему WebMoney,
0 – не использовать

1

Покупатель сможет сделать платеж с помощью платежной системы WebMoney, если передано значение параметра 1 или параметр отсутствует (и оплата по WebMoney доступна для предприятия)

QIWIPayment

Нет

1 – использовать платежную систему QIWI,
0 – не использовать

1

Покупатель сможет сделать платеж с помощью всех средств оплаты платежной системы QIWI, если передано значение параметра 1 или параметр отсутствует (и оплата по QIWI доступна для предприятия)

QIWIMtsPayment

Нет

1; 0

1

Оплата с помощью средств на счету мобильного телефона (оператор МТС)

QIWIMegafonPayment

Нет

1; 0

1

Оплата с помощью средств на счету мобильного телефона (оператор Мегафон)

QIWIBeelinePayment

Нет

1; 0

1

Оплата с помощью средств на счету мобильного телефона (оператор БиЛайн)

QIWITele2PaymentНет1; 01Оплата с помощью средств на счету мобильного телефона (оператор Tele2)
FastPayPaymentНет1; 01Покупатель сможет сделать платеж с помощью Системы быстрых платежей, если передано значение параметра 1 или параметр отсутствует (и оплата по СБП доступна для предприятия)
GooglePayPaymentНет1; 00Признак оплаты через GooglePay (=1)
ApplePayPaymentНет1; 00Признак оплаты через ApplePay (=1)
SamsungPayPaymentНет1; 00Признак оплаты через SamsungPay (=1)

Signature

Нет

строка


Формируется строка по определенным правилам. На базе этой строки алгоритмом MD5 формируется дайджест. Дайджест подписывается закрытым RSA ключом мерчанта. Длина ключа  - 1024. Полученная байтовая последовательность является подписью магазина. Подпись передается нам в виде дополнительного параметра, закодированного в виде строки BASE64

Checkvalue

Нет

строка


Контрольный код. Строка формируется по следующей формуле: uppercase(md5(uppercase(md5(SALT) + md5(Х)))), где SALT – секретное слово; Х – строка, сформированная по определенным правилам.
Примечание. Если мерчант формирует контрольный код без разделителей, следует сообщить об этом в службу поддержки.

MobileDevice

Нет

0 – использовать настройки мерчанта;
1 – стандартные страницы;
2 – страницы для мобильных устройств


Вид платежных страниц (стандартные или для мобильных устройств). Если параметр не передан в запросе, используется настройка предприятия в системе (по умолчанию - стандартные страницы), для включения режима автоопределения устройства необходимо отправить письмо в службу поддержки support@assist.ru

RecurringIndicator

Нет

1 – рекуррентный платеж
0 - нерекуррентный платеж

0

Признак рекуррентного платежа

RecurringMinAmount

Нет/Да

Число, 15 цифр (разделитель «.»)


Минимальная сумма рекуррентных платежей. Обязателен при RecurringIndicator = 1

RecurringMaxAmount

Нет/Да

Число, 15 цифр
(разделитель «.»)


Максимальная сумма рекуррентных платежей. Обязателен при RecurringIndicator = 1

RecurringPeriod

Нет/Да

Число, 3 цифры


Периодичность рекуррентных платежей в днях.Обязателен при RecurringIndicator = 1

RecurringMaxDate

Нет/Да

Строковое представление даты в формате DD.MM.YYYY


Дата окончания рекуррентных платежей. Обязателен при RecurringIndicator = 1

OrderMaxPoints

Нет

Число, 15 цифр

(разделитель «.»)

0

 Максимальная сумма, которую можно оплатить баллами «Спасибо»  


Для фискализации платежа в запросе могут передаваться дополнительные параметры для формирования корректного чека. Описание дополнительных параметров приведено в разделе "Режимы передачи данных чека".

В том случае, если более одного параметра, задающего тип платежного средства (CardPayment, WMPayment и т.п.), имеют значение 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.ru">
<INPUT TYPE="HIDDEN" NAME="OrderComment" VALUE="Оплата заказа 28-A">
<INPUT TYPE="HIDDEN" NAME="URL_RETURN_OK" VALUE="http://www.URL.ru/yes">
<INPUT TYPE="HIDDEN" NAME="URL_RETURN_NO" VALUE="http://www.URL.ru/no">
<INPUT TYPE="HIDDEN" NAME="CardPayment" VALUE="1">
<INPUT TYPE="HIDDEN" NAME="WMPayment" VALUE="0">
<INPUT TYPE="HIDDEN" NAME="YMPayment" VALUE="0">
<INPUT TYPE="SUBMIT" NAME="Submit" VALUE="Купить">
</FORM>

После нажатия такой кнопки покупатель перенаправляется на авторизационные страницы АПК Ассист, где может ввести остальные персональные данные и осуществить оплату заказа с помощью банковской карты. Данные об имени, фамилии и адресе электронной почты покупателя являются обязательными (параметры Firstname, Lastname, Email) и должны быть либо переданы в авторизационном запросе, либо введены на платежной странице.

Обращаем ваше внимание, что оригинальная сумма и код валюты, переданные предприятием в параметрах платежа при перенаправлении покупателя на авторизационные страницы АПК Ассист, могут отличаться от суммы и валюты авторизации. Сумма и валюта авторизации – это сумма и код валюты, которые были переданы в Процессинговый центр для авторизации банковской карты (обычно это сумма в рублях). Например, если оригинальная сумма платежа равна 100 USD (долларов США), то сумма авторизации, совершенной 06.06.2018, равна 6198,22 RUB (рублей).

После успешной операции оплаты статус заказа в системе АПК Ассист принимает значение Approved (Оплачен), все возможные статусы заказа см. "Статусы заказа orderstate". 

В случае, когда предприятие заключило соответствующий договор и желает предоставить плательщику возможность оплатить часть своего товара/услуги бонусными баллами программы «Спасибо от Сбербанка», в авторизационном запросе необходимо передать параметр OrderMaxPoints, значение которого задает максимальное количество баллов, которое клиент сможет использовать при оплате. Если клиент будет оплачивать картой СберБанка, включенной в программу «Спасибо», и на его бонусном счету будут доступные к оплате баллы, то после ввода данных карты клиент получит предложение оплатить часть покупки баллами. Максимальная сумма, которой может воспользоваться клиент – это меньшая из двух сумм: OrderMaxPoints и остатка баллов на бонусном счету клиента. Плательщик сможет выбрать любую сумму баллов (с учетом ограничения) или оплатить всю покупку средствами с карты (без использования бонусных баллов). В зависимости от этого выбора в АПК Ассист будет создана одна (оплата только картой) или две (оплата картой и баллами) операции оплаты в заказе.

Предприятие может также (после заключения соответствующих договоров и активации настроек в системе) работать в режиме, при котором клиентам начисляются бонусные баллы после успешной оплаты картой СберБанка, включенной в программу «Спасибо». Баллы начисляются вне зависимости от того, были использованы бонусные баллы при оплате или нет. При работе в этом режиме в заказе кроме операций оплаты будет создана операция начисления баллов.

Все операции, созданные в рамках данного заказа (операции оплаты картой и баллами, операция начисления) можно увидеть в мониторинге заказов в Личном кабинете, а также в результатах запросов к веб-сервисам (например, orderresult).

Обратите внимание, что подтверждение оплаты и отмена заказов с более чем одной успешной операцией оплаты имеют определенную специфику, описанную в соответствующих разделах руководства.


Возврат покупателя на страницу интернет–магазина после покупки

После совершения платежа в системе АПК Ассист покупатель видит страницу с информацией о результате платежа (например, «Завершено успешно») и данными платежа, покупателя и предприятия.

Можно настроить также автоматическое перенаправление покупателя на сайт предприятия после завершения платежа в АПК Ассист. Для этого необходимо выбрать действие после авторизации «Перейти на страницу магазина» в Личном кабинете в разделе «Настройки мерчантов», вкладка «Настройки платежей». В случае удачной авторизации покупатель будет перенаправлен на адрес, указанный в параметре 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  .

Пример

ListParameters="Field1,Field2"
Field1="42"
Field2="room"

Дополнительные параметры, переданные таким образом, могут быть использованы на пользовательских платежных страницах предприятия (магазина). Для этого в шаблон необходимо добавить тэг с названием параметра, например,,  <%Field1%>


Наверх