Запрос возврата средств оплаты заказа

Для возврата средств используется метод autoRefund.do. В запросе передаётся общая сумма возврата, состоящая из суммы в деньгах и суммы баллов.

При полном возврате сумма денег и сумма бонусных баллов возвращаются в соответствии с суммами при оплате. При частичном возврате суммы распределяются согласно пропорции денег и баллов при оплате.

Запрос закончится ошибкой в случае, если средства по этому заказу не были списаны. Система позволяет вернуть средства более 1 раза, но не более первоначальной суммы списания.

Данную операцию можно осуществлять при наличии соответствующих прав в системе.

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

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	Да	Логин магазина, полученный при подключении.
`password`	AN..200	Да	Пароль магазина, полученный при подключении.
`orderId`	ANS36	Да	Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует если регистрация заказа не удалась по причине ошибки, детализированной в ErrorCode.
`compositeRefundAmount`	N..20	Да	Сумма возврата, состоящая из суммы в деньгах и суммы баллов. Может быть меньше или равна остатку в заказе.
`language`	A2	Да	Язык в кодировке ISO 639-1. Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию.

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

Название	Тип	Обязательно	Описание
`errorCode`	N..2	Нет	Код ошибки. .
`errorMessage`	AN..512	Нет	Описание ошибки на языке, переданном в параметре `language` в запросе. .
Блок `operations`
`pcId`	AN..512	Нет	Идентификатор операции в процессинге лояльности. .
`operation`	AN..512	Да	Тип операции, возможны следующие значения: `PAYMENT`; `AWARD`; `REVERSE`; `REFUND_PAYMENT`; `REFUND_AWARD`. .
`transactionId`	AN..512	Нет	Идентификатор операции в платёжном шлюзе. .
`amount`	N..12	Нет	Сумма в баллах.
`successful`	AN..512	Да	Признак успешности операции, возможны следующие значения: `true` (успешно); `false` (неуспешно). .

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

https://3dsec.sberbank.ru/payment/rest/autoRefund.do?userName=login&password=password&orderId=62945d2e-3da5-42cf-b9c1-d456227ab51a&compositeRefundAmount=100000

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

{"operations":[{"pcId":2699144,"operation":"REFUND_PAYMENT","amount":1960,"successful":true,"transactionId":"1652"}, 
 {"pcId":2699145,"operation":"REFUND_AWARD","amount":98040,"successful":true,"transactionId":"1653"}],"errorCode":"0"}