Запрос завершения на полную сумму в деньгах (deposit.do)

Для запроса завершения ранее пред авторизованного заказа используется запрос deposit.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.

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

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

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

Название	Тип	Обязательно	Описание
`userName`	AN..30	Да	Логин служебной учётной записи продавца. При передаче логина и пароля для аутентификации в платёжном шлюзе параметр `token` передавать не нужно.
`password`	AN..200	Да	Пароль служебной учётной записи продавца. При передаче логина и пароля для аутентификации в платёжном шлюзе параметр `token` передавать не нужно.
`orderId`	ANS36	Да	Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует если регистрация заказа не удалась по причине ошибки, детализированной в ErrorCode.
`amount`	N..12	Да	Сумма платежа в копейках (или центах). Внимание!!! Если в этом параметре указать ноль, завершение произойдет на всю предавторизованную сумму.

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

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

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

amount=100&currency=643&language=ru&orderId=e5b59d3d-746b-4828-9da4-06f126e01b68&password=password&userName=userName

{"errorCode":0}