Page History
Описание сервиса
URL запроса для формата HTTP POST: https://<SERVER-NAME>/cancel/cancel.cfmURL запроса для формата SOAP: https://<SERVER-NAME>/cancel/wscancel.cfm, параметры передаются SOAP запросом, либо при передаче параметров в формате JSON (см. swagger описание: https://docs.assist.ru/swagger/).
...
...
Если предприятие работает с программой лояльности «Спасибо от СберБанка», и в заказе может быть две успешные операции оплаты (картой и баллами), а также операция начисления баллов, рекомендуем для отмен пользоваться сервисом https://<SERVER-NAME>/cancel/wscancel.cfm.
Список параметров запроса:
Название | Обязательное поле | Принимаемые значения | Значение по умолчанию | Описание | |||
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 | Формат входных данных, 4 для сервиса wscancel | Формат выдачи результатов | 4 – SOAP | 4 | Формат выдачи результатов. Передается только для запроса в формате POST (по умолчанию ответ будет выдан в формате CSV). Для других форматов ответ выдается в том же формате, в котором был выполнен запрос. |
Externalrefundid2 | Нет | От 10 до 100 символов (разрешенные символы [A-Za-z0-9\-_] | Внешний идентификатор отмены (уникальное значение в пределах одного заказа) |
| Anchor | ||||
|---|---|---|---|---|
|
1 Параметры Amount, Currency могут присутствовать или отсутствовать в запросе только одновременно. В случае отсутствия параметров операция отмены оплаты будет проведена на полную сумму.
| Anchor | ||||
|---|---|---|---|---|
|
2Параметр используется только для форматов JSON и SOAP.
| Multiexcerpt include | ||||
|---|---|---|---|---|
|
...
Для совершения операции отмены можно передать параметр billnumber как в обычном формате (если по заказу была одна успешная операция оплаты), так и в расширенном формате. При использовании расширенного формата обязательно должен быть указан номер успешной операции оплаты (в некоторых случаях это может быть не первая по счету операция, например,5111111000965142.2)).
| Warning |
|---|
Внимание! Передача расширенного номера платежа допускается только в том случае, если в заказе не передается чек. |
Отмена или возврат средств является успешной, если код возврата операции отмены responsecode AS000 (операция успешно завершена), оба кода firstcode=0, secondcode=0, статус заказа при этом становится Canceled (Отменен) или PartialCanceled (Отменен частично).
...
Интерфейс для формата HTTPPOST (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) |
Расширенный формат billnumber | |
orderamount | Оригинальная сумма операции |
ordercurrency | Оригинальная валюта операции |
slipno | Номер финансовой транзакции, отправляемый в процессинг |
packetdate | Дата формирования запроса по Гринвичу (GMT) |
signature | Подпись. Формируется по следующему алгоритму: 1. Формируется объединённая строка из параметров (в их строковом представлении, в формате как они переданы в ответе): billnumber, ordernumber, responsecode, orderamount, ordercurrency, meannumber, approvalcode, orderstate, packetdate (без разделителей). |
Пример результата запроса отмены платежа или возврата средств в формате XML:
...
Веб-сервис для формата SOAP (wscancel)
Описание веб-сервиса для формата SOAP можно увидеть на странице:
...
Название | Значение |
Параметрызаказа(секция<order>) | |
billnumber | Уникальный номер заказа в системе АПК Ассист |
ordernumber | Номер заказа |
testmode | Тестовый режим |
ordercomment | Комментарий |
orderamount | Оригинальная сумма заказа |
ordercurrency | Оригинальная валюта заказа |
rate | Курс валюты |
orderdate | Дата заказа по Гринвичу (GMT) |
orderstate | Статус заказа |
Данныеоплательщике(секция<customer>) | |
firstname | Имя плательщика |
lastname | Фамилия плательщика |
middlename | Отчество плательщика |
Email плательщика | |
Параметрыоперации(повторяющаяся секция <operation>) | |
billnumber | Уникальный номер операции (расширенный формат: billnumber.<номер операции>) |
operationtype | Код типа операции |
operationstate | Состояние операции |
amount | Сумма операции |
currency | Валюта операции |
ipaddress | IP-адрес плательщика |
meantype_id | Тип платежного средства |
meansubtype | Подтип платежного средства |
meannumber | Номер платежного средства |
cardholder | Держатель платежного средства |
cardexpirationdate | Срок действия карты |
issuebank | Название банка-эмитента |
bankcountry | Страна банка-эмитента |
responsecode | Код возврата |
message | Сообщение о результате операции |
customermessage | Сообщение о результате для покупателя |
recommendation | Рекомендация |
approvalcode | Код авторизации |
protocoltypename | Протокол |
processingname | Процессинг |
operationdate | Дата и время операции (GMT) |
slipno | Номер финансовой транзакции, отправляемый в процессинг |
Свойствапакетаданных(внутри<result>) | |
packetdate | Дата формирования запроса по Гринвичу (GMT) |
signature | Подпись. Формируется по следующему алгоритму: 1. Формируется объединённая строка из параметров (в их строковом представлении, в формате как они переданы в ответе): billnumber, ordernumber, responsecode, amountorderamount, currencyordercurrency, meannumber, approvalcode, orderstate, packetdate (без разделителей). |
...