Запрос прав на регистрацию чеков в сервисе Мой налог
The mass payouts protocol is now outdated. If you want to make payouts via the API, use the YooMoney API.
Чтобы при выплатах ЮKassa автоматически регистрировала чеки, нужно получить от самозанятого ИНН и разрешение для ЮMoney на регистрацию чеков в сервисе Мой налог. Для этого используйте специальную форму ЮKassa.
Форма для запроса прав в сервисе Мой налог
Сценарий взаимодействия
- Вы объясняете получателю выплаты, что ему нужно выдать разрешение ЮMoney для автоматической регистрации чеков в сервисе Мой налог.
- Получатель выплаты переходит к вводу данных.
- Вы перенаправляете получателя выплаты на форму.
- Получатель выплаты вводит данные и нажимает Отправить.
- ЮKassa запрашивает права в сервисе Мой налог.
- Сервис Мой налог возвращает ЮKassa ответ.
- ЮKassa перенаправляет получателя выплаты на страницу успеха или неудачи на вашей стороне и сообщает вам результат.
In case of success, YooMoney will return to you the user's (INN) TIN and current rights granting status. Redirecting to the success page doesn't guarantee that the self-employed individual gave their consent to record receipts. It only reports a successful request for granting rights.
In order to grant the rights, the payout recipient needs to go to the My Tax service and give their consent to record receipts.
Если после отправки формы вы получили статус Ожидает подтверждения, вам нужно самостоятельно проконтролировать, что получатель выплаты выдал разрешение ЮMoney в сервисе Мой налог.
Форма для запроса прав
To request the rights for receipt recording, you need to redirect the self-employed individual to the form placed on YooMoney's side.
Step 1. Generate the link to redirect the payout recipient to the form. Add the following parameters to the address where the form is placed: the ID of your gateway in YooMoney, URL of the page that the user will return to after successfully adding the data, as well as the URL of the page they will return to in case something goes wrong during the process of sending the data.
You can add any other parameters that you need for processing (for example, the payout recipient ID in your system) to the form address. YooMoney will return the additional parameters without changes.
URL of the YooMoney form
https://yookassa.ru/self-employed-boarding
Описание параметров
Parameter | Type | Description |
---|---|---|
agentId | xs:long | Идентификатор вашего шлюза. Выдается ЮKassa. Required parameter |
success_url | xs:string, up to 250 characters | Адрес страницы, на которую вернется получатель выплаты при успешной отправке данных. Required parameter |
fail_url | xs:string, up to 250 characters | Адрес страницы, на которую вернется получатель выплаты в случае ошибки, например если он не имеет статуса самозанятого или на сервис Мой налог недоступен. Required parameter |
Any names not listed above | xs:string, 4096 characters (total length of all parameters) | Parameters added to the form address will be saved and used in the address success_url or fail_url when you receive the response after the form is sent.Optional parameter |
Пример ссылки для перенаправления
https://yookassa.ru/self-employed-boarding?agentId=123&success_url=https://example.com/success&fail_url=https://example.com/fail
Example of a redirect link with additional parameters
https://yookassa.ru/self-employed-boarding?agentId=123&success_url=https://example.com/success&fail_url=https://example.com/fail&employee_id=456
Step 2. Разместите на вашем сайте элемент, с помощью которого получатель выплаты будет перенаправлен на форму ЮKassa. For example, place the button that will redirect the user to the link you've generated.
Step 3. Process the response after the form is sent.
Done!
Ответ после отправки формы
После отправки формы ЮKassa перенаправляет получателя выплаты GET-методом на адрес, указанный в
success_url
или fail_url
.В случае успеха к адресу добавляется ИНН пользователя и статус выдачи прав, а в случае неудачи — описание ошибки. If you've provided additional parameters, YooMoney will use them in the address without changes.
Parameter | Type | Description |
---|---|---|
itn | xs:string, 12 символов | ИНН самозанятого. Обязательный параметр при успехе |
status | xs:string | Статус выдачи прав ЮKassa:
Обязательный параметр при успехе |
error | xs:string | Описание ошибки. Возможные значения:
Обязательный параметр при неудаче |
Пример ответа при успехе
https://example.com/success/?itn=123456789012&status=Confirmed
Пример ответа при неудаче
https://example.com/fail/?error=unregistered
See also