Request for operation completion with the full pre-authorization amount, monetary funds (deposit.do)

The request used for completing a pre-authorized order is deposit.do.

This operation can be performed provided that the merchant has the corresponding permissions in the system.

In this document, the following data type conventions are used when describing request and response parameters:

A<n> – a sequence of Latin letters of length <n>;
A..<n> – a sequence of Latin letters with a length not exceeding <n>;
N<n> – a sequence of digits of length <n>;
N..<n> – a sequence of digits with a length not exceeding <n>;
AN<n> – a sequence of Latin letters and numbers of fixed length <n>;
AN.. <n> – a sequence of Latin letters and numbers with a length not exceeding <n>;
ANS<n> – a sequence of Latin letters, numbers and characters of fixed length <n>
ANS.. <n> – a sequence of Latin letters, numbers and characters with a length not exceeding <n>;
UTC – date and time, in this case: the date must be passed without specifying the time zone, Moscow time, for the SOAP protocol, the standard encoding xs: dateTime is used.

Request parameters

The request parameters are given in table below.

Name	Type	Mandatory	Description
`userName`	AN..30	Yes	Login of the service account of the merchant. If login and password are used for authentication during token registration, then the `token` parameter does not need to be passed.
`password`	AN..30	Yes	Merchant's service account password. If login and password are used for authentication during token registration, then the `token` parameter does not need to be passed.
`orderId`	ANS36	Yes	Identifier of the order in the payment system. It is unique within the system. Missing if order registration failed due to an error detailed in ErrorCode.
`amount`	N..12	Yes	The payment amount in kopecks (or cents). Attention! If zero is specified in this parameter, the completion will occur for the entire preauthorized amount.

The response parameters are given in table below.

Name	Type	Mandatory	Description
`errorCode`	N3	No	Error code. Can be missing if the result has not caused an error.
`errorMessage`	AN..512	No	Error description in the language passed in the `language` parameter in the request.

Error code	Error text
0	The request has been processed without system errors.
5	Access denied.
5	The user must change the password.
5	Incorrect amount.
5	The deposit amount must be equal to zero or not less than one roble.
6	Wrong order number.
6	Unregistered `orderId`.
7	Payment must be in the correct state.
7	System error.

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

{"errorCode":0}