Запрос возврата на полную сумму в деньгах (refund)

Для возврата средств используется запрос refund.do (cм. координаты подключения).

Нельзя проводить отмены и возвраты по заказам, инициализирующим регулярные платежи, т. к. в этих случаях не происходит реального списания денег.

По этому запросу средства по указанному заказу будут возвращены плательщику. Запрос закончится ошибкой в случае, если средства по этому заказу не были списаны. Для выполнения операции возврата необходимо наличие соответствующих права в системе.

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

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.

Пользуясь протоколом REST, тело сообщения запроса следует отправлять с типом: 'Content-Type: application/x-www-form-urlencoded'.

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

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

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

userName

AN..30

Да

Логин служебной учётной записи продавца.

password

AN..200

Да

Пароль служебной учётной записи продавца.

orderId

ANS36

Да

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

amount

N..12

Да

Сумма платежа в минимальных единицах валюты.

jsonParams

Строка

Нет

Дополнительные параметры запроса. Формат вида: {«Имя1»: «Значение1», «Имя2»: «Значение2»}. При указании «showLoyalty»:«false» взаимодействие с сервисом лояльности осуществляться не будет.

При наличии пермиссий у Мерчанта Разрешена оплата ЭС и Считать ARes.Y (frictionless) как полный 3DS 2.0, здесь обязательным параметром передается:

Название	Тип	Описание
fes_cashboxId	N18	Идентификатор НСПК кассы Мерчанта, через которую осуществляется оплата ЭС

Если в запросе указать amount=0, производится возврат на всю сумму заказа.

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

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

Название	Тип	Обязательно	Описание
`errorCode`	N..2	Нет	Код ошибки. Может отсутствовать, если результат не привёл к ошибке.
`errorMessage`	AN..512	Нет	Описание ошибки на языке, переданном в параметре `language` в запросе.

Коды ошибок

Код ошибки	Текст ошибки
0	Обработка запроса прошла без системных ошибок.
5	Доступ запрещён.
5	Пользователь должен сменить свой пароль.
5	`[orderId]` не задан.
5	Неверная сумма.
6	Неверный номер заказа.
7	Платёж должен быть в корректном состоянии.
7	Сумма возврата превышает сумму списания.
7	Системная ошибка.

Примеры

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

userName=test-api&password=testPwd&orderId=148a2a67-25ff-7d1b-b28d-391800a7dca8&amount=101000

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

{"errorCode":0}