Page History
Описание сервиса
URL запроса для формата HTTP POST: https://<SERVER-NAME>/cancel/cancel.cfmURL запроса для формата SOAP: https://<SERVER-NAME>/cancel/wscancel.cfm, параметры передаются SOAP запросом, либо в формате JSON ( при передаче параметров в формате JSON см. swagger описание: https://docs.belassist.by/swagger/).
Список параметров запроса:
Название | Обязательное поле | Принимаемые значения | Значение по умолчанию | Описание | ||||
Billnumber | Да | 15 или 16 цифр Расширенный формат | Номер платежа, соответствующий заказу в системе АПК Ассист, передача расширенного номера платежа допускается только в том случае, если в заказе не передается чек. | |||||
Merchant_ID | Да | Число | Идентификатор предприятия в АПК Ассист | |||||
Login | Да | 8 - 20 символов | Логин (лат. буквы и цифры, символ _) | |||||
Password | Да | 8 - 20 символов | Пароль (лат. буквы и цифры) | |||||
Amount | Нет1 | Число, 15 цифр(знаков, два знака после разделителя (допустимый разделитель «.») | Сумма авторизации | Сумма возврата средств | ||||
Currency | Нет1 | 3 символа | Код валюты авторизации | Код валюты отмены или возврата средств. Может быть использован только код валюты авторизации | ||||
CancelReason | Нет | 1 – Отказ магазина | 2 | Причина отмены или возврата | ||||
Language | Нет | RU – русский | RU | Язык выдачи результатов | ||||
ClientIP | Нет | Максимум 15 цифр, 4 разделителя «.» | IP компьютера оператора, производящего отмену/возврат. | |||||
Format | Нет | 1 – CSV | Формат входных данных | Формат выдачи результатов | Customer | Нет2 | Структура данных | Параметры покупателя |
...
4 | Формат выдачи результата. Если запрос передан в формате SOAP или JSON, то ответ также будет в SOAP или JSON соответственно, в остальных случаях ответ выдается согласно переданному значению формата. | |||
Externalrefundid | Нет2 | От 10 до 100 символов (разрешенные символы [A-Za-z0-9\-_] | Внешний идентификатор отмены (уникальное значение в пределах одного заказа) | |
Customer | Нет3 | Структура данных | Параметры покупателя |
| Anchor | ||||
|---|---|---|---|---|
|
1 Параметры Amount, Currency могут присутствовать или отсутствовать в запросе только одновременно. В случае отсутствия параметров операция отмены оплаты будет проведена на полную сумму.
Anchor 2 2
2Параметр используется только для форматов JSON и SOAP.
| Anchor | ||||
|---|---|---|---|---|
|
3Параметр необходим только для отмен платежей по ЕРИП.
В структуре передаются следующие параметры получателя:
Название | Обязательноеполе | Тип значения | Описание |
bankcode | Да | int | Условный номер участника расчетов, присваиваемый банкам национальной платежной системы РБ (банка получателя) |
accountnumber | Да | string(50) | Номер лицевого счета клиента системы «Расчет». |
firstname |
...
1 Параметры Amount, Currency могут присутствовать или отсутствовать в запросе только одновременно. В случае отсутствия параметров операция отмены оплаты будет проведена на полную сумму.
...
2Параметр необходим только для отмен платежей по ЕРИП.
В структуре передаются следующие параметры покупателя:
Название | ОбязательноеполеТип значения | Описание | |
bankcode | Да | int | Условный номер участника расчетов, присваиваемый банкам национальной платежной системы РБ (банка получателя) |
accountnumber | Да | string(50) | Номер лицевого счета клиента системы «Расчет» (получателя). |
firstname | Нет | string(29) | Имя клиента системы «Расчет». |
lastname | Нет | string(29) | Фамилия Имя клиента системы «Расчет». |
lastname | Нет | string(29) | Фамилия клиента системы «Расчет» |
secondname | Нет | string(29) | Отчество клиента системы «Расчет». |
...
Интерфейс для формата HTTP POST (cancel)
Пример запроса HTTP POST для отмены оплаты по банковской карте:
| Code Block | ||
|---|---|---|
| ||
<FORM ACTION="https://<SERVER-NAME>/cancel/cancelwscancel.cfm" method="POST"> <INPUT TYPE="hidden" NAME="BillNumber" VALUE="511111100000001"> <INPUT TYPE="hidden" NAME="Merchant_ID" VALUE="Ваш Merchant_ID"> <INPUT TYPE="hidden" NAME="Login" VALUE="Ваш логин"> <INPUT TYPE="hidden" NAME="Password" VALUE="Ваш пароль"> <INPUT TYPE="hidden" NAME="Amount" VALUE="Сумма"> <INPUT TYPE="hidden" NAME="Currency" VALUE="Валюта"> <INPUT TYPE="hidden" NAME="ClientIP" VALUE="IP-адрес"> <INPUT TYPE="hidden" NAME="Language" VALUE="Язык выдачи результата"> <INPUT TYPE="hidden" NAME="Format" VALUE="Формат выдачи результата"> <INPUT TYPE="Submit"></FORM> |
...
Название | Значение |
ordernumber | Номер заказа |
responsecode | Код возврата |
recommendation | Рекомендации |
message | Сообщение |
ordercomment | Комментарий |
orderdate | Дата заказа по Гринвичу (GMT) |
amount | Сумма операции |
currency | Валюта операции |
meantypename | Тип платежного средства |
meannumber | Номер платежного средства |
lastname | Фамилия плательщика |
firstname | Имя плательщика |
middlename | Отчество плательщика |
issuebank | Название банка-эмитента |
Email плательщика | |
bankcountry | Страна банка-эмитента |
rate | Курс валюты |
approvalcode | Код авторизации |
meansubtype | Подтип платежного средства |
cardholder | Держатель платежного средства |
cardexpirationdate | Срок действия карты |
ipaddress | IP-адрес плательщика |
protocoltypename | Протокол |
testmode | Тестовый режим |
customermessage | Сообщение о результате для покупателя |
orderstate | Cтатус заказа |
processingname | Процессинг |
operationtype | Тип операции |
billnumber | Расширенный формат billnumber |
orderamount | Оригинальная сумма операции |
ordercurrency | Оригинальная валюта операции |
slipno | Номер финансовой транзакции, отправляемый в процессинг (обычно не используется) |
packetdate | Дата формирования запроса по Гринвичу (GMT) |
signature | Подпись. Формируется по следующему алгоритму: 1. Формируется объединённая строка из параметров (в их строковом представлении, в формате как они переданы в ответе): billnumber, ordernumber, responsecode, orderamount, ordercurrency, meannumber, approvalcode, orderstate, packetdate (без разделителей). |
Пример результата запроса отмены платежа или возврата средств в формате XML:
...