Инструменты страницы
Запрос возврата на частичную сумму в деньгах, передача корзины (refundOrder)
Для частичного возврата средств используется запрос refundOrder
с обязательным указанием корзины возвращаемых товаров. По этому запросу средства по заказу будут возвращены плательщику.
Запрос закончится ошибкой, если средства по этому заказу не были списаны. Система позволяет вернуть средства более 1 раза, но не более первоначальной суммы списания.
Для подключения к тестовой службе (WSDL) используйте следующий адрес:
https://3dsec.sberbank.ru/payment/webservices/merchant-ws?wsdl.
Для безошибочной обработки запроса достаточно передать параметры quantity
и positionId
.
В запросе на возврат Корзина указывается в блоке refundItems
.
- В случае полного возврата заказа, передача корзины товаров необязательна.
- При возврате заказа на сумму отличную от суммы списания (кроме передачи значения «0») обязательно должна передаваться корзина товаров.
- В случае проведения нескольких возвратов по заказам с корзиной все они должны осуществляться только по алгоритму возврата с корзиной.
- Сумма возврата (в деньгах) в корзине не должна превышать подтверждённую денежную сумму оригинального заказа (для запросов
autoRefund
сравниваются композитные суммы денег и баллов). - Все товарные позиции корзины должны быть выражены в одной и той же валюте (если валюта позиций указывается), совпадающей с валютой оригинального заказа. Для Сбербанк «Спасибо» валюта заказа должна быть рубли РФ (643-RUB).
- В корзине запрещены для передачи товарные позиции, отсутствующие в оригинальном заказе. Происходит проверка наличия указанного товара в корзине запроса на возврат в изначальном заказе. Необходимо совпадение элементов
positionId
,name
,itemCode
. Если хотя бы одно из значений не совпадает, считается, что данная товарная позиция отсутствует в оригинальном заказе. - Значение элемента
quantity
в корзине запроса на завершение не должно превышать значение аналогичного параметра в корзине заказа на регистрацию. - Значение элемента
itemAmount
блокаitems
не должно превышать значение аналогичного параметра в оригинальном заказе. Для запросаautoRefund
система производит сравнение значения элементаitemAmount
блокаitems
с суммой денег и баллов по аналогичной позиции в оригинальном заказе. - Все параметры корзины проверяются на соответствие требуемому формату (длине).
В случае невыполнения хотя бы одного из указанных выше условий запрос возврата заказа считается неправильно сформированным и платёжный шлюз должен вернуть ошибку.
В настоящем документе при описании параметров запросов и ответов используются следующие обозначения типов данных:
- 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.
Параметры запроса
Название | Тип | Обязательно | Описание | Версия ФФД | |
---|---|---|---|---|---|
|
ANS36 | Да |
Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует, если регистрация заказа не удалась по причине ошибки, детализированной в errorCode. |
Все версии. |
|
|
N..12 | Да |
Сумма возврата в валюте заказа. Может быть меньше или равна остатку в заказе. |
Все версии. |
|
|
A2 | Нет |
Язык в кодировке ISO 639-1. Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию. |
Все версии. |
|
|
См. столбец с описанием. | Нет |
Дополнительные параметры заказа в формате объекта.
При осуществлении возврата заказа здесь, в случае необходимости, можно передавать размер удержания штрафа за возврат в виде параметра
В параметре запрещено передавать зарезервированные имена (в случае их передачи заказ может быть отклонен):
|
Все версии. |
|
|
Не актуально | Да |
Тег для передачи информации о возвращаемых товарах - номер позиции товара в запросе, название, детали, единица измерения, количество, валюта, код товара, скидка, выгода агента. |
Все версии. |
|
|
Блок данных для передачи дополнительных параметров ОФД | Да |
Некоторые параметры блока Передача этого блока возможна только при использовании следующих ОФД:
|
refundItems
refundItems
состоит из следующих элементов.
Обязательность параметров указана для использования в рамках блока. Если блок необязательный и отсутствует, то и параметры в него входящие не должны передаваться.
Название | Тип | Обязательно | Описание | Версия ФФД |
---|---|---|---|---|
|
Не актуально | Нет |
Элемент массива с атрибутами товарной позиции в корзине. Описание его атрибутов представлено ниже. |
Все версии. |
items
Обязательность параметров указана для использования в рамках блока. Если блок необязательный и отсутствует, то и параметры в него входящие не должны передаваться.
Название | Тип | Обязательно | Описание | Версия ФФД |
---|---|---|---|---|
|
ANS..12 | Да |
Уникальный идентификатор товарной позиции внутри корзины заказа. В зарегистрированной корзине должен быть товар с таким значением positionId, в противном случае заказ завершится ошибкой. |
Все версии. |
|
ANS..100 | Да |
Наименование или описание товарной позиции в свободной форме.
Используйте |
Все версии. |
|
Не актуально | Нет |
Дополнительный блок с параметрами описания товарной позиции. Описание его атрибутов представлено ниже. Ограничение размера поля - 1024 байт. |
Все версии. |
|
N..18 | Да |
Элемент, описывающий общее количество товарных позиций одного |
Все версии. |
|
N..12 | Да |
Сумма стоимости всех товарных позиций одного
При расчёте параметра |
Все версии. |
|
N3 | Нет |
Код валюты товарной позиции ISO 4217. Если не указан, считается равным валюте заказа. |
Все версии. |
|
ANS..100 | Да |
Номер (идентификатор) товарной позиции в системе магазина.
Во всех методах передача артикула |
Все версии. |
|
N..18 | Нет |
Дополнительный тег с атрибутами описания налога. Описание вложенных тегов представлено ниже. |
Все версии. |
|
N..18 | Нет |
Стоимость одной товарной позиции одного
|
Все версии. |
|
См. описание. | Нет |
Тэг, предназначенный для передачи набора атрибутов товарной позиции. Атрибуты следует указывать следующим образом.
<attributes name="название_атрибута_1">значение_атрибута_1</attributes> <attributes name="название_атрибута_2">значение_атрибута_2</attributes> См. описание ниже. |
1.05 и более поздние версии. |
itemAttributes
Название | Тип | Обязательно | Описание | Версия ФФД |
---|---|---|---|---|
|
N..2 |
Да |
Тип оплаты возможны следующие значения:
Приоритизация передачи значения происходит по следующему принципу (указано в убывающем порядке приоритета):
Для paymentMethod значением по умолчанию является 1 (полная предварительная оплата до момента передачи предмета расчета). |
1.05 и более поздние версии. |
|
N..2 |
Да |
Тип оплачиваемой позиции, возможны следующие значения:
Указанные выше значения доступны для ФФД 1.05.
Приоритизация передачи значения происходит по следующему принципу (указано в убывающем порядке приоритета):
Для paymentObject значением по умолчанию является 1 (товар). |
1.05 и более поздние версии. |
|
ANS | да (если передан markQuantity ) |
Код товарной позиции. Принимаются только первые 256 байт. Возможные форматы для передачи:
|
1.05 и более поздние версии. |
|
| Нет |
Дробное количество маркированного товара. |
1.2 и более поздние версии. |
|
ANS..64 | Нет |
Значение реквизита пользователя. Можно передавать только после согласования с ФНС. |
1.05 и более поздние версии. |
|
N..2 | Обязателен, только если передан объект agent_info . |
Тип агента, возможно одно из следующих значений:
|
1.05 и более поздние версии. |
|
|
Нет |
|
1.05 и более поздние версии. |
|
|
Нет |
|
1.05 и более поздние версии. |
|
Массив ANS..19 | Нет |
Массив телефонов оператора по приёму платежей в формате +N. |
1.05 и более поздние версии. |
|
Массив ANS..19 | Нет |
Массив телефонов оператора перевода в формате +N. |
1.05 и более поздние версии. |
|
ANS..64 | Нет |
Наименование оператора перевода. |
1.05 и более поздние версии. |
|
ANS..256 | Нет |
Адрес оператора перевода. |
1.05 и более поздние версии. |
|
N10..12 | Нет |
ИНН оператора перевода. |
1.05 и более поздние версии. |
|
Maccив ANS..19 | Нет |
Массив телефонов поставщика в формате +N. |
1.05 и более поздние версии. |
|
ANS..256 | Нет |
Наименование поставщика. |
1.05 и более поздние версии. |
|
N10..12 | Нет |
ИНН поставщика. |
1.05 и более поздние версии. |
quantity
quantity
состоит из следующих элементов.
Название | Тип | Обязательно | Описание | Версия ФФД |
---|---|---|---|---|
|
ANS..20 | Да |
Мера измерения количества товарной позиции. |
Все версии. |
Если ФФД версии 1.2 и более поздней, то здесь передаются параметры:
Название | Тип | Обязательно | Описание | Версия ФФД |
---|---|---|---|---|
|
N1 | Да |
Количество товарных позиций данного positionId. Для версии ФФД 1.2+ значение всегда 1. |
1.2 и более поздние версии. |
|
N..3 | Да |
Единица измерения количества предмета расчета. При ФФД версии 1.2+ , если переданы параметры nomenclature и markQuantity, значение всегда 0. В остальных случаях принимает значения |
1.2 и более поздние версии. |
Возможные значения measure
Значение | Описание |
---|---|
0 | Применяется для предметов расчета, которые могут быть реализованы поштучно или единицами (а также в случае, если предметом расчета является товар, подлежащий обязательной маркировке средством идентификации (передан mark_code )) |
10 | Грамм |
11 | Килограмм |
12 | Тонна |
20 | Сантиметр |
21 | Дециметр |
22 | Метр |
30 | Квадратный сантиметр |
31 | Квадратный дециметр |
32 | Квадратный метр |
40 | Миллилитр |
41 | Литр |
42 | Кубический метр |
50 | Киловатт час |
51 | Гигакалория |
70 | Сутки (день) |
71 | Час |
72 | Минута |
73 | Секунда |
80 | Килобайт |
81 | Мегабайт |
82 | Гигабайт |
83 | Терабайт |
255 | Применяется при использовании иных мер измерения |
markQuantity
Параметры тэга markQuantity:
Обязательность параметров указана для использования в рамках тэга. Если тэг необязательный и в запросе отсутствует, то и входящие в него параметры не должны передаваться.
Название | Тип | Обязательно | Описание |
---|---|---|---|
|
N..12 | да |
Числитель дробной части предмета расчета. |
|
N..12 | да |
Знаменатель дробной части предмета расчета. |
itemDetails
itemDetails
состоит из следующих элементов.
Обязательность параметров указана для использования в рамках блока. Если блок необязательный и отсутствует, то и параметры в него входящие не должны передаваться.
Название | Тип | Обязательно | Описание | Версия ФФД |
---|---|---|---|---|
|
ANS..255 | Да |
Параметр описывающий дополнительную информацию по товарной позиции. Описание его атрибутов представлено ниже. |
Все версии. |
itemDetailsParams
itemDetailsParams
состоит из следующих элементов.
Название | Тип | Обязательно | Описание | Версия ФФД |
---|---|---|---|---|
|
AN..255 | Да |
Наименование параметра описания детализации товарной позиции. |
Все версии. |
tax
tax
состоит из следующих элементов.
Обязательность параметров указана для использования в рамках блока. Если блок необязательный и отсутствует, то и параметры в него входящие не должны передаваться.
Название | Тип | Обязательно | Описание | |
---|---|---|---|---|
|
N..2 | Нет |
Ставка НДС, доступны следующие значения:
Если в запросе не передаётся корзина с данными фискализации, оператору фискальных данных передаются значения по умолчанию, указанные в настройках личного кабинета (подробнее см. инструкцию по работе с личным кабинетом). |
Все версии. |
|
N..18 | Нет |
Сумма налога, высчитанная продавцом. Указывается в минимальных единицах валюты. |
Все версии. |
additionalOfdParams
additionalOfdParams
состоит из следующих элементов.
Название | Тип | Обязательно | Описание | Версия ФФД |
---|---|---|---|---|
|
N..2 | Обязателен, только если передан объект agent_info . |
Тип агента, возможно одно из следующих значений:
|
1.05 и более поздние версии. |
|
|
Нет |
|
1.05 и более поздние версии. |
|
|
Нет |
|
1.05 и более поздние версии. |
|
Массив ANS..19 | Нет |
Массив телефонов оператора по приёму платежей в формате +N. |
1.05 и более поздние версии. |
|
ANS..256 | Нет |
Адрес оператора перевода. |
1.05 и более поздние версии. |
|
N10..12 | Нет |
ИНН оператора перевода. |
1.05 и более поздние версии. |
|
ANS..64 | Нет |
Наименование оператора перевода. |
1.05 и более поздние версии. |
|
Массив ANS..19 | Нет |
Массив телефонов оператора перевода в формате +N. |
1.05 и более поздние версии. |
|
Maccив ANS..19 | Нет |
Массив телефонов поставщика в формате +N. |
1.05 и более поздние версии. |
|
A..256 | Нет |
ФИО кассира При запросе на возврат значение этого параметра может отличаться от переданного при регистрации заказа. |
1.05 и более поздние версии. |
|
ANS..16 | Нет |
Дополнительный реквизит чека. При запросе на возврат значение этого параметра может отличаться от переданного при регистрации заказа. |
1.05 и более поздние версии. |
|
ANS..24 | Нет |
Наименование дополнительного реквизита пользователя. При запросе на возврат значение этого параметра может отличаться от переданного при регистрации заказа. |
1.05 и более поздние версии. |
|
ANS..24 | Нет |
Значение дополнительного реквизита пользователя. При запросе на возврат значение этого параметра может отличаться от переданного при регистрации заказа. |
1.05 и более поздние версии. |
|
N..12 | Нет |
ИНН кассира |
1.2 и более поздние версии. |
|
ANS..256 | Нет |
Адрес покупателя (клиента). |
1.2 и более поздние версии. |
|
NS10 | Нет |
Дата рождения покупателя (клиента) в формате «dd.mm.yyyy» |
1.2 и более поздние версии. |
|
N3 | Нет |
Числовой код страны, гражданином которой является покупатель (клиент). Код страны указывается в соответствии с Общероссийским классификатором стран мира ОКСМ. |
1.2 и более поздние версии. |
|
N2 | Нет |
Числовой код вида документа, удостоверяющего личность (например, 21 - паспорт гр. РФ). |
1.2 и более поздние версии. |
|
NS11 | Нет |
Серия и номер паспорта плательщика: |
1.2 и более поздние версии. |
|
ANS..64 | Нет |
Электронный адрес покупателя. Обязательно должно быть заполнено строго одно из полей: |
1.2 и более поздние версии. |
|
NS..19 | Нет |
Телефон покупателя. Вместе с кодом страны без пробелов и дополнительных символов, кроме символа «+» (номер «+371 2 1234567» необходимо передать как «+37121234567»). Обязательно должно быть заполнено строго одно из полей: |
1.2 и более поздние версии. |
|
N12 | Нет |
ИНН покупателя. |
1.2 и более поздние версии. |
|
ANS..256 | Нет |
Наименование покупателя (клиента). |
1.2 и более поздние версии. |
|
|
Нет |
|
1.2 и более поздние версии. |
|
|
Нет |
|
1.2 и более поздние версии. |
|
|
Нет |
|
1.2 и более поздние версии. |
|
|
Нет |
|
1.2 и более поздние версии. |
|
NS10 | Нет |
Дата нормативного акта федерального органа исполнительной власти, регламентирующего порядок заполнения реквизита «значение отраслевого реквизита», в формате: |
1.2 и более поздние версии. |
|
ANS | Нет |
Идентификатор ФОИВ. Должно принимать одно из значений справочника ФОИВ. |
1.2 и более поздние версии. |
|
N..32 | Нет |
Номер нормативного акта федерального органа исполнительной власти, регламентирующего порядок заполнения реквизита «значение отраслевого реквизита» |
1.2 и более поздние версии. |
|
ANS..256 | Нет |
Состав значений, определенных нормативным актом федерального органа исполнительной власти |
1.2 и более поздние версии. |
Параметры ответа
Название | Тип | Обязательно | Описание | Версия ФФД |
---|---|---|---|---|
|
N..2 | Нет |
Код ошибки. |
Все версии. |
|
|
Нет |
|
Все версии. |
Коды ошибок
Значение | Описание |
---|---|
0 |
Успешно. |
5 |
Доступ запрещён. |
5 |
Пользователь должен сменить свой пароль. |
5 |
|
5 |
Неверная сумма. |
6 |
Неверный номер заказа. |
7 |
Платёж должен быть в корректном состоянии. |
7 |
Сумма возврата превышает сумму списания. |
7 |
Системная ошибка. |
Примеры
Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://engine.paymentgate.ru/webservices/merchant"> </soapenv:Header> <soapenv:Body> <mer:refundOrder> <order language="ru" orderId="2caa983e-d7bb-7f3d-9338-8e410128092a" refundAmount="23500"> <refundItems> <!-- Zero or more repetitions: --> <items positionId="1"> <name>"По-аджарски \"Лодочка"\" SMALL"</name> <quantity measure="0">1</quantity> <itemCode>270_235.00</itemCode> <itemPrice>23500</itemPrice> <tax> <taxType>0</taxType> <taxSum>0</taxSum> </tax> <itemAttributes> <attributes name="nomenclature">010463003407001221CMK45BrhN0WLf</attributes> <attributes name="paymentMethod">1</attributes> <attributes name="paymentObject">30</attributes> <attributes name="agent_info.type">7</attributes> <attributes name="agent_info.paying.operation">testoperation</attributes> <attributes name="agent_info.paying.phones">+79123456789</attributes> <attributes name="agent_info.paymentsOperator.phones">+79123456789</attributes> <attributes name="agent_info.MTOperator.phones">+79123456789</attributes> <attributes name="agent_info.MTOperator.name">MT operator</attributes> <attributes name="agent_info.MTOperator.address">Moscow</attributes> <attributes name="agent_info.MTOperator.inn">8634330204</attributes> <attributes name="supplier_info.phones">+79123456789</attributes> <attributes name="supplier_info.name">Supplier</attributes> <attributes name="supplier_info.inn">287381373424</attributes> <attributes name="excise">10.0</attributes> <attributes name="country_code">810</attributes> <attributes name="declaration_number">12332234533</attributes> <attributes name="userData">user data</attributes> <attributes name="markQuantity.numerator">1</attributes> <attributes name="markQuantity.denominator">2</attributes> <attributes name="sectoralItemProps[0].federalId">001</attributes> <attributes name="sectoralItemProps[0].date">10.10.2021</attributes> <attributes name="sectoralItemProps[0].number">123/4567</attributes> <attributes name="sectoralItemProps[0].value">value1</attributes> <attributes name="sectoralItemProps[1].federalId">003</attributes> <attributes name="sectoralItemProps[1].date">10.10.2021</attributes> <attributes name="sectoralItemProps[1].number">321/4567</attributes> <attributes name="sectoralItemProps[1].value">value2</attributes> </itemAttributes> </items> </refundItems> </order> </mer:refundOrder> </soapenv:Body> </soapenv:Envelope>
Пример запроса с передачей параметра penalty
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mer="http://engine.paymentgate.ru/webservices/merchant"> <soapenv:Header> <soapenv:Body> <mer:refundOrder> <order language="ru" orderId="cc467c24-0e0d-762c-8c75-12b700a39301" refundAmount="250000"> <refundItems> <!--Zero or more repetitions:--> <items positionId="1"> <name>da</name> <!--Optional:--> <itemDetails> <!--Zero or more repetitions:--> <itemDetailsParams name="?">?</itemDetailsParams> </itemDetails> <quantity measure="qtqwt">1</quantity> <itemAmount>250000</itemAmount> <!--Optional:--> <itemCode>50248</itemCode> <itemPrice>250000</itemPrice> <!--Optional:--> <itemAttributes> <!--Zero or more repetitions:--> <attributes name="paymentMethod">4</attributes> <attributes name="paymentObject">10</attributes> </itemAttributes> </items> </refundItems> <!--Zero or more repetitions:--> <params name="penalty" value="2000"/> <!--Optional:--> </order> </mer:refundOrder> </soapenv:Body> </soapenv:Envelope>
Пример ответа
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns1:refundOrderResponse xmlns:ns1="http://engine.paymentgate.ru/webservices/merchant"> <return errorCode="0" errorMessage="Успешно"/> </ns1:refundOrderResponse> </soap:Body> </soap:Envelope>