Запрос прав на регистрацию чеков в сервисе Мой налог
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 в сервисе Мой налог.
Форма для запроса прав
Разместите на вашем сайте элемент, с помощью которого получатель выплаты будет перенаправлен на форму ЮKassa. Например, разместите кнопку, при нажатии на которую получатель будет переходить на форму.
Адрес для отправки формы
https://yookassa.ru/self-employed-boarding
К ссылке добавьте идентификатор вашего шлюза в ЮKassa, адрес страницы, на которую самозанятый вернется в случае успешной отправки данных, и адрес страницы, на которую он вернется, если при отправке данных что-то пойдет не так.
Описание параметров
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 |
Пример ссылки для перенаправления
https://yookassa.ru/self-employed-boarding?agentId=123&success_url=https://example.com/success&fail_url=https://example.com/fail
Вы можете добавить к ссылке любые другие параметры, например идентификатор получателя выплаты в вашей системе. ЮKassa вернет дополнительные параметры без изменений.
Пример ссылки с дополнительными параметрами
https://yookassa.ru/self-employed-boarding?agentId=123&success_url=https://example.com/success&fail_url=https://example.com/fail&employee_id=456
Ответ после отправки формы
После отправки формы ЮKassa перенаправляет получателя выплаты GET-методом на адрес, указанный в
success_url
или fail_url
.В случае успеха к адресу добавляется ИНН пользователя и статус выдачи прав, а в случае неудачи — описание ошибки. Если вы использовали дополнительные параметры, ЮKassa также добавит их к адресу.
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