Для того чтобы отменить счёт и осуществить возврат денежных средств клиенту (refund), необходимо вызвать функции веб-сервиса disableInvoice, disableInvoiceExA или disableInvoiceExB.
- disableInvoice – функция простой отмены счёта. Счёт удаляется. В случае если счёт оплачен, средства возвращаются клиенту в полном объёме;
- disableInvoiceExA – функция отмены счёта с указанием суммы возврата (частичная отмена). Счёт удаляется. В случае если счёт оплачен, средства возвращаются клиенту в размере указанной суммы;
- disableInvoiceExB – функция отмены счёта с указанием штрафной суммы (частичная отмена). Счёт удаляется. В случае если счёт оплачен, средства возвращаются клиенту в размере суммы счёта за вычетом указанной суммы штрафа.
disableInvoice |
|
---|---|
Параметр |
Описание |
ucode |
Уникальный номер счёта в системе «Инвойсбокс» |
ident |
Уникальный идентификатор возврата в системе учёта магазина |
sign |
Подпись запроса |
disableInvoiceExA |
|
Параметр |
Описание |
ucode |
Уникальный номер счёта в системе «Инвойсбокс» |
ident |
Уникальный идентификатор возврата в системе учёта магазина |
basket |
Состав корзины для возврата |
comment |
Причина осуществления частичного возврата, комментарий - почему клиенту возвращается не полная сумма |
amount |
Сумма возврата, но не более суммы счёта, должна соответствовать сумме элементов корзины |
sign |
Подпись запроса |
disableInvoiceExB |
|
Параметр |
Описание |
ucode |
Уникальный номер счёта в системе «Инвойсбокс» |
ident |
Уникальный идентификатор возврата в системе учёта магазина |
comment |
Причина осуществления частичного возврата, почему клиенту возвращается не полная сумма |
penalty |
Сумма штрафа, но не более суммы счёта |
sign |
Подпись запроса |
Параметр |
Описание |
Значения |
|
---|---|---|---|
ident |
Уникальный идентификатор позиции в исходном заказе |
Строка |
|
name |
Наименование товара или услуги |
Строка |
Обязательно |
quantity |
Количество возвращаемого товара или услуги |
Число |
Обязательно |
measure |
Единица измерения |
Строка: шт., комплект, литры, кг, тонны и т.п. |
Обязательно |
price |
Стоимость возврата за 1 единицу |
Число |
Обязательно |
vatrate |
Значение ставки налога на добавленную стоимость (НДС) (см. параметры платёжной формы) |
Число |
Обязательно |
vat |
Сумма налога на добавленную стоимость (НДС) за 1 единицу |
Число |
Обязательно |
Подпись запроса
При использовании базового варианта безопасности с MD5, магазину необходимо добавить в запросы параметр с именем sign (подпись запроса). Значение параметра — MD5-хэш от строки, собранной из значений параметров этого же запроса вместе с ключом безопасности.
При получении запроса от магазина, система «Инвойсбокс» будет проверять параметр подписи sign. Если значение sign не совпадает с результатом расчёта хэш-функции MD5 от переданных параметров, в обработке запроса будет отказано.
MD5-хэширование применяется к тексту, который формируется как последовательность значений ряда параметров запроса без разделителей. Результат хэширования приводится к нижнему регистру.
Порядок следования параметров:
disableInvoice
disableInvoiceExA
disableInvoiceExB
Параметр |
Описание |
---|---|
resultCode |
Код результата выполнения функции |
resultMessage |
Описание кода результата выполнения функции |
В случае успешного выполнения функции, веб-сервис вернёт значение resultCode=0. В случае возникновения ошибки, веб-сервис вернёт детальное описание такой ошибки в параметре resultMessage, при этом значение параметра resultCode не будет равняться нулю.