Описание сервиса
URL запроса для формата HTTP POST: https://<SERVER-NAME>/cancel/cancel.cfm
URL запроса для формата SOAP: https://<SERVER-NAME>/cancel/wscancel.cfm, параметры передаются SOAP запросом, либо в формате JSON (swagger описание: https://docs.assist.ru/swagger/).
Список параметров запроса:
Название | Обязательное поле | Принимаемые значения | Значение по умолчанию | Описание |
Billnumber | Да | 15 или 16 цифр Расширенный формат | Номер платежа, соответствующий заказу в системе АПК Ассист, передача расширенного номера платежа допускается только в том случае, если в заказе не передается чек. | |
Merchant_ID | Да | Число | Идентификатор предприятия в АПК Ассист | |
Login | Да | 8 - 20 символов | Логин (лат. буквы и цифры, символ _) | |
Password | Да | 8 - 20 символов | Пароль (лат. буквы и цифры) | |
Amount | Нет1 | Число, 15 цифр (разделитель «.») | Сумма авторизации | Сумма возврата средств |
Currency | Нет1 | 3 символа | Код валюты авторизации | Код валюты отмены или возврата средств. Может быть использован только код валюты авторизации |
CancelReason | Нет | 1 – Отказ магазина | 1 | Причина отмены или возврата |
Language | Нет | RU – русский | RU | Язык выдачи результатов |
ClientIP | Нет | Максимум 15 цифр, 4 разделителя «.» | IP компьютера оператора, производящего отмену/возврат. | |
Format | Нет | 1 – CSV | Формат входных данных | Формат выдачи результатов |
1 Параметры Amount, Currency могут присутствовать или отсутствовать в запросе только одновременно. В случае отсутствия параметров операция отмены оплаты будет проведена на полную сумму.
Все параметры, передаваемые в запросе, проходят автоматическую валидацию в АПК Ассист. Правила валидации описаны в табл. "Правила валидации входных параметров".
Для совершения операции отмены можно передать параметр billnumber как в обычном формате (если по заказу была одна успешная операция оплаты), так и в расширенном формате. При использовании расширенного формата обязательно должен быть указан номер успешной операции оплаты (в некоторых случаях это может быть не первая по счету операция, например,5111111000965142.2).
Внимание! Передача расширенного номера платежа допускается только в том случае, если в заказе не передается чек.
Отмена или возврат средств является успешной, если код возврата операции отмены responsecode AS000 (операция успешно завершена), оба кода firstcode=0, secondcode=0, статус заказа при этом становится Canceled (Отменен) или PartialCanceled (Отменен частично).
Для неуспешной отмены код возврата responsecode принимает значения AS100-AS998. Если запрос на возврат или отмену не может быть обработан, в результате запроса вернутся ненулевые значения параметров firstcode, secondcode.
Тип совершаемой транзакции (on-line отмена, возврат средств (refund), отмена финансовой транзакции, частичная отмена) будет определен системой АПК Ассист автоматически в зависимости от суммы (полная или частичная отмена), процессинга, типа карты, наличия финансовой транзакции для родительской авторизации и причины возврата.
Интерфейс для формата HTTP POST (cancel)
Пример запроса HTTP POST для отмены оплаты по банковской карте: