Запрос отмены неоплаченного заказа (decline.do)

Для отмены незавершённого заказа используется запрос decline.do. После успешного выполнения этого запроса заказ переводится в состояние Отменён.

В настоящем документе при описании параметров запросов и ответов используются следующие обозначения типов данных:

  • A<n> – последовательность латинских букв длины <n>;
  • A..<n> – последовательность латинских букв длиной, не превышающей <n>;
  • N<n> – последовательность цифр длины <n>;
  • N..<n> – последовательность цифр длиной, не превышающей <n>;
  • AN<n> – последовательность латинских букв и цифр фиксированной длины <n>;
  • AN..<n> – последовательность латинских букв и цифр длиной, не превышающей <n>;
  • ANS<n> – последовательность латинских букв, цифр и символов фиксированной длины <n>
  • ANS..<n> – последовательность латинских букв, цифр и символов длиной, не превышающей <n>;
  • UTC – дата и время, при этом: дата должна быть передана без указания часового пояса, время московское, для протокола SOAP используется стандартная кодировка xs:dateTime.

Параметры запроса

Параметры запроса представлены в таблице ниже.

Название Тип Обязательно Описание

userName

AN..30

Да

Логин служебной учётной записи продавца. При передаче логина и пароля для аутентификации в платёжном шлюзе параметр token передавать не нужно.

password

AN..200

Да

Пароль служебной учётной записи продавца. При передаче логина и пароля для аутентификации в платёжном шлюзе параметр token передавать не нужно.

merchantLogin

ANS..255

Нет

Укажите имя мерчанта, для которого вы хотите отклонить заказ. Это может быть как логин основного мерчанта, так и логин дочернего мерчанта.

language

A2

Нет

Язык в кодировке ISO 639-1. Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию.

orderId

ANS36

обязательно указать или orderId, или orderNumber

Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует если регистрация заказа не удалась по причине ошибки, детализированной в ErrorCode.

orderNumber

ANS..32

обязательно указать или orderId, или orderNumber

Номер заказа в системе магазина.

Параметры ответа

Параметры ответа представлены в таблице ниже.

Название Тип Обязательно Описание

errorCode

N..2

Да

Код ошибки. Может отсутствовать, если результат не привёл к ошибке.

errorMessage

AN..512

Да

Описание ошибки на языке, переданном в параметре language в запросе.

Коды ошибок

Код ошибки Текст ошибки
8 Заказ в статусе, не подходящем для этого действия
8 Текущий пользователь не имеет доступа к указанному заказу
8 Продавец не имеет доступа к указанному заказу или заказ не существует
8 Параметры заказа [orderNumber] или [orderId] не заданы
8 Пользователь не имеет разрешения на отклонение заказов

Примеры

Пример запроса POST

https://server_and_context/rest/decline.do?userName=username&password=password&orderId=8cf0409e-857e-7f95-8ab1-b6810009d884&merchantLogin=merch_test418&language=ru&orderNumber=12345678

Пример ответа

{"errorCode":"0","errorMessage":"Success"}