Рокет Ворк | API
Оглавление
Сделки и договоры
Постбэки об изменениях сделок и Подписки
-
Запросы
История постбэков
Создание и получение данных о счете организации
Создание и получение данных об исполнителях
Термины
-
Исполнитель — физическое лицо, работающее на основании Федерального закона, либо ином юридическом статусе и являющееся клиентом платформы.
-
Сделка — запрос на оказание услуг/продажу товара, доступный для акцепта либо неограниченному, либо ограниченному кругу исполнителей (в том числе единственным исполнителем).
-
Заказчик — организация-клиент Платформы, которая выступает заказчиком услуг Исполнителей.
-
Сервис (или Платформа) — программный продукт Рокет Ворк.
-
Покупатель — физическое лицо, оплачивающее услугу/товар напрямую у Заказчика, либо у Заказчика, как у агента Исполнителя.
-
Профиль — учетные данные компании.
1. Сделки и договоры ¶
Сделки ¶
Сделки — это готовые к заключению и/или заключенные договоры об оказании услуг с самозанятыми-исполнителями. Заказчик, работающий по такой системе через Рокет Ворк, может:
-
создавать сделки;
-
изменять уже созданные сделки:
- передавать в работу исполнителю;
- подтверждать полное и корректное выполнение сделки;
-
поручать оплату по выполненной сделке;
-
получать информацию о существующей сделке.
Фильтры сделок
| Фильтр | Описание | Пример |
|---|---|---|
acquiring |
Наличие информации о платеже | true |
linked_task_id |
Идентификатор связанной задачи | 1 |
executor_inns[] |
Список ИНН исполнителя | 1234567890 |
executor_phones[] |
Список телефонов исполнителя | 0987654321 |
statuses[] |
Статусы задачи | in_progress |
types[] |
Типы задач | OneTimeTask |
acquiring_order_statuses[] |
Статус оплаты | draft |
created_at[from] |
Начальная дата создания задачи | 2023-09-16T06:39:49 03:00 |
created_at[to] |
Конечная дата создания задачи | 2023-11-17T06:41:49 03:00 |
Структура сделки:
-
id— уникальный идентификатор; -
type— тип сделки; -
agreement_signing_uri— ссылка для подписания договора исполнителем; -
acceptance_signing_uri— ссылка для подписания акта выполненных работ; -
agreement_type_id— идентификатор шаблона договора; -
agreement_uri— ссылка на договор с исполнителем; -
acceptance_uri— ссылка на акт выполненных работ; -
period_from— дата начала выполнения сделки или действия договора; -
period_to— дата окончания выполнения сделки или действия договора; -
period_duration— срок выполнения сделки или действия договора. Значение по умолчанию: 30. -
category— категория (тип) сделки; -
created_at— дата и время создания; -
date— дата запланированного выполнения сделки; -
description— описание сделки; -
document_number— номер договора, заключенного с исполнителем; -
document_date— дата договора, заключенного с исполнителем; -
additional_info— дополнительные указания к сделке; -
amount_gross— предлагаемая стоимость сделки до вычета налогов (в рублях РФ); -
metadata— дополнительные данные о сделке (например, код подразделения/услуг для 1С, количество оказанных услуг, цену услуги); -
paid_at— дата и время оплаты сделки; -
payment_errors— ошибки, которые возникли во время последней неудачной попытки оплаты по сделке; -
receipt_uri— ссылка на чек на сайте nalog.ru; -
employment_kind— предпочитаемый тип занятости исполнителя: СМЗ, ГПХ, ИП или ДЛ. Может принимать значения: selfemployed, civil_contract, entrepreneur и confidant; -
current_employment_kind- тип занятости, который указали при заключении сделки. Может принимать значения: selfemployed, civil_contract, entrepreneur и confidant; -
act_required— требуется ли акт выполненных работ. Значение по умолчанию — false; -
executor_signed_at— дата подписания договора со стороны исполнителя; -
signed_at— дата подписания договора со стороны заказчика; -
signature_form— вариант подписания договора: на платформе или вручную. Возможные значения: online и manual. Значение manual определяется автоматически при создании сделки, если переданыdocument_numberиdocument_date; -
external_id— идентификатор сделки в системе заказчика; -
commission— размер комиссии по сделке; -
refund_amount— размер возврата по сделке в рублях (используется только при возврате). В случае с карточными возвратами фактическое зачисление на карту может осуществляться в среднем до 7 рабочих дней, в некоторых случая до 45 дней; -
status— статус сделки, один из:draft— «Черновик» — сделка создана, ожидает подписания со стороны исполнителя;inwork— «В работе» — договор подписан, исполнитель выполняет порученную работу;accepting— «На подпись» — у сделки есть акт выполненных работ, ожидающий подписания со стороны заказчика;completed— «На оплату» — работа выполнена, сделку можно отправлять на оплату;paying— «В процессе» — сформирован платеж исполнителю;paid— «Завершённое» — платеж проведен, сформирован чек;canceled— «Неактивное» — сделка была отменена до подписания договора и выполнения работы;error— «Ошибка оплаты» — в процессе оплаты возникли ошибки;
-
title— название сделки; -
executor— данные об исполнителе сделки; -
additional_commission_from— признак наличия дополнительной комиссии в пользу заказчика.client- комиссия с покупателя (только при заполнении acquiring_order),executor- комиссия с исполнителя (только при заполнении executor_inn / executor); -
additional_commission_value— размер дополнительной комиссии, при передаче значения с знаком%- комиссия процентная, без знака процента - фиксированная; -
additional_commission_included— дополнительной комиссии включена в стоимость сделки (доступно только при эквайринге дляadditional_commission_from:client, по умолчанию:true) -
additional_commission_ofd_url— ссылка на ОФД чек за дополнительную комиссию; -
refund_additional_commission_ofd_url— ссылка на ОФД чек возврата за дополнительную комиссию; -
additional_commission_beneficiary— Бенефициар дополнительной комиссии, по умолчаниюhimself. Можно указать ИНН юридического лица на платформе, в пользу которого будет удерживаться дополнительная комиссия; -
additional_commission_ofd_receipt— Чек на дополнительную комиссию, по умолчаниюtrue; -
additional_commission_result— размер удержанной дополнительной комиссии в пользу заказчика по сделке; -
autopayable— признак автоматического старта оплаты сделки; -
autosignable— признак автоматического старта подписи акта выполненных работ Заказчиком после подписи Исполнителем; -
acquiring_order— информация о статусе оплаты сделки покупателем с помощью банковской картой, СБП (через QR) или помощи сервиса SoftPOS;type— тип оплаты.CARD— банковская карта,QR— СБП через QR код,SoftPOS- при помощи сервиса SoftPOS;client_name— имя покупателя;client_phone— телефон покупателя;client_email— email покупателя;order_id— номер сделки в системе учета заказчика;url— ссылка для оплаты сделки. При оплате банковской картой ведёт на страницу эквайринга. При оплате СБП на страницу с QR кодом;payment_purpose— описание сделки для ее оплаты;without_executor— флаг отсутствия исполнителя по сделке;with_ofd_receipt— флаг формирования ОФД чека на полную сумму оплаты;ofd_url— ссылка на ОФД чек, появляется при переходе в статусtransfered, еслиwith_ofd_receiptпринимает значениеtrue;commission_type— признак оплаты комиссии за эквайринг.from_customer— комиссия спишется с заказчика, после зачисления денег на номинальный счет.from_client— комиссию оплачивает покупатель, в момент списания денег. В этом случае сумма оплаты для покупателя увеличится на сумму комиссии;ofd_commission_url— ссылка на ОФД чек об оплате комиссии клиентом, появляется при переходе в статусtransfered, еслиcommission_typeпринимает значениеfrom_client;redirect_url— ссылка для перенаправления клиента после успешной оплаты (для типовCARDиQR);pan_mask— замаскированный PAN карты плательщика (для типаCARD);transaction_id— id эквайринговой транзакции для совершения последующий рекуррентных платежей (для типаCARD);check_card— оплата с предавторизацией и автоматической отменой сделки для проверки валидности карты (для типаCARD);recurrent— дляrecurrent_transaction_id— идентификатор операции для рекуррентного платежа;lifetime— Время жизни ссылки для оплаты в секундах, от 5 мин (300) до 24 часов (86400), по умолчанию 1 час;vat— наличие НДС в оплате, один из:VatNo— НДС не облагается;Vat0— НДС 0%;Vat10— НДС 10%;Vat20— НДС 20%;
status— статус оплаты сделки, один из:pending— идёт генерация ссылки для оплаты;paying— ссылка для оплаты готова, ожидается оплата;failed— оплата не прошла, надо повторить генерацию ссылки для оплаты;expired— истёк срок действия ссылки для оплаты (1 час);paid— сделка оплачена покупателем;transfered— деньги переведены на номинальный счёт, можно оплачивать сделку исполнителю;refunding— инициирован возврат средств покупателю при отмене уже оплаченной сделки;refunded— средства возвращены;
-
services— услуги в рамках сделки:order— порядковый номер услуги;description— описание услуги;unit_price_cents— цена одной услуги (в копейках);quantity— количество оказываемых услуг;total_price_cents— стоимость услуги (цена * количество);location— место оказания услуги;unit— единицы измерения услуги, либо значение тега 1212 для чеков ОФД;payment_method_for_ofd— признак способа расчета для чеков ОФД (тег 1214)
-
payment_info— информация о выплате по сделке: дата проведения операции, платежные реквизиты получателя (только для сделок в статусеpaid)channel— канал оплаты (card— банковская карта,sbp— СБП,requisites— по номеру счёта);account— номер счёта получателя (дляcard— номер карты, дляsbp— номер телефона, дляrequisites— номер счёта);rrn— RRN платежа (только для каналаcard)nspk_id— идентификатор платежа в системе СБП (только для каналаsbp)bank_bic— БИК банкаbank_name— название банкаbank_nspk_id— идентификатор банка в системе НСПКbank_paid_at— дата проведения операции по системе банка
Параметры для создания сделки:
| Параметр | Тип | Обязательное? | Описание |
|---|---|---|---|
type |
str | Нет | Тип сделки. Варианты:OneTime — единоразовая сделкаWithdrawal — для вывода собственных средствПо умолчанию OneTime |
description |
str | Да | Описание сделки. В случае необходимости разделения описания на несколько пунктов требуется заполнение описаний в services (см. ниже) |
executor |
str | Да* | Телефон исполнителя (*если не указан ИНН) |
executor_inn |
str | Да* | ИНН исполнителя (*если не указан телефон, при наличии) |
title |
str | Да | Заголовок сделки |
category |
str | Да | Категория сделки. Используется для поиска шаблона договора, если не передан параметр document_name |
amount_gross |
float | Да | Предлагаемая стоимость сделки до вычета налогов (в рублях РФ) |
external_id |
str | Нет | Внешний идентификатор сделки в системе заказчика |
document_name |
str | Нет | Название шаблона договора из личного кабинета |
document_number |
str | Нет | Номер договора, заключенного с исполнителем |
document_date |
str | Нет | Дата договора, заключенного с исполнителем. Формат DD.MM.YYYY |
period_from |
str | Нет | Дата начала действия договора (при подписании договора на платформе) |
period_to |
str | Нет | Дата окончания действия договора (при подписании договора на платформе) |
period_duration |
int | Нет | Период действия договора. По умолчанию 30 дней с даты создания сделки |
additional_info |
str | Нет | Дополнительные указания к сделке |
metadata |
json | Нет | Дополнительные данные о сделке (например, код подразделения/услуг для 1С, количество оказанных услуг, цену услуги) |
type_of_executor |
str | Нет | Вариант работы с исполнителем: СМЗ, ГПХ или ИП |
employment_kind |
str | Нет | Вариант работы с исполнителем (EN). Варианты:selfemployed — самозанятыйcivil_contract — ГПХentrepreneur — ИП |
act_required |
bool | Нет | Требуется ли акт выполненных работ. По умолчанию false |
autocomplete |
bool | Нет | Формирование сделки в статусе completed.По умолчанию — false Статус completed ставится, если параметр act_required принимает значение false |
autopayable |
bool | Нет | Признак автоматического старта оплаты сделки после завершения работ. По умолчанию — false |
autosignable |
bool | Нет | Признак автоматического старта подписи акта выполненных работ Заказчиком после подписи Исполнителем. По умолчанию — falseb> |
tax_retention |
bool | Нет | Признак удержания налога по текущей сделке. По умолчанию true |
additional_commission_from |
string | Нет | Признак наличия дополнительной комиссии в пользу заказчика. client - комиссия с покупателя (только при заполнении acquiring_order), executor - комиссия с исполнителя (только при заполнении executor_inn / executor). |
additional_commission_value |
string | Нет | Размер дополнительной комиссии. Значение переданное с знаком % - процент, без знака % - фиксированная комиссия. |
additional_commission_included |
bool | Нет | Дополнительной комиссии включена в стоимость сделки (при отключении комиссия будет прибавляться сверху к сумме сделки amount_gross, отключение доступно только при эквайринге для additional_commission_from: client, по умолчанию: true) |
additional_commission_beneficiary |
string | Нет | Бенефициар дополнительной комиссии, по умолчанию himself. Можно указать ИНН юридического лица на платформе, в пользу которого будет удерживаться дополнительная комиссия. |
additional_commission_ofd_receipt |
bool | Нет | Чек на дополнительную комиссию, по умолчанию true. |
acquiring_order |
json | Нет | Параметры для формирования оплаты сделки |
acquiring_order[type] |
enum | Да | Вариант оплаты:CARD — банковской картой через интернет-эквайрингQR — СБП через QR кодSoftPOS — физической картой через 2can SoftPOS |
acquiring_order[order_id] |
str | Нет | Номер сделки в системе партнёра |
acquiring_order[client_name] |
str | Нет | Имя покупателя для персонализации страницы оплаты сделки банковской картой |
acquiring_order[client_phone] |
str | Нет | Телефон покупателя для персонализации страницы оплаты сделки банковской картой (например, +79261234567) |
acquiring_order[client_email] |
str | Нет | Email покупателя для персонализации страницы оплаты сделки банковской картой и отправки письма со ссылкой на оплату |
acquiring_order[without_executor] |
bool | Нет | Флаг отсутствия исполнителя по сделке. По умолчанию false |
acquiring_order[payment_purpose] |
string | Нет | Описание сделки для оплаты, не должно превышать 122 символа. Отображается на странице оплаты |
acquiring_order[vat] |
string | Нет | Наличие НДС по оплате услуги. Варианты:VatNoVat0Vat10Vat20По умолчанию VatNo |
acquiring_order[with_ofd_receipt] |
bool | Нет | Необходимость формирования ОФД чека на полную сумму оплаты. По умолчанию false |
acquiring_order[commission_type] |
enum | Нет | Признак оплаты комиссии за эквайринг. Варианты:from_customer — комиссия спишется с заказчика, после зачисления денег на номинальный счетfrom_client — комиссию оплачивает покупатель, в момент списания денег. В этом случае сумма оплаты для покупателя увеличится на сумму комиссии.По умолчанию from_customer |
acquiring_order[redirect_url] |
string | Нет | Ссылка для перенаправления клиента после успешной оплаты картой или QR кодом (CARD или QR) |
acquiring_order[check_card] |
bool | Нет | Оплата с предавторизацией и автоматической отменой сделки (для проверки валидности карты, только для варианта CARD).По умолчанию false |
acquiring_order[recurrent] |
bool | Нет | Оплата с предавторизацией и автоматической отменой сделки (для проверки валидности карты, только для варианта CARD).По умолчанию false |
acquiring_order[recurrent_transaction_id] |
string | Нет | Оплата с предавторизацией и автоматической отменой сделки (для проверки валидности карты, только для варианта CARD).По умолчанию false |
acquiring_order[lifetime] |
int | Нет | Время жизни ссылки для оплаты в секундах, от 5 мин (300) до 24 часов (86400), по умолчанию 1 час |
services |
dict[json] | Нет | Список услуг. Для экварийнговых платежей по картам и QR — описание позиций фискального чека |
services[order] |
int | Да | Порядковый номер услуги По умолчанию 1 |
services[description] |
str | Да | Описание оказываемой услуги |
services[unit_price_cents] |
int | Да | Цена одной услуги (в копейках) По умолчанию 0 |
services[quantity] |
float | Да | Количество услуг По умолчанию 1 |
services[total_price_cents] |
int | Да | Общая стоимость услуги (цена * количество) По умолчанию 0 |
services[unit] |
str | Да | Единицы измерения услуг По умолчанию шт для Сделок с оплатой, либо 4 для тега 1212 в чеках ОФД. Можно указать нужное значение согласно справочнику |
services[location] |
str | Нет | Место оказания услуг |
services[payment_method_for_ofd] |
int | Нет | Признак способа расчета для чеков ОФД (тег 1214) - используется при заполнении acquiring_order и with_ofd_receipt = true. Допустимые значения: 1 — предоплата 100%, 2 — предоплата, 3 — аванс, 4 — полный расчет, 5 — частичный расчет, 6 — передача в кредит, 7 — оплата в кредит. По умолчанию 4 |
payment_info |
json | Нет | Платежные реквизиты, на которые будет осуществлена оплата конкретной сделки вне зависимости от реквизитов, указанных исполнителем. |
payment_info[card_number] |
str | Нет | Номер карты |
payment_info[sbp_account] |
json | Нет | Реквизиты оплаты на СБП |
payment_info[sbp_account][bic] |
str | Нет | БИК банка |
payment_info[sbp_account][bank_id] |
str | Нет | ID банка в ОПКЦ СБП НСПК / Допустимо использовать вместо БИК |
payment_info[sbp_account][phone] |
str | Нет | Номер телефона |
payment_info[sbp_account][name_sensetive] |
bool | Нет | Проверка на совпадение переданного ФИО с именем клиента в банке получателе |
payment_info[bank_account] |
json | Нет | Реквизиты оплаты на банковский счет |
payment_info[bank_account][bic] |
string | Нет | Бик банка |
payment_info[bank_account][account_number] |
string | Нет | Номер счета |
Проверка карты и рекуррентные оплаты
Для тип оплаты CARD доступны опции проверки карты и рекуррентные оплаты.
| acquiring_order[check_card] | acquiring_order[recurrent] | acquiring_order[recurrent_transaction_id] | Описание |
|---|---|---|---|
| false | false | - | Обычная одноразовая оплата с использованием счёт-ссылки |
| true | false | - | Используется для проверки валидности карты: на ней холдируется сумма и сразу происходит отмена операции |
| false | true | - | Одноразовая оплата, при этом acquiring_order[transaction_id] можно будет использовать для дальнейших повторных оплат |
| true | true | - | Используется для привязки карты для последующих рекуррентных транзакций. |
| true | true | acquring_order[transaction_id] из предыдущего запроса | При указании id предыдущей эквайринговой транзакции будет произведена попытка списания с привязанной карты |
Применение
Создание сделки с подписанием на платформеPOST/api/tasks
Example URI
POST /api/tasks
Request
— Сделка созданаPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTksInRva2VuIjoiMTJiZmE4NDFkNTQyZDUwZmVmYTc1ZTFkMzNkNTA2MWYifQ.O1polVQobw-y-Ohd3ax3cPPXf54T2fFHfCxA6198WrA9LEjNtCpsF71tKt4v491iiFWanrOZvqjVk3HMD2aeQBXZMyssrpmQyN_oiqPZxRtKCTFG32uTX5xr14lvBI9iUIH7-k9N6-DIVVBZ5LHRNySwIce9SQm5kIVOO5uYpfrCXY2XOO1xULM_3_wE-IKw9xl7lW4hOtrd6RtflhI2dXIGlhGpH-ON_A3dtvwbeRX9B7TVC2dRDubpFjQVoAXsUEZw_t_nTndy_vR2ED8WrHcJxgy37J6xqojMNyO7FHWqnmwnmQdoA01L1q8DCqRtT-YsAlHjKE0y8Zg5-Mzelg
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"executor": "+79780964409",
"title": "Типовой договор",
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное"
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 9,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": "https://sign.stg.rocketwork.ru/sign/eyJ0YXNrX2lkIjo5LCJzaWduYXR1cmVfY3JlYXRlX3RpbWUiOjE3MDgzMzc3MTksImRvY3VtZW50X3R5cGUiOiJhZ3JlZW1lbnQifQ",
"agreement_uri": "https://test.test/api/tasks/b2899eee956f2516482bac78f120201cc7f6f2ca6573b06f436a95abbe0294e3/agreement?state=with_stamp",
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "102.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:19Z",
"current_employment_kind": "selfemployed",
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": {
"id": 13,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "lawana@strosinquigley.name",
"employment_kind": "selfemployed",
"first_name": "Людмила",
"inn": "0278180934",
"is_resident": true,
"last_name": "Титова",
"payment_readiness": null,
"phone": "+79780964409",
"second_name": "Иосифовна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": null,
"quantity": null,
"total_price_cents": null,
"location": null,
"unit": null,
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:19Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:19Z"
}
}Request
— Сделка создана с дополнительной комиссиейPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjAsInRva2VuIjoiMjVlMWM3OGYyNWY0MGQ1MzExYmExMmYxY2ZhMzBlYzAifQ.AGv_rX1W6-KNtD9OPXI6lYU3Q2dXlg3ONwNmOMKMorK8JK-15e0HRfXMMtRv70iJwSlGMAA0UaueuUFYlwjhrecVpGCYKCF-M_nUuhMklnE-xAGECkZNU3-S0WSvq1KC0hxDRCp_4gPQcmPItPOM3Goy46QyYNpRH171BC_dPAXfL3DyjK91GrC0PCNaMItY0OsA_aoHhg-BFGvJV8aGsSgh25vMpTYGXpp2CkE5uVZHB8iv4E2usUjsp5QTMWFBjI2MZGHin0k3itfW5hktc1JSLW-PD2XhsSMZT9xU5L0_bk22cedLZs9wAtpToa3QblTdGrEEHOA-hwvdjG7-hg
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"executor": "+79634159919",
"title": "Типовой договор",
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное",
"additional_commission_from": "executor",
"additional_commission_value": "1%"
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 12,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": "executor",
"additional_commission_ofd_receipt": null,
"additional_commission_ofd_url": null,
"additional_commission_result": "10.0",
"additional_commission_url": null,
"additional_commission_value": "1%",
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": "https://sign.stg.rocketwork.ru/sign/eyJ0YXNrX2lkIjoxMiwic2lnbmF0dXJlX2NyZWF0ZV90aW1lIjoxNzA4MzM3NzIwLCJkb2N1bWVudF90eXBlIjoiYWdyZWVtZW50In0",
"agreement_uri": "https://test.test/api/tasks/6dee2c0e253db43bc3c8ce0b26ead43a758d48ae940ec7eadf00c420a7308604/agreement?state=with_stamp",
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "102.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:20Z",
"current_employment_kind": "selfemployed",
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": {
"id": 14,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "clifford.herman@dubuqueleffler.us",
"employment_kind": "selfemployed",
"first_name": "Мирослава",
"inn": "0936467761",
"is_resident": true,
"last_name": "Цветкова",
"payment_readiness": null,
"phone": "+79634159919",
"second_name": "Глебовна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": null,
"quantity": null,
"total_price_cents": null,
"location": null,
"unit": null,
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:20Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:20Z"
}
}Request
— Ошибка создания сделкиPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjAsInRva2VuIjoiYzg4NTU3Y2UwODI2MDY1YWFlNDU1ZTIzNWQxMDhlOTYifQ.r5kbxkn1nCHe5J5W-97uEMj6p23X0X8loagAc54Zp40ff6MTlJWP75ANrroKd2KM-d9TO5zsBfEkEhSYpjjwPwBH0ces84T8M_c-JJECa2rZCWD18Zu7-I4Oz-D1QfuFYGpQVpbFnWF2fy89GaO6-hIz-hAi7nG3Nj--k6fwZSEMcNiHGWjhbvt5AlHg3fxlIlOKz7vgqLZWFZCCaaf3_hYVwtPY0tzuCQFPDhjE_bjGm1gPgy8D-rKhtpDlS5I6jDr3Q6R3Q8CiMp9Ms2eXJKJMYYl8d51SLkyz5OyMh2X5_VSs-ka1ybwsXmlEW-PNLKeYGSaSqMVwQK2cJBOGJg
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"executor": "+79953145596",
"title": null,
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное"
}Response
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Не заполнен заголовок"
]
}Создание сделки со ссылкой на заключенный договорPOST/api/tasks
Example URI
POST /api/tasks
Request
— Сделка созданаPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjAsInRva2VuIjoiMmQ4ODU5OGUzMTUyY2NmZDRiYTc1YjA3MDJlMWQ2OGEifQ.y6PY-NocuPMxq0EpYMV48Hd2LjOhWduwZjHvXFkTQhf7yL9XYooKSizbm-yWRqoXIOnarmKD7O8sEOhqa_e1Yqox6Xn5cNnxsZ40S7aShtuMSUqqUZxLkqfk2AottcAuHOtIlqQGC2RT3SoNXyP1pBsjhCUxgoIE1NLEjA8SBT5qAmJnFb3_ndms2eelalW1SBMYQL0jf2VFKg3FaOVNnvol_73QRBxDFlvmu4eWzORSI8rI-vA2PYkEgIRlIqpZtmmwvxK1tvGmTi7r6JZCn5SZf5hySv0noAWJpb57chNWKxUjEJNRowSaz1QYEGVAkO9ll82F3n_MD6mZ1eLXEg
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"executor": "+70741208053",
"title": "Типовой договор",
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное",
"document_number": "112",
"document_date": "20.02.2001"
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 17,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": null,
"agreement_uri": null,
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "102.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:20Z",
"current_employment_kind": "selfemployed",
"description": [
"Разработка платформы"
],
"document_date": "20.02.2001",
"document_number": "112",
"executor": {
"id": 16,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "evalyn@ratke.info",
"employment_kind": "selfemployed",
"first_name": "Ирина",
"inn": "292953755090",
"is_resident": true,
"last_name": "Медведева",
"payment_readiness": null,
"phone": "+70741208053",
"second_name": "Евгеньевна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": "2001-02-20T00:00:00Z",
"external_id": null,
"fee": "1000.0",
"metadata": {
"legal": {
"id": "112"
},
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": null,
"quantity": null,
"total_price_cents": null,
"location": null,
"unit": null,
"payment_method_for_ofd": 4
}
],
"signature_form": "manual",
"signed_at": "2001-02-20T00:00:00Z",
"status": "inwork",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:20Z"
}
}Request
— Сделка создана с установкой статуса COMPLETEDPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjAsInRva2VuIjoiYmNhYzhkYjlhOGZmYzMwOTBhMWZkYWZmOGJhMmMyZTQifQ.QqdNrLRw-0F6A4U6SKjSkYirJ2xdZX4uTULbDqFBtyQkVuFpja3I2OThGqENlzLkWXa_sne_6a62i6zSrQbThEr79s4rcGxZrj6w1IE4i0hGmgwo_AzF5R7mzX4iym9RGrG_RIRNZgpZRU-0M4ajDGNnVAYqa0PmhcB9EmzxqJNF2WK8hzGyHVOfrpSooFjsNU5YZTQKEsaaxFOTC8p4eD6WIKeQ4rferV5j10jhHFMQWYXvQz61siMMahFLZOwGDEiGBCOJljyTSNkn305hxw06woaxt5EFxmUxaMS6VZufJoeu_VWnnPscSFY2vw7ZgfNNiLjn-bZvCzajfcG_bw
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"executor": "+74938242904",
"title": "Типовой договор",
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное",
"document_number": "112",
"document_date": "20.02.2001",
"autocomplete": true
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 20,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": null,
"agreement_uri": null,
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "102.0",
"completed_at": "2024-02-19T10:15:20Z",
"created_at": "2024-02-19T10:15:20Z",
"current_employment_kind": "selfemployed",
"description": [
"Разработка платформы"
],
"document_date": "20.02.2001",
"document_number": "112",
"executor": {
"id": 17,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "wilfred@mohr.us",
"employment_kind": "selfemployed",
"first_name": "Фекла",
"inn": "791566157707",
"is_resident": true,
"last_name": "Новикова",
"payment_readiness": null,
"phone": "+74938242904",
"second_name": "Романовна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": "2001-02-20T00:00:00Z",
"external_id": null,
"fee": "1000.0",
"metadata": {
"legal": {
"id": "112"
},
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": null,
"quantity": null,
"total_price_cents": null,
"location": null,
"unit": null,
"payment_method_for_ofd": 4
}
],
"signature_form": "manual",
"signed_at": "2001-02-20T00:00:00Z",
"status": "completed",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:20Z"
}
}Request
— Ошибка создания сделкиPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjEsInRva2VuIjoiYTUwMjk0ZmRkN2I3ZTc3NmEwMmE4ZTc2ZGM3YWIzZGEifQ.PRUzusm2pAYAw2gDKZ9T6UmQQgICuxrpeJwHgc7cRHFBq_9Iu2PM7_zWUeO8sla3RUbB5dFobpLmzwfdflzQ6NqT61207JcFcb7bP5o0orzpaWtT1Ttlp_9X0aGIfSxOn3rw-HSta6iCw9jhCGaRUEEnIvUyrLl0e9XUm-mNogzyZCv4lJuRAJ9mMCZoJKHJBfg11TQCR5jYqOI8RICutZrpfSQf5RpB84BV_aNrHEGk2e-uR2WWNMmbdiEyKzDLVsjwX_Fn9lhADZb7G7oLbAql_ZMrLCSgzw07Oc623Wclyv3s0z1qxr3kfxnTdYdsleDrD585Xugo3NPFbf8uhg
Content-Type: application/jsonBody
{
"document_name": "1",
"description": "Разработка платформы",
"executor": "+79171925108",
"title": "Типовой договор",
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное",
"document_date": 1708337721
}Response
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Data document date is not a valid string"
]
}Создание сделки со списком услугPOST/api/tasks
Example URI
POST /api/tasks
Request
— Сделка созданаPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjEsInRva2VuIjoiMjY2MzhiZTZhMzkyNmZhNWIxMzcwYTI0NzdlN2E1OTYifQ.VZUEe3QXmFdUnjP-YzOQ4W4HwaajpuyEhcfh4xIKED4aqEKG_FRUcz3phq9rk_hfsn7O0Mh0JkAtsUl0nq96raLH74amo1CxWed4dO7eCLB3GE36H1B_9PcWP3Q5LmQJaFzSyKSxbkX64z8LmAusafQzU9odcimR_jYtzPDGYc-fCr7333lu6Kkjea9FpWO4zxA4e_yzK2NZG_ae7WY3dhZcJjM3IeZ1jyopkXm5Uj2gqgw6ANzj_qINV5c-_y7JCXx9DY0pEXituwyM9cSuqmQB6dVT2Sml5LlVkdjGf81GNJASytsRItWZ0R9gftdr3IyVZA5aJ7Nc1QmPSALtzw
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"executor": "+74267406336",
"title": "Типовой договор",
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное",
"services": [
{
"order": 1,
"description": "Доставить торт",
"unit_price_cents": 50000,
"quantity": 1,
"total_price_cents": 50000,
"location": null,
"payment_method_for_ofd": 6,
"unit": "шт"
},
{
"order": 2,
"description": "Доставить пирожные",
"unit_price_cents": 12500,
"quantity": 4,
"total_price_cents": 50000,
"location": null,
"payment_method_for_ofd": 5,
"unit": "шт"
}
]
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 25,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": "https://sign.stg.rocketwork.ru/sign/eyJ0YXNrX2lkIjoyNSwic2lnbmF0dXJlX2NyZWF0ZV90aW1lIjoxNzA4MzM3NzIxLCJkb2N1bWVudF90eXBlIjoiYWdyZWVtZW50In0",
"agreement_uri": "https://test.test/api/tasks/5f4607b3ddae7714a8733dd57f21503fa959477e0720929821aebfc07953b6cb/agreement?state=with_stamp",
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "102.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:21Z",
"current_employment_kind": "selfemployed",
"description": [
"Доставить торт",
"Доставить пирожные"
],
"document_date": null,
"document_number": null,
"executor": {
"id": 19,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "tricia_hettinger@buckridgelegros.co.uk",
"employment_kind": "selfemployed",
"first_name": "Яна",
"inn": "928858900539",
"is_resident": true,
"last_name": "Петухова",
"payment_readiness": null,
"phone": "+74267406336",
"second_name": "Витальевна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Доставить торт",
"unit_price_cents": 50000,
"quantity": 1,
"total_price_cents": 50000,
"location": null,
"unit": "шт",
"payment_method_for_ofd": 6
},
{
"order": 2,
"description": "Доставить пирожные",
"unit_price_cents": 12500,
"quantity": 4,
"total_price_cents": 50000,
"location": null,
"unit": "шт",
"payment_method_for_ofd": 5
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:21Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:21Z"
}
}Request
— Отсутствует описание услуги в сделкеPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjEsInRva2VuIjoiMDM4N2VjYTQxOThkYjFhMDEwMTlmZTEwYjlmZGZmMjAifQ.sxquYlAauGtcglGWMymT_rEIdPHwaTnRUnfMSYty9mKjW7XrycCqC6UKSlFFTBDmyWUQtxSBJ8eRcTUNHWaEpylb89_IRNQRSgsVCwN-MXrOTrB_9lRe32L8daIl-8Ny7H1gXYdS1jlFgP3UoNopNbptpi6081KRvpVWZG_oXkSozzbXx9jDCs28DW2lW6lkASZzJTqbBxKjlXu7vAcAOGcaZooeQT1TmMY9w8H5ce84aeUNTtnHArmdTHDxsojhHlgsGRgL--Szh_VoBaQ5seWqfKcKc_PB3ky6VfR3Mp3Vj0dh-IbRsD-ipTc6sUdxE0Fx47EWL9I3pq3fED-nGA
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"executor": "+79115933116",
"title": "Типовой договор",
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное",
"services": [
{
"order": 1,
"description": "Доставить торт",
"unit_price_cents": 50000,
"quantity": 1,
"total_price_cents": 50000,
"location": null,
"unit": "шт"
},
{
"order": 2,
"description": null,
"unit_price_cents": 12500,
"quantity": 4,
"total_price_cents": 50000,
"location": null,
"unit": "шт"
}
]
}Response
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
{
"error": "У услуги не заполнено описание",
"service": {
"order": 2,
"description": null,
"unit_price_cents": 12500,
"quantity": "4.0",
"total_price_cents": 50000,
"location": null,
"payment_method_for_ofd": 4,
"unit": "шт"
}
}
]
}Request
— Общая стоимость услуги некорректнаPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjEsInRva2VuIjoiNWE4OTEyYzE4N2Q0YTVjNDE5NGQ3NjAxZTNhZWIxOTkifQ.JXFWGyUYdiMuaVGRqsWML3MDEKbdHRff6kWw1VpubTzTRD5F5nobSTiOXSAKUaTUMGWyQws_zzgdV67JLjhCI8rRnnNDVdSSZvhSmiik85Raph3tno0QGOXAkg10DyDkOJe-OtdipqbRDqYmvUVFTF8rGmKh5yPs7BCVoNyfmHtwZNu4m33_4MkES2gWeDHykr-NfAs3PZgZ7TbARAhulUtxO5wYZekOPk8gVwKXQpFl5SWXBe10fcWTNCJPUiwG9fbAAacIn5J2JOzIlOFlkA7rtUfaa4MWcMPWSmUdl_wFRrCxb5ifgNqyB_NiD7bMGTzs2jUHc3fnvle3gXLjng
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"executor": "+79159591613",
"title": "Типовой договор",
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное",
"services": [
{
"order": 1,
"description": "Доставить торт",
"unit_price_cents": 50000,
"quantity": 1,
"total_price_cents": 50000,
"location": null,
"unit": "шт"
},
{
"order": 2,
"description": "Доставить пирожные",
"unit_price_cents": 17500,
"quantity": 4,
"total_price_cents": 50000,
"location": null,
"unit": "шт"
}
]
}Response
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
{
"error": "Стоимость услуги не соответствует произведению цены на количество услуг",
"service": {
"order": 2,
"description": "Доставить пирожные",
"unit_price_cents": 17500,
"quantity": "4.0",
"total_price_cents": 50000,
"location": null,
"payment_method_for_ofd": 4,
"unit": "шт"
}
}
]
}Создание сделки | Карточный эквайрингPOST/api/tasks
Example URI
POST /api/tasks
Request
— Сделка созданаPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjEsInRva2VuIjoiODViMjM4NzI2OGZjMzM5ZTYyMGQ1OTNhYzkwMjU5ZGUifQ.ExJoWR4JeBf1uWJVS-zbD9TIBw9DnpU4HOCNu7GP1lmQ1bXwQxPn-pDBDMzfwunoki6nheuRwmTbJo4pU-cjYYtD32CIsrvi42P1FhYgUcMLdQTcPvxNc8p-zv3wrh-P1SMKuvpA2Yw7gSwZNyYWeTDpDaUQQ2IfTE28ZOz8f_sQusP6HiZaj7fobY69B-YWy4rjeVeSjlTF1EzbsoUpoDtAR5G-0dyWROu7Pf3HbwKgXQ2l33CcHrztdWDZd-MDeyK_1W9CsmpiCXF8U6iWu9S_5z4OXOwcLQFvWFgT2O2Cqtm8YFMBZqs_tsQmGtNSTUbQ-ryUtk34s3r-NxBKiQ
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"title": "Типовой договор",
"amount_gross": 1000,
"without_executor": true,
"additional_info": "Сделать что-то прекрасное",
"acquiring_order": {
"type": "CARD",
"with_ofd_receipt": true,
"order_id": "R1234567",
"client_email": "oleg@example.net",
"client_name": "Олег",
"client_phone": "+79261234567"
}
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 32,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "CARD",
"client_name": "Олег",
"client_phone": "+79261234567",
"client_email": "oleg@example.net",
"order_id": "R1234567",
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": true,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/fc434b3c69b02971154770c484601693b4f1894ed78bb04c283b5ef6e8db037f/agreement?state=with_stamp",
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "50.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:21Z",
"current_employment_kind": null,
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": null,
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": 100000,
"quantity": 1,
"total_price_cents": 100000,
"location": null,
"unit": "шт",
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:21Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:21Z"
}
}Request
— Сделка создана с дополнительной комиссиейPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjIsInRva2VuIjoiZjhiMjYzNDE1MTMxM2RjOWE2ZTk2YmJmYmJiYzRhZmYifQ.rx0pg3IVRfbeUoBRUx3QuC3F3NlwwsDKUbsG99xKUALESIqg4EPbwBE4OncTm-f0eNgz5__IQ19TJs_dDyMINhn7bilR2EX51-2Wi-3Lqs4qV4DiF_mWi_5sn_hcTLb2zO65FVvSiHaG0x0P-p-uVWLA87SdWZnXeziCHC_Fz_UlbvtyVkitFfFmdiyhlzKVvoggrWz12qEF_icE7WovuY1QBeXLSyqheEfDOxnpoGVDZiUUlQuiJW3_sNZkix2KDQepRsSBD_bfS9uEP7GtYxdcoY1qLYydJHHj8iD1MVtWkU7Pyu_kfrXDv1BdKCVmXfu6iHRy6FDwr1HxtTlCKw
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"title": "Типовой договор",
"amount_gross": 1000,
"without_executor": false,
"additional_info": "Сделать что-то прекрасное",
"client_phone": "+79261234567",
"additional_commission_from": "client",
"additional_commission_value": "1%",
"acquiring_order": {
"type": "CARD",
"order_id": "R1234567",
"client_email": "oleg@example.net",
"client_name": "Олег"
}
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 35,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "CARD",
"client_name": "Олег",
"client_email": "oleg@example.net",
"order_id": "R1234567",
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": "client",
"additional_commission_ofd_receipt": null,
"additional_commission_ofd_url": null,
"additional_commission_result": "10.0",
"additional_commission_url": null,
"additional_commission_value": "1%",
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/59da327fc9fbc4705fbfd25436f2bf1522642dfe590eb56df6878ac13f4c02ac/agreement?state=with_stamp",
"amount_gross": "990.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "49.5",
"completed_at": null,
"created_at": "2024-02-19T10:15:22Z",
"current_employment_kind": null,
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": null,
"executor_signed_at": null,
"external_id": null,
"fee": "990.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": 99000,
"quantity": 1,
"total_price_cents": 99000,
"location": null,
"unit": "шт",
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:22Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:22Z"
}
}Request
— Сделка создана с дополнительной комиссией и бенефициаромPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjIsInRva2VuIjoiOGQ2NDAzZTZkYWJhM2M4OTk5MGVjMTI5MTdlZWI2NjAifQ.vkmu9FcTwyfggWVsXadyKy2x17gNJK0sFEijJzEusdlyYfjJePknir7fi34qx0oJ8Go_rEsz3KL3N1ikB_5xPffAfg59TozdE4z5cjSZck5NC90wtvAM1kWpWrN8GUSl8W0REFI8rpWtLHfJxH6cw3ab6H4KN0a4d9p22voV32aZotFc03JHzy_r0gCrB88g0BgsN_7yPmiuiHRiNPY1etnQIcXMToazHvcWloq7mWvkL8TMWGHF8S5-PZR3IhlV-qJSHvz3kJiKGISZxN-VCF6BSROh1VHLepqGdkmaQsZw1utUGSRqGWTMcjXDab8xtx4iAp6P3QIVGtTy6Es4gw
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"title": "Типовой договор",
"amount_gross": 1000,
"without_executor": false,
"additional_info": "Сделать что-то прекрасное",
"client_phone": "+79261234567",
"additional_commission_from": "client",
"additional_commission_value": "1%",
"additional_commission_beneficiary": "7981938990",
"additional_commission_ofd_receipt": true,
"acquiring_order": {
"type": "CARD",
"order_id": "R1234567",
"client_email": "oleg@example.net",
"client_name": "Олег"
}
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 38,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "CARD",
"client_name": "Олег",
"client_email": "oleg@example.net",
"order_id": "R1234567",
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "7981938990",
"additional_commission_from": "client",
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "10.0",
"additional_commission_url": null,
"additional_commission_value": "1%",
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/3b3a5ea3c230cd089320d56224cbca6a4608a938378bee96085657a2532396f5/agreement?state=with_stamp",
"amount_gross": "990.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "49.5",
"completed_at": null,
"created_at": "2024-02-19T10:15:22Z",
"current_employment_kind": null,
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": null,
"executor_signed_at": null,
"external_id": null,
"fee": "990.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": 99000,
"quantity": 1,
"total_price_cents": 99000,
"location": null,
"unit": "шт",
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:22Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:22Z"
}
}Request
— Ошибка создания сделкиPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjMsInRva2VuIjoiODNjMGFhNGYwOWE0NTI5MmZkOTgwNWI4NDI3YmYxN2MifQ.AjuwF7nAU5BpNI5zCVpKO93HYHU2LCtQuztJTlwEgOX6KKkWmubzJv8O239VjszJqlgxAqO3ek3ZMcmyNjrbbJZxWZPlDWYID9s5CKpnrAq11_mgeAE_a-B9bjQVSx_-61Q9G4niaUOM4-5y7QDXORGR39O48iFfPxPX93gTo8cyenukrvDE9tKhAOw65O_PDwglPvRcig5b7qeDt93yEwz3MRAEjG1L7n0NruQdcW1dQwJjQCV6aEKTA068Xn9iDl1lz7QmZO6Nhihuq6tSTIv2Jj9QeTQqUyhWYHUeodKQ-Nx4pf0ViIWj0cc14ENiQC9Jkz3xlegwOQX09g-VRA
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"title": "Типовой договор",
"amount_gross": 1000,
"without_executor": true,
"additional_info": "Сделать что-то прекрасное",
"acquiring_order": {
"type": "CARD",
"order_id": "R1234567",
"client_email": "oleg@example.net",
"payment_purpose": "Оплата за услуги",
"client_name": "Олег",
"client_phone": "+79261234567"
}
}Response
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Услуга эквайринга по карте не подключена, обратитесь к администратору"
]
}Создание сделки со списком услуг | Карточный эквайрингPOST/api/tasks
Example URI
POST /api/tasks
Request
— Создана сделка со списком услугPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjIsInRva2VuIjoiZDM3ZmJiNGY3NThmYTE4NDBlOTI1NDQ5ZTY5ODgxMDUifQ.gavtcasI4lPj1PTfFtDuEvNfLa-kyJbWNABqO2aE40EuS8DCThEeXDohfG_YkYPEbsu1kFJ_bNpTpsCRE0mLg6m-5OyCRLib2L0htpctupie5Kz5vCVEBMajY38Pqwsxh-leookOGyWp-6pgQFCadyBxT8mzya9AK5NdXqcgbC1HaeIrRdPNmaSP31U3b5twGCLteBgDWQhj4mysvDOXEVElkpRBh1RhU06kLqRwyhRvd1xIKnoZIazIfxkAlPLXfVnWZSu4hBWcZt1ctH19j4NVx6FGtqT8Vwbn9PyQbqKb2eLATjc5wB9y_j9G_YHBV2SjKOaH_ZwmJ0xA4gGdVA
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"title": "Типовой договор",
"amount_gross": 1000,
"without_executor": true,
"additional_info": "Сделать что-то прекрасное",
"acquiring_order": {
"type": "CARD",
"with_ofd_receipt": true,
"order_id": "R1234567",
"client_email": "oleg@example.net",
"client_name": "Олег",
"client_phone": "+79261234567"
},
"services": [
{
"order": 1,
"description": "Доставить торт",
"unit_price_cents": 50000,
"quantity": 1,
"total_price_cents": 50000,
"location": null,
"unit": "4"
},
{
"order": 2,
"description": "Доставить пирожные",
"unit_price_cents": 12500,
"quantity": 4,
"total_price_cents": 50000,
"location": null,
"unit": "4"
}
]
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 41,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "CARD",
"client_name": "Олег",
"client_phone": "+79261234567",
"client_email": "oleg@example.net",
"order_id": "R1234567",
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": true,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/473d48f8715ba9ba811e269b931a0e98956333c70a9b53b043cca6ef40860c0f/agreement?state=with_stamp",
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "50.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:22Z",
"current_employment_kind": null,
"description": [
"Доставить торт",
"Доставить пирожные"
],
"document_date": null,
"document_number": null,
"executor": null,
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Доставить торт",
"unit_price_cents": 50000,
"quantity": 1,
"total_price_cents": 50000,
"location": null,
"unit": "4",
"payment_method_for_ofd": 4
},
{
"order": 2,
"description": "Доставить пирожные",
"unit_price_cents": 12500,
"quantity": 4,
"total_price_cents": 50000,
"location": null,
"unit": "4",
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:22Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:22Z"
}
}Создание сделки | Эквайринг СБПPOST/api/tasks
Example URI
POST /api/tasks
Request
— Сделка созданаPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjMsInRva2VuIjoiZjE1YzU5YmQ5MGIzMjRjZTY2NmVkMGY2MDA5ZjhlZWUifQ.rcaCCHaGiMSycqivQPe1oy8KXEFxgx-U9qOAL-jTZ6-gvI5Q8XDTqo8icwO4X3pEYMZtyZYuwXzR4la8zK9cfGPRcUC-Ol2ruca2cgcj6rWRnndY7mZRiIJLqIzJmjBUPUa_cLOZXt5PsoN89wcUCEeo0pnTiJFSAA5VFb8bUct0k0IRzzQS3nDEgzme22lavaGOtlupSpmFc6HcMGt11nadnGWz2rNZ664CgUQji-CTILXsJNd0CGbv5og3wJFNOh36dpXY2lzC4S5x4fhgehYIwVZ-VKut9NSd5NoogUvvg4hHnX2GFJ7dMpoGanppFZXAAHb37F3kL9_w9f072A
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"title": "Типовой договор",
"amount_gross": 1000,
"without_executor": true,
"additional_info": "Сделать что-то прекрасное",
"acquiring_order": {
"type": "QR",
"with_ofd_receipt": true,
"client_email": "oleg@example.net",
"client_name": "Олег",
"client_phone": "+79261234567"
}
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 46,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "QR",
"client_name": "Олег",
"client_phone": "+79261234567",
"client_email": "oleg@example.net",
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": true,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/9969bae9db26a32c06772db273d3a38b2c7dece54bda3229610dfacb3e15bd5b/agreement?state=with_stamp",
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "50.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:23Z",
"current_employment_kind": null,
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": null,
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": 100000,
"quantity": 1,
"total_price_cents": 100000,
"location": null,
"unit": "шт",
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:23Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:23Z"
}
}Request
— Сделка создана с дополнительной комиссиейPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjMsInRva2VuIjoiNWQ1ZTNlNGExZTNmMzQ4OTJkNTFhZTc1MDBiMWE3OWIifQ.gUhsjsRXiXMzvOh1j2wuTaUH3f3pmN7GqSf2qLfCLlhI2lATMHeq9Iq4zfS_VmnYNVm24jVirlAFOJ6AxWaRkMUTqmb6kOyxhqjEtD-YKnHcx-juhSV8FPa52DCQSi0SMWp3Zq49nCpBGXcXVdPkUFtswKu3Ycp2GgCLQPSx7FSBQl-oPJaUhGr2NR2qBW7Nj8oo_tTQpGwOiY5Aq-rNfR63qVJqhOof-qccPkn-Ri5jq7y1ErLgGZ1vp0DjSyvvEigPSdMFOTGnUnOnx7Ne897-XyxFuL8bJsUJCMdJuBIIAf3AL1VubAKDo3BjbD1ZB3uoiBAoIL-onFDCKJiufA
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"title": "Типовой договор",
"amount_gross": 1000,
"without_executor": true,
"additional_info": "Сделать что-то прекрасное",
"executor": "+79639828660",
"additional_commission_from": "client",
"additional_commission_value": "10",
"acquiring_order": {
"type": "QR",
"with_ofd_receipt": true,
"order_id": "R1234567",
"client_email": "oleg@example.net",
"client_name": "Олег",
"client_phone": "+79261234567"
}
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 49,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "QR",
"client_name": "Олег",
"client_phone": "+79261234567",
"client_email": "oleg@example.net",
"order_id": "R1234567",
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": true,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": "client",
"additional_commission_ofd_receipt": null,
"additional_commission_ofd_url": null,
"additional_commission_result": "10.0",
"additional_commission_url": null,
"additional_commission_value": "10",
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": "https://sign.stg.rocketwork.ru/sign/eyJ0YXNrX2lkIjo0OSwic2lnbmF0dXJlX2NyZWF0ZV90aW1lIjoxNzA4MzM3NzIzLCJkb2N1bWVudF90eXBlIjoiYWdyZWVtZW50In0",
"agreement_uri": "https://test.test/api/tasks/3963015825311e0143e7aca685d62aeacded1acf234fc1a7f7df6be0897ebba7/agreement?state=with_stamp",
"amount_gross": "990.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "102.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:23Z",
"current_employment_kind": "selfemployed",
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": {
"id": 28,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "sterling@mcglynnohara.info",
"employment_kind": "selfemployed",
"first_name": "Феодора",
"inn": "317783396525",
"is_resident": true,
"last_name": "Андреева",
"payment_readiness": null,
"phone": "+79639828660",
"second_name": "Георгиевна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "990.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": 99000,
"quantity": 1,
"total_price_cents": 99000,
"location": null,
"unit": "шт",
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:23Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:23Z"
}
}Request
— Ошибка создания сделкиPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjQsInRva2VuIjoiMmIyNDk1NDFjNTAyN2E3Mjc2YWVkMmZiMTI5NDI4YmEifQ.KnmdKxJO9KBpIFy-bd-PMT6ExDebL2FA0fe2s3_Ipmg_ETt86JAYRu3C9RV6y5jAIEEa7-h0zyfB1pLxGpb_53SMoScUOTROMZBsnUYeqXP6y9RB0f0S6D7PqJaSHZB2NwilJDHPja098xd4ObIk_WPVyi7Vm4P81dfDL6N6jzWSrc_ACpXfLe7KIitRIaPTXk5WF9SLSafM7crtP0Y2oxx-kw2swcaQ8vmbvlQiLwBBIuTs3lXodO0Ugp6Uw9HoAjl3Tra82P8QqIi8jbcB0zm3gIGMLtJXF-Syguhoap29loT2XvOuYb9L8hYJ1_X8ZKV6jDqkDFMvco8XRwtFHQ
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"title": "Типовой договор",
"amount_gross": 1000,
"without_executor": true,
"additional_info": "Сделать что-то прекрасное",
"acquiring_order": {
"type": "QR"
}
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 55,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "QR",
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/d62d24518f1936df46afd608aa7a2d202737ab4a14b273f0283e6b3dd5844fc8/agreement?state=with_stamp",
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "50.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:24Z",
"current_employment_kind": null,
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": null,
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": 100000,
"quantity": 1,
"total_price_cents": 100000,
"location": null,
"unit": "шт",
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:24Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:24Z"
}
}Создание сделки со списком услуг | Эквайринг СБПPOST/api/tasks
Example URI
POST /api/tasks
Request
— Создана сделка со списком услугPOST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjQsInRva2VuIjoiYTZjMTYzYmFlYTcyZDMwNDQyNzU3ZmZiNDIwYjBmOTgifQ.DahltM6L13b_-Id10gJVBlLTOq52_8XL15nBUKZQa8lLbwp2W79HpYB-isUc377HFFqiUuQC48zjgx0ZlYzA0eyqcqpIaJzB2zX0AqAXVMJi6B0qPiCQlF_nJsHoqk8yyKpMUGX3Ob8FhIgAaF4rLNxEc26iJ3mlXKhYwLTY5xRExp4gdAIqD9k7_WQkESTewXRmu_oiK4-5y_hhuRJPfnZqxkNd_TA-aCFQXSqolcqIBR9MqZtkA6kww4nOkZy0MYm_f0a-jTcbsUBQGy6VST22kK5xVrnrqK8zLF7LipQPCwDBh9KpzPWiWLfLB4DPg_0YnA85Q2-6npHSNVX6Mw
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"title": "Типовой договор",
"amount_gross": 1000,
"without_executor": true,
"additional_info": "Сделать что-то прекрасное",
"acquiring_order": {
"type": "QR",
"client_email": "oleg@example.net",
"payment_purpose": "Оплата за услуги",
"client_name": "Олег",
"client_phone": "+79261234567"
},
"services": [
{
"order": 1,
"description": "Доставить торт",
"unit_price_cents": 50000,
"quantity": 1,
"total_price_cents": 50000,
"location": null,
"unit": "4"
},
{
"order": 2,
"description": "Доставить пирожные",
"unit_price_cents": 12500,
"quantity": 4,
"total_price_cents": 50000,
"location": null,
"unit": "4"
}
]
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 52,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "QR",
"client_name": "Олег",
"client_phone": "+79261234567",
"client_email": "oleg@example.net",
"status": "pending",
"payment_purpose": "Оплата за услуги",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/bdec5844132351702a7825b01b6172d2090df12f0cb2e812e15edde905d3fe7c/agreement?state=with_stamp",
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "50.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:24Z",
"current_employment_kind": null,
"description": [
"Доставить торт",
"Доставить пирожные"
],
"document_date": null,
"document_number": null,
"executor": null,
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Доставить торт",
"unit_price_cents": 50000,
"quantity": 1,
"total_price_cents": 50000,
"location": null,
"unit": "4",
"payment_method_for_ofd": 4
},
{
"order": 2,
"description": "Доставить пирожные",
"unit_price_cents": 12500,
"quantity": 4,
"total_price_cents": 50000,
"location": null,
"unit": "4",
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:24Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:24Z"
}
}Возврат суммы | Карточный эквайринг/СБПPOST/api/tasks/{id}/refund
Example URI
POST /api/tasks/58/refund
URI Parameters
- id
number(required) Example: 58
Request
— Создан возврата по сделке с эквайрингомPOST /api/tasks/58/refund
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjUsInRva2VuIjoiNjcyZDRkYTA5ODkxYWVjMjAzODBhM2NmYzUzZDAwZDgifQ.v57T3IjXeQLSDwd1YTxVFIcJ-nEQztvRFo9M0KxQZS68g5a16rvl5fM8eTp1tlRz1b9fSrwW4r1s-Si39bQL93W8YQALPAIG0IzLy8bJiQYh70Dv9SskfZHu4dmCzXGWQn9ZqsgF2j-_1G2hrcoP10zLpQPdyeVCKojFIWZBDTJRO6P6iYaarvIuWHzksZ_UQc1i-0GZB1X0d_X1njIh0AjsZUMUET3MbsdHK7wMdNTx1V3o9TbKOF7scAz7IckI1lWVsZRv4ncjBKrBNnn_Vp3eORycLntQiScGJbFM83_amoK1Yg55cWRp9NlTnoczPCvJrN_XnQdSQZ2OPf41jA
Content-Type: application/jsonBody
{
"refund_amount": 100
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 58,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "QR",
"status": "refunding",
"redirect_url": "http://mayer.com",
"lifetime": 300
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/f02eb33c5900af97d26ceaae5394d36247b2ce5abc18016c424d304929e306a7/agreement?state=with_stamp",
"amount_gross": "120.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "6.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:25Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 32,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "wilhelmina@dibbert.com",
"employment_kind": "selfemployed",
"first_name": "Светлана",
"inn": "6782356770",
"is_resident": true,
"last_name": "Ковалева",
"payment_readiness": null,
"phone": "+70816755084",
"second_name": "Ярославовна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "120.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "100.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:25Z",
"status": "draft",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:25Z"
}
}Request
— Ошибка создания возврата по сделке с эквайрингомPOST /api/tasks/61/refund
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjUsInRva2VuIjoiMzA5MDcyYzFlOGYyYTM4NTRmYmYzMWUyOWQyNDc4MzcifQ.ypkEO82sTnxXA7tL4NKC3vN3yDp7tKBKQVgkQwHyRM6gj16K8nkAF6ozvcj2_1XHo-OJYnj2fQIingIm0s4AKYthsLn8u1qGgKzCnyOSc1Ob2NDO6YxgofjCI1VHuNB43ZY70YvbID1aZAxTf-Q-KeTV6pS8KsO8tDgWFEKlSnFknVMtn9n4WYn_uKP5lNzm_3CbCn1McvXA9Bc4d3PBvP2u02F3Sy8T5z6PNDngvi0MhR7WXomiHyyhqRNmskJTsNdDsTmNCmj7wEpE81yCTl1DjuBG_FfoWfW8fCZYbYsW_-JkQT6RWP-8fekghQGoSahzsMIKgX_43roEkLnDeA
Content-Type: application/jsonBody
{
"refund_amount": 100
}Response
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Эквайринговый платеж в процессе возврата/возвращен"
]
}Создание сделки с указанием метода выплаты | Банковский счетPOST/api/tasks
Example URI
POST /api/tasks
Request
POST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjUsInRva2VuIjoiM2QwOGRmOWJhMGQ5ZmZjYTdjNThmZDI3ZmY1MTlmMzAifQ.YJ0A_hy67CQmZBADN5TtSQAxFQ_2X0UYJVQAZZA63ufY1coUrJGkXNJ0BqtrxOHB4V-nJy8pXJ33-twSku8AoczYAsIRJFuQ3ZTb8EdUCfPAPVp5c6_gYdu_dKI4Y-eYPdJ6PwGiQcZPpICKtHRH-hRAne5h7jx443qWpTdG2HSdSV4q2ZKySY7rjX3hXuVVm70naV_wfMhbBnmAqYZ80VFKWM1TL5RAoM32cpo_EAjjhMS2MzZkdq_ozVhnfuhIXF8l22xAZ-li5uIFJcggy_7v2QGxfoNj7bWdJEyne6pLG5W7-cLZZskTj3-5CJFVYSjzMvhzMe9SELPdyRn9gQ
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"executor": "+74732422251",
"title": "Типовой договор",
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное",
"payment_info": {
"bank_account": {
"bic": "044525000",
"account_number": "408178100000000000000"
}
}
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 64,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": "https://sign.stg.rocketwork.ru/sign/eyJ0YXNrX2lkIjo2NCwic2lnbmF0dXJlX2NyZWF0ZV90aW1lIjoxNzA4MzM3NzI1LCJkb2N1bWVudF90eXBlIjoiYWdyZWVtZW50In0",
"agreement_uri": "https://test.test/api/tasks/f0a0ae3e11492827a49879a23b9655e430c3410a333e91329a262171a73de0a0/agreement?state=with_stamp",
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "102.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:25Z",
"current_employment_kind": "selfemployed",
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": {
"id": 35,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "delpha_pacocha@ledner.info",
"employment_kind": "selfemployed",
"first_name": "Раиса",
"inn": "094078825788",
"is_resident": true,
"last_name": "Воробьева",
"payment_readiness": null,
"phone": "+74732422251",
"second_name": "Тимофеевна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": null,
"quantity": null,
"total_price_cents": null,
"location": null,
"unit": null,
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:25Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:25Z"
}
}Создание сделки с указанием метода выплаты | СбпPOST/api/tasks
Example URI
POST /api/tasks
Request
POST /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjUsInRva2VuIjoiNjdiYzIyMmE2MzA3MGY1NDIxZWQ1NzE2ODQwZDliNDUifQ.J3J7i6WdVdtGWF0dC-i9v0PxJxRfTA5kbjO5_F4IHd86E9ty-H22i2V0C0BodFY4TsgVNcrz5z16CMxd_Mj0uWDsKqgzeQv0bX0VHXOrYgJWLua1ioJGDyloOM_7UXpkcdf478MiXKoKGIBdP9axuLoAZyZi6Wld1aPwUkph8RS9IF9NdMtjxGgaJb8Jz9FBwhrErvlvU5Uy7Pynkqiqfs0PN01auJReaFLa1GsLLLBtGuNGnGR7Cu-zORyE6UpWJNdoPJa819mLayU1HtAPdhjvrVOyGbz7Aec3kdTANvlK8bKHdpl4RbMsPtxk19vVSN7OvKXSjG0ZbI32GwKg2Q
Content-Type: application/jsonBody
{
"document_name": "Типовой договор",
"description": "Разработка платформы",
"executor": "+78353650570",
"title": "Типовой договор",
"amount_gross": 1000,
"additional_info": "Сделать что-то прекрасное",
"payment_info": {
"sbp_account": {
"bic": "044525000",
"phone": "+79000000000",
"name_sensitive": true
}
}
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 67,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": "https://sign.stg.rocketwork.ru/sign/eyJ0YXNrX2lkIjo2Nywic2lnbmF0dXJlX2NyZWF0ZV90aW1lIjoxNzA4MzM3NzI1LCJkb2N1bWVudF90eXBlIjoiYWdyZWVtZW50In0",
"agreement_uri": "https://test.test/api/tasks/037866ae48ef387c7f3d9dc7724a39f4691fdb0b15ff2b04834999bcc10f75af/agreement?state=with_stamp",
"amount_gross": "1000.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Типовой договор",
"commission": "102.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:25Z",
"current_employment_kind": "selfemployed",
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": {
"id": 36,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "delta.farrell@ryan.ca",
"employment_kind": "selfemployed",
"first_name": "Ярослава",
"inn": "383871812330",
"is_resident": true,
"last_name": "Белова",
"payment_readiness": null,
"phone": "+78353650570",
"second_name": "Филипповна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {
"additional_info": "Сделать что-то прекрасное"
},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": null,
"quantity": null,
"total_price_cents": null,
"location": null,
"unit": null,
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:25Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:25Z"
}
}Получить список сделокGET/api/tasks
Example URI
GET /api/tasks
Request
- Получение задачGET /api/tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MTMzNTcyNTcsInRva2VuIjoiNzQyMTYwMDMxNTU0ZDMyY2UxYWI3NmZhYjc4N2Q2NTQifQ.Uow_OkoH6L6-pGwOjlK5qj0FF-BpAU6gc8Ei2i3y80QhRYpT_SkYDCTLjsw8--FODSolEBq0Hg--3QsYanI4dp76vhribRHdwvlfVyeI2EBptbEj-9OSYHJq-XP85_9RO17cxj_JCj8ednzyxC5JNhcOpQd1r7QEi-OzDTlgmhC37Vs2KDoRiToFFW7TLQhKtfBuYu9Mk6vfmQV9Z5Ie37r4u8ts6aLPLwONx1Vpo9tch-awqx7nAEYMcxpTZlQsq-9bowoUw9P-KQBYy1V9_P5iPKzCnBUAgeJo6us1qu_3aYdf--OEm3AwW07-CuZlmLPt1TBAqENfp3b6f_F7Bw
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"tasks": [
{
"id": 74,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/95940e35c947860c3aa95cd9992fb1b53a261857faaa81781744107511bfada7/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-04-17T12:34:17Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 40,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "florencia.bradtke@grant.com",
"employment_kind": "selfemployed",
"first_name": "Серафима",
"inn": "295226246985",
"is_resident": true,
"last_name": "Макарова",
"payment_readiness": null,
"phone": "+78736066021",
"second_name": "Степановна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-04-17T12:34:17Z",
"status": "draft",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-04-17T12:34:17Z"
},
{
"id": 73,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/76c4dec13baf4899de817761938a4c14710c5371e6193c079e5406af29778612/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-04-17T12:34:17Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 39,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "marva@boehmzulauf.co.uk",
"employment_kind": "selfemployed",
"first_name": "Алла",
"inn": "4689027665",
"is_resident": true,
"last_name": "Пономарева",
"payment_readiness": null,
"phone": "+78433592881",
"second_name": "Денисовна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-04-17T12:34:17Z",
"status": "draft",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-04-17T12:34:17Z"
},
{
"id": 72,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "Task::OneTimeTask",
"status": "draft"
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/41020b7a15a6b255b3d28df661232b0e957055b3d57b3f1cb81a9785f2a86997/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-04-17T12:34:17Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 37,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "carylon_herman@leuschke.com",
"employment_kind": "selfemployed",
"first_name": "Ангелина",
"inn": "111111",
"is_resident": true,
"last_name": "Иванова",
"payment_readiness": null,
"phone": "+79157427908",
"second_name": "Олеговна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-04-17T12:34:17Z",
"status": "draft",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-04-17T12:34:17Z"
},
{
"id": 71,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "Task::OneTimeTask",
"status": "draft"
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/7116a72d4082c4a8c5d6fe3fcf1558657c7f869744a23154b291e77549cfa256/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-04-17T12:34:17Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 37,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "carylon_herman@leuschke.com",
"employment_kind": "selfemployed",
"first_name": "Ангелина",
"inn": "111111",
"is_resident": true,
"last_name": "Иванова",
"payment_readiness": null,
"phone": "+79157427908",
"second_name": "Олеговна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-04-17T12:34:17Z",
"status": "draft",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-04-17T12:34:17Z"
},
{
"id": 69,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/c3cb2032b4bf4d40717d7280668615401363d8e7e3bf08cf8f7ab0a406d60f64/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-04-17T12:34:16Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 37,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "carylon_herman@leuschke.com",
"employment_kind": "selfemployed",
"first_name": "Ангелина",
"inn": "111111",
"is_resident": true,
"last_name": "Иванова",
"payment_readiness": null,
"phone": "+79157427908",
"second_name": "Олеговна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": "2024-04-16T12:34:16Z",
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-04-16T12:34:16Z",
"status": "draft",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-04-17T12:34:16Z"
},
{
"id": 68,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/c546213620dd3de059dd832ef54c81465224dc31f136724f12abef8b0a1463b0/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-04-16T12:34:16Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 37,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "carylon_herman@leuschke.com",
"employment_kind": "selfemployed",
"first_name": "Ангелина",
"inn": "111111",
"is_resident": true,
"last_name": "Иванова",
"payment_readiness": null,
"phone": "+79157427908",
"second_name": "Олеговна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": "2024-04-16T12:34:16Z",
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-04-16T12:34:16Z",
"status": "draft",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-04-17T12:34:16Z"
}
],
"meta": {
"current": 1,
"total": 6,
"last": 1
}
}Request
- Получение задач с фильтрациейGET /api/tasks?acquiring=true&acquiring_order_statuses[]=draft&created_at[from]=2024-04-16 15:34:17 0300&created_at[to]=2024-04-18 15:34:17 0300&executor_inns[]=111111&executor_phones[]= 79157427908&linked_task_id=77&statuses[]=draft&types[]=OneTimeTask
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MTMzNTcyNTcsInRva2VuIjoiZmY2MTRmZThiMmZlMjllMjgwZjMzZTUwZjEzNjA1NWIifQ.cev0ybDzeNkgm-oUywWcQ4VlMq2dZ-BLT8KNmxqLqD_bxCzhhqTzuUYSagGXcKvyCry18gHl570z-HhKVsbnP4uAPPHlVfnkqgesxBuMASQERg7c11WNmuA5jXxPFpQB0MwBt6fE9P2Bk6O9voSi7-45GxXEUHYr-fKSnwvNEvpoyaEcUCe3bQwRkdhzK7q6NCxFDjIwWBgMF62wnipWzK8FbcXqjM_e0LiBrJ-mBbUlzWiitcVtJjyZzet0yP0itebCXbNPsc8xKiIpOLFcTXAQ8lFJ57_yIOFhTXTQh5PdM-eeTNdcCoIboSgDoD3lhyEroGsqcGDJ3fQlylbVug
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"tasks": [
{
"id": 79,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "Task::OneTimeTask",
"status": "draft"
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/34151becc6ef9bfcd9301e37a0d602fc5c3461485295cb1cbe5002fc0eb6048d/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-04-17T12:34:17Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 41,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "tambra_kerluke@fisher.com",
"employment_kind": "selfemployed",
"first_name": "Алевтина",
"inn": "111111",
"is_resident": true,
"last_name": "Белова",
"payment_readiness": null,
"phone": "+79157427908",
"second_name": "Михайловна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-04-17T12:34:17Z",
"status": "draft",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-04-17T12:34:17Z"
},
{
"id": 78,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"type": "Task::OneTimeTask",
"status": "draft"
},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/daae8b13577582c2f57143ec43be34c9d4da262bc5744c92a5781c6cc1808ba2/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-04-17T12:34:17Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 41,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "tambra_kerluke@fisher.com",
"employment_kind": "selfemployed",
"first_name": "Алевтина",
"inn": "111111",
"is_resident": true,
"last_name": "Белова",
"payment_readiness": null,
"phone": "+79157427908",
"second_name": "Михайловна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-04-17T12:34:17Z",
"status": "draft",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-04-17T12:34:17Z"
}
],
"meta": {
"current": 1,
"total": 2,
"last": 1
}
}Получить информацию о сделкеGET/api/tasks/{id}
Example URI
GET /api/tasks/77
URI Parameters
- id
number(required) Example: 77
Request
GET /api/tasks/77
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MTMxODMwNjUsInRva2VuIjoiZGIzNjMxYzg2N2Q4OGYyOTkzY2E5NTc4YTkyYzJmY2MifQ.NjalIMhWGCbGV8gnng0B2v8NEXfUpoBvtCE990uyykuCjtsYD0uUFnS1yWLWch93-AptJNw-7mOipvDjMCjyNKrWrBN_GATm7cPMFOEeh_GPdqFlVLyBbzqFG4fwyROyr00I6R6iyHNsuu1ENvlFImUoWpL0v02-U5k5nlCl9_AI_yEjw7avaW5jHxo7qB7wsI3ggGj01S-WwSSwqtHnXifu1RyhFcOFWQWEiurPGEzR9bZ57Jtn4Bc5ehJUXsDMpxZjLcjSqnsT0SJZqFolpvO_Dllp9uh6RalySCxPaFRinjxq1K6nqimVisphJ_Z_fOYSfsPQUOae0ClIqbzPlA
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 77,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/08d59c831254a931bfe44056a7df2932e0bc5e2a0ebb4b15e671e9e5bc4018f1/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-04-15T12:11:05Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 41,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "lola@cummingshickle.ca",
"employment_kind": "selfemployed",
"first_name": "Инесса",
"inn": "191388316428",
"is_resident": true,
"last_name": "Фомина",
"payment_readiness": null,
"phone": "+78316814845",
"second_name": "Богдановна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:25Z",
"status": "completed",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:26Z"
}
}Подписание актаPATCH/api/tasks/{id}/sign_act
Example URI
PATCH /api/tasks/76/sign_act
URI Parameters
- id
number(required) Example: 76
Request
— Акт по сделке подписанPATCH /api/tasks/76/sign_act
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjYsInRva2VuIjoiZGI5OWM5M2Q0Y2I0ZWMxNjA2NWMxYWRiNzM4MTU0MWIifQ.IlSgK9EHTslihwB6yGMjf35pYerZseqbCX7hTMPiKSd1vqU5UxFK56VZ0_Lob98uBDG7C-8M87IvTSeVTBqKLIsaub7xqh-xUSBEZxI-eoFKYnmZyLY_s3liQbu9ZP3fDRlqHob4x-sVvB7QFXreMyKiCF_DY_jwro7B26f7xIS8LZiwfh1vVoD7eNEfVULK-kFoxYC_IP87huE3KA--sOwIN8dVypTVcJC5HgvbUSNxicJd7kaAtPn5XixIhQAzQKiNyFAmMgTpUcmqIP94hQms_E0b8d3_-gXTIN7Gpno-8UQqMwbqHIdxnRCH4FWZbY6RMBpTBnn0bCgbXSKYYw
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 76,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": "https://test.test/api/tasks/309fd81f00280cbcd4a4c50f5987eb9a67adef0dd8bec65a5660bd6278fbbbc2/acceptance?state=with_stamp",
"acquiring_order": {},
"act_required": true,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/309fd81f00280cbcd4a4c50f5987eb9a67adef0dd8bec65a5660bd6278fbbbc2/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:26Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 39,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "hong.fay@balistrericorkery.us",
"employment_kind": "selfemployed",
"first_name": "Акулина",
"inn": "8681832459",
"is_resident": true,
"last_name": "Петрова",
"payment_readiness": null,
"phone": "+79950581266",
"second_name": "Леонидовна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:26Z",
"status": "accepting",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:26Z"
}
}Request
— Статус сделки не `accepting`PATCH /api/tasks/79/sign_act
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjYsInRva2VuIjoiZGRlZjdhM2ZjNjA1ZDg0MzBmZWQyNzNiNTg0NjgyMzYifQ.NwV_JJq12g6G1DjhcxHjq3FhfaJNArGivVW0hvAFm7i3WC0wzhPRxx3yTLF7-CcevgRLwbm1xJbyORhbSiv5A-Z-HXCXn-ezMVdxqADgvgBrpq2nNaZbtJKSElrEBPRZ1A0KnfVbWStmv278XmNN6Gpl4YvK8r7qjVI8j873HRUWpIDEh701OgoYJ9v07GQYRCUQK-qrZFh_QBGBvE34_ENh1qD_ig6q58vsNwZJ2S3cTqiXVhGycEhCgiazafZXbof2A37q4I0HWgU2p-KuQc1nYs4MDeiYNWpSeJl4Zlof-UxtX_zxwtBKzZ919jB7YP6-qye8y9ena5t67nDsmA
Content-Type: application/jsonResponse
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Task is not ready for signing act"
]
}Request
— Акт по сделке уже подписанPATCH /api/tasks/82/sign_act
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjYsInRva2VuIjoiYjc5ZGQzOGYzODIyYmUyOTljMWUyZDQ0ZGE4NzBmZjcifQ.KVWOJ4AMzLrgzll6EfyK2XYGejBPvZoQNCesJ2ddWZxrmOhrcIUFFYyT03mhHYothY2R7929AuJ47ksM1zZG4CFPBDUjYZ3wvEMYjOOq2jcUozEhxQWIwKq6kasRO5Egp3cpVuK_HISJfZiG80RSqhzvODDyDQFSR_nuchWCstxYUEbMipnXfp_Ay4ii5kJSVxHKY2vMKiStzHYm374nyAV0pWFlR_X3Otekmm4uJRbHWSalLdibxxbB2N40XCrp2Z1iSmtS-_A1LlUwtxO1o2W8Q4Wkvs1YmaDBqj2T9dtTN_eJ64daACRl6Ub3ATwr0X7mKqELZFpfvKucchlm1w
Content-Type: application/jsonResponse
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Task is invalid for signing act"
]
}Request
— Сделка не требует подписание актаPATCH /api/tasks/85/sign_act
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjYsInRva2VuIjoiM2IyYzcwMTBmMWIyZjBjNmZmOTM2ZGNiMjVjMTE2M2IifQ.jTr7YSK_qUSvNku8KvIu6UnsPBC8QkXxeLkjCfeuP-MR6yM3J4LzXWpw0-_nobPDTVeFxoFAAdfVpGfwBwt0EqY_Zu4TJOmTwofNzmWqs6B94qbucIwVN8CZ30FrmqNUwdmr24UW70VLQUlYTkaSakMEO1OZdMHibfmZMTImFbQfDIpHfRvuPQLMRXc5fF5r_X2neTiGDpwZqL6vF4_0rkjT1nM5IbnMA6npu7SS6G0G2hVYblana7GCKzlMlh4pwvUYXDDHQgND2-Y_UzyXTCqPia7UUt8MTLIbZuXj8AKQRK_f4zhsMb20JpxlsEHN0ehP2u-PxGO_xYcw_MXdag
Content-Type: application/jsonResponse
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Task does not require act signing"
]
}Запустить процесс оплаты сделкиPATCH/api/tasks/{id}/pay
Example URI
PATCH /api/tasks/88/pay
URI Parameters
- id
number(required) Example: 88
Request
— Сделка оплачиваетсяPATCH /api/tasks/88/pay
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjcsInRva2VuIjoiOWY4NjQ5OTMzNTU0MTg3NDI3MzhiNzk2YzZmNmE0YzQifQ.J7Vce0pIJjlYBSGmgmedwciO8XewBqd3SIagDHifXRJg7j4JhyUGFNJSJrHLNYCblOd4YWTR8cTjGUCvBrxbgMAy9VOoRuJTtbogFK6NdI-hrIF3qLpwu7Xp4GmLr-p9v554ypmrOhAPzFWeXK2PiMUmAKZ22BPc8EYNPiMWz933AguIHGxXnob6dbdWRM4DnZT394Tsch028VysFe0c-uAqyy3UR_STzVgp-uBwonxNiQ9DHpmJSm_3EmlyEjQn2b_pNphkYVA1_DS3yy_J5pEMYnh1ddiEhq0sqFP8QGhmVpSauSb3qwSIWZJ8ghdBw8hb-f79-PNTlZS6-5FFDA
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 88,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/cc298ebe9ffdedef44f2b1c731eaaf33887369cee15aab92a43fdae01141219d/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": null,
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:27Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 43,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "sunny@lemke.ca",
"employment_kind": "selfemployed",
"first_name": "Евпраксия",
"inn": "337584311569",
"is_resident": true,
"last_name": "Комарова",
"payment_readiness": null,
"phone": "+79853316674",
"second_name": "Емельяновна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:27Z",
"status": "paying",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:27Z"
}
}Request
— Не удалось начать оплату по сделкеPATCH /api/tasks/91/pay
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjcsInRva2VuIjoiNWFjNTNmYTA4MzEwNjAzNzk3NTU5ODYwMDUyY2IyYTkifQ.ymSUNsp0m-jhwiGszbSmiAzoEWzuy6k8R8jlT06AoNqMdze210AjCd8uL9yBGDPJkCL0h1fR4FYczVF3a56IH9PnEMvNr5fpRSM67PSWDv0eWevVpewFksYKWYbs8TIc-j4V8CHdyGn8U31PqbrVYFWW-NV9_JKpi5r4b14ejCulXtk9kNnT7EtN2xEo836VW6J2hJmSWxFO9OiB2B7iL3uAvRawqbTfRQXsp4Mfh1qbKF2w-j25z5qRGYeQI34LTWX_roM2YXJBAyBd_fdF0hy4nbUZ7wwNS_mTGW-OfXXJSh6oKePYh2uNO-tZVe2F7JLlBDxsi37TLBhcpFoPUQ
Content-Type: application/jsonResponse
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Task in status inwork can't be paid"
]
}Отменить сделкуPATCH/api/tasks/{id}/{event}
Example URI
PATCH /api/tasks/94/cancel
URI Parameters
- id
number(required) Example: 94- event
string(required) Example: cancel
Request
— Сделка отмененаPATCH /api/tasks/94/cancel
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjcsInRva2VuIjoiZjBiN2Y2MjRkMDU2YmRjMDQ5ZTc0MDZlOTA5YTM0NmYifQ.iCaWH_XBx6UZels7Bx5AVah7eVQOYora0Rk8guDHQPi_oSTKEQvxD_5BwgTeYz5YjbFUO86fbbKACxY7gaWHLaCABJtvnLxcGCq50buISnX4o6K_I_YmOGbC1a6iTSKlLqS5bXW_vwjjsYCQk5ceunULh5h5S3NGnu1xTNpoG6KGhtqYMTTf8n5-VfYX60QJaUnfvDWEpKDTuylfVEKw94OF_gPUs387YAPVyGwlzgH7ooM25gkZNoh6m2ShuJ9cjrB3qE6ODTbgFFfykD_LE5Of1u5ZknS61kxjOKn5xulIyzTBmwKlsnM3y2tWMmT4IDNWnnZrPNC20xvxJYtQcA
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 94,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": "https://test.test/api/tasks/e2cd2e4110399b415a25a6bb0c4468cbc566b859dab05ba4b7a259f405590629/agreement?state=with_stamp",
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": "customer",
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:27Z",
"current_employment_kind": null,
"description": [],
"document_date": null,
"document_number": null,
"executor": {
"id": 45,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "zena.larson@gaylordlegros.us",
"employment_kind": "selfemployed",
"first_name": "Зинаида",
"inn": "6238168836",
"is_resident": true,
"last_name": "Веселова",
"payment_readiness": null,
"phone": "+79914556217",
"second_name": "Афанасьевна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "online",
"signed_at": "2024-02-19T10:15:27Z",
"status": "canceled",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:27Z"
}
}Request
— Сделка без акта с отсылкой к внешнему договору отмененаPATCH /api/tasks/97/cancel
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjcsInRva2VuIjoiMjJlNjAzYjM1NjJhYjY0OWE2OGY2OGY0N2FiMzcxNTgifQ.oPT8_QI2tewt7WezzFp6VmmIUwwShewBnbByaIdTdyJNbL9rW17Ml_YkQXy5WemaXglIYebm3lClSzqJ867mbzfLaCqCQdGyFSYcqhyKEl7I6HJfHxFImO8QpdVFWqPtXxSVvHda989A7On2eEIz_IK1YuY91NTjE49zOtH5EiRcvnuyqm0jdXXDYrx2hi_09ppTwVMbrGIIdNMu7l6qsZpYzof3E9VjsPwjzXx30tjQyVlEl1aBK_obQI2H1qYcR8SL4tDPQMnobtPYXDO46PMomQg9qG3WvKcc_BYzsAzMyYtTk90kHsSfTVMf6J3c6lCFjPUQuscfVGqCz2lKpA
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"task": {
"id": 97,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {},
"act_required": false,
"additional_commission_beneficiary": "himself",
"additional_commission_from": null,
"additional_commission_ofd_receipt": true,
"additional_commission_ofd_url": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": null,
"agreement_signing_uri": null,
"agreement_uri": null,
"amount_gross": "100.0",
"autopayable": false,
"autosignable": false,
"canceled_by": "customer",
"category": "Доставка ЕДЫ",
"commission": "5.0",
"completed_at": null,
"created_at": "2024-02-19T10:15:27Z",
"current_employment_kind": null,
"description": [],
"document_date": "19.02.2024",
"document_number": 97,
"executor": {
"id": 46,
"citizenship": {
"code": "RU",
"name": "Российская Федерация"
},
"email": "nikia@jaskolskicrooks.ca",
"employment_kind": "selfemployed",
"first_name": "Глафира",
"inn": "3595703919",
"is_resident": true,
"last_name": "Гусева",
"payment_readiness": null,
"phone": "+79845980307",
"second_name": "Фелuксовна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "100.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [],
"signature_form": "manual",
"signed_at": "2024-02-19T10:15:27Z",
"status": "canceled",
"tax_retention": true,
"title": "Доставить ужин",
"type": "OneTime",
"updated_at": "2024-02-19T10:15:27Z"
}
}Request
— Не удалось отменить сделкуPATCH /api/tasks/100/cancel
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjcsInRva2VuIjoiOGQyODA3MTQ3NDZlYjgxYzZlMGFkN2FmN2M0MjUzZTkifQ.KeiQPHkI3fVIQrLD_YWYzMAzI948g3hRca_k5yBvuiMRTA7KBGXwjaznbypocfT4go5cMALgyeZTkOCPrKdtRfthFAf7Zj2MfuI6TMqoYuUZVJl1dgGsHJWpueq5lMT3-ykAIj4jsfMtPxryg_Y1Rzf3qTslmMNK4JU_5TrB-XjFGOWyddW9-Kf_bqJA8a42GpgBrSlxYMuVMEmNh_T0ILXZqHuXycCbEmyugX6VdwRYnerrJiQcQebn_tlCLK-q0aDV5PQBtC5kIa7SQtIalhfxYhNTZpUaXGbimZoleTSkBEMtHTuCRXVHuvZtZIkH6rjT9IF0q_eRbr9WMIWF9Q
Content-Type: application/jsonResponse
422Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Нельзя отменить сделку в статусе inwork"
]
}2. Постбэки на события системы и Подписки ¶
Подписки ¶
Для эффективной работы данные о сделках, собственных счетах и исполнителях должны быть всегда актуальными. Мы сделали Подписки и Постбэки. С их помощью можно отслеживать изменения без регулярного опроса системы. Вы подписываетесь на события, указываете стрим и получаете актуальные данные HTTP-запросом.
Стрим
Стрим - это группа событий, объединённых одной темой. В рамках одного стрима данные о событии имеют одинаковый набор полей (одинаковую сериализацию, раздел “Тело запроса”). Доступные стримы:
-
tasks— изменения статусов сделки, включая статус эквайринг платежа -
executors— изменения исполнителей, привязанных к вашей компании -
company_accounts— изменения основного счёта компании (в разработке) -
additional_commissions— события зачисления дополнительной комиссии
Жизненный цикл постбэка
При возникновения события в системе, на которое оформленна подписка, начинается отправка HTTP-запросов по указанным в подписке параметрам. Отправка считается успешной, если код HTTP-ответа 200 или 201. В случае неуспеха отправка продолжается через экспоненциально увеличивающиеся временные интервалы. Количество попыток регулируется параметром подписки retry_limit. Когда попытки кончаются постбэк умирает.
ВАЖНО! Из-за своей асинхронной природы порядок доставки событий в систему-получателя может отличаться от порядка возникновения событий в системе-источнике. Чтобы избежать отката статуса в неактуальное состояние необходимо сверять happened_at (timestamp возникновения события) последнего обработанного и нового полученного события.
Подпиcки
Подписки на постбэки это ресурс для настройки получателей постбэков
Атрибуты подписки
-
id— идентификатор подписки; -
uri— адрес, на который будут отправляться запросы. Протокол обязательно https. При необходимости произвольный порт указывается через:после домена -
version— версия подписки. Подробнее читайте в разделе Payload:v1(deprecated) — только сериализация отправляемой информации;v2(default) — сериализация отправляемой информации плюс timestamp и название события;
-
http_method— HTTP-метод данных запросов, поддерживаютсяPOST(по умолчанию) иPATCH; -
subscribed_on- Стримы подписки -
authorization_credentials— данные для авторизации, передаются в headerAuthorization:type— тип авторизации, один из:Basic— авторизация по логину и паролю;Bearer— авторизация по токену;
value— значение для авторизации:- для
Basic— base64 “login:password” - для
Bearer— токен
- для
-
retry_limit— количество попыток отправки
Параметры для создания подписки:
| Параметр | Тип | Обязательное? | Описание | Пример |
|---|---|---|---|---|
uri |
str | Да | Адрес для http запроса | https://awesome.domain:8443/send_postback/here |
http_method |
str | Да | HTTP-метод для запроса, поддерживаются POST (по умолчанию) и PATCH |
POST |
subscribed_on |
array | Да | Стримы подписки массивом | ["tasks", "company_accounts", "additional_commissions"] |
authorization_credentials |
object | Да | Данные для авторизации | { "type": "Basic", "value": "bG9naW46cGFzc3dvcmQ=" }, { "type": "Bearer", "value": "462c10d9-3f73-421f-aac6-40606193ad32"} |
version |
str | Нет | Версия сериализации. По умолчанию v2 |
v1, v2 |
retry_limit |
str | Нет | Лимиты неуспешных попыток (от 1 до 15, 15 - по умолчанию) | 10 |
Тело запроса
Тело постбэк запроса зависит от стрима и версии подписки.
Версия v1 (deprecated)
В запросе отправляются только данные без meta информации. Пример:
{
"account_balance": "1000000000.0"
}Версия v2
В запросе помимо данных отправляется код и timestamp события. Пример:
{
"id": 777,
"event": "company_accounts.balance_changed",
"happened_at": "2023-09-16T02:47:26Z",
"data": {
"account_balance": "1000000000.0"
}
}Далее рассматриваем только data
Стрим tasks
Сериализация cовпадает с ответом на вызов GET api/tasks/{id}. См. раздел 1. Сделки и договоры
| Код события | Версия подписки | Описание |
|---|---|---|
tasks.created |
В разработке | Сделка создана |
tasks.accepting |
v2 |
Сделка перешла «На подпись» |
tasks.completed |
v2 |
Сделка перешла «На оплату» |
tasks.paid |
v1, v2 |
Платеж проведен, сформирован чек |
tasks.error |
v1, v2 |
Произошла ошибка при проведении платежа |
tasks.acquiring_order.paying |
v1, v2 |
Ссылка для экайринг-оплаты сформирована |
tasks.acquiring_order.paid |
v1, v2 |
Оплата произведена |
tasks.acquiring_order.trasfered |
v1, v2 |
Средства поступили на счёт компании |
tasks.acquiring_order.refunding |
v1, v2 |
Инициирован возврат эквайринг оплаты |
tasks.acquiring_order.refunded |
v1, v2 |
Возврат завершён |
Пример
{
"id": 9,
"acceptance_signed_at": null,
"acceptance_signing_uri": null,
"acceptance_uri": null,
"acquiring_order": {
"status": "pending",
"vat": "VatNo",
"without_executor": false,
"commission_type": "from_customer",
"with_ofd_receipt": false,
"check_card": false,
"recurrent": false
},
"act_required": false,
"additional_commission_from": null,
"additional_commission_result": "0.0",
"additional_commission_url": null,
"additional_commission_value": null,
"additional_info": "Сделать что-то прекрасное",
"agreement_signing_uri": "https://sign.stg.rocketwork.ru/case/eyJ0YXNrX2lkIjo5LCJzaWduYXR1cmVfY3JlYXRlX3RpbWUiOjE2OTQ4MzUxNjUsImRvY3VtZW50X3R5cGUiOiJhZ3JlZW1lbnQifQ",
"agreement_uri": "https://test.test/api/tasks/3f8e80041b4fe24a2bb3026c63f0a9243dbd38df379f55b7e0ec199844997c27/agreement?state=with_stamp",
"amount_gross": "1000.0",
"category": "Типовой договор",
"commission": "50.0",
"completed_at": null,
"created_at": "2023-09-16T03:32:45Z",
"description": [
"Разработка платформы"
],
"document_date": null,
"document_number": null,
"executor": {
"id": 13,
"email": "zola@sauer.co.uk",
"employment_kind": "selfemployed",
"first_name": "Екатерина",
"inn": "203016903111",
"last_name": "Соловьева",
"payment_readiness": null,
"phone": "+79849014692",
"second_name": "Аркадьевна",
"selfemployed_status": "validated",
"type": "Individual"
},
"executor_signed_at": null,
"external_id": null,
"fee": "1000.0",
"metadata": {},
"paid_at": null,
"payment_errors": [],
"period_duration": 30,
"period_from": null,
"period_to": null,
"receipt_uri": null,
"refund_additional_commission_url": null,
"refund_amount": "0.0",
"services": [
{
"order": 1,
"description": "Разработка платформы",
"unit_price_cents": null,
"quantity": null,
"total_price_cents": null,
"location": null,
"unit": null,
"payment_method_for_ofd": 4
}
],
"signature_form": "online",
"signed_at": "2023-09-16T03:32:46Z",
"status": "draft",
"tax_retention": true,
"title": "Типовой договор",
"type": "OneTime",
"updated_at": "2023-09-16T03:32:45Z"
}Стрим executors
| Код события | Описание |
|---|---|
executors.activated |
Исполнитель зарегистрировался на платформе |
| Поле | Тип | Описание |
|---|---|---|
inn |
str | ИНН исполнителя |
phone |
str | Телефон исполнителя |
last_name |
str | Фамилия исполнителя |
first_name |
str | Имя исполнителя |
selfemployed_status |
str | Статус самозанятости |
Пример
{
"inn": "770001100077",
"phone": "+79000000000",
"first_name": "Ivan",
"last_name": "Ivanov",
"selfemployed_status": "validated"
}Стрим company_accounts
| Код | Описание |
|---|---|
company_accounts.income |
Пополнение счёта компании |
| Поле | Тип | Описание |
|---|---|---|
amount |
float | Сумма пополнения |
executed_at |
str | Дата и время пополнения |
purpose |
str | Назначение платежа |
balance |
float | Итоговая сумма баланса счёта |
transaction_type |
str | Тип транзакции |
type |
str | Тип операции (debit/credit) |
payer |
json | Плательщик |
payer[bank] |
str | Банк (бик) плательщика |
payer[account] |
str | Счет плательщика |
payer[inn] |
str | ИНН плательщика |
payer[name] |
str | Имя/название плательщика |
payee |
json | Получатель |
payee[bank] |
str | Банк (бик) получателя |
payee[account] |
str | Счет получателя |
payee[inn] |
str | ИНН получателя |
payee[name] |
str | Имя/название получателя |
Пример
{
"executed_at": "2023-11-11T00:00:00Z",
"amount": 1000.0,
"purpose": "Поступление средств для компании",
"balance": 1200.0,
"transaction_type": "external_income",
"type": "credit",
"payer": {
"account": "40702810890013000337",
"bank": "1123176",
"inn": "1872654371",
"name": "OOO Good choice"
},
"payee": {
"account": "40702810890013099001",
"bank": "1123123",
"inn": "1872654371",
"name": "OOO Good choice"
}
}Стрим additional_commissions
| Код события | Описание |
|---|---|
additional_commissions.received |
Поступила комиссия от исполнителя |
| Поле | Тип | Описание |
|---|---|---|
executor_inn |
str | ИНН плательщика комиссии |
commission_amount |
str | Сумма комиссии |
task_id |
str | ID сделки, в рамках которой списывается комиссия |
Пример
{
"executor_inn": "770001100077",
"commission_amount": "1000.0",
"task_id": 777
}Применение
Получить список подписокGET/api/postback_subscriptions
Example URI
GET /api/postback_subscriptions
Request
GET /api/postback_subscriptions
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTksInRva2VuIjoiMmZmZDcxYWU4ZDE2NTgxODE5NDlhOTY0YmI3YzIwMzYifQ.OcfdSquPBAHtxL-R99YMYUu7oGMBxRROqI9YAnMUhQN45unFtEMPVYFbrwbDCwrJxH7CYnmSsYUSSJ6bPI2olh4CiB_kl5H7kdZtzupuBLJt2FbQOwRULB7eQNXXDBN4MrtjamMlJacl9uVGCXYUEvTJ_NeYTZfBnC3wMjnhEthMWxxC-DapBZT6mgACvyjgQICVx4U6eIbA4Fd6dZbp6gbphAwMHw-QgRCvL0jpsRzU2QXAnV2ugM8O1aghFRQrva6aGuP42Gpwl8bdX9eVB-ma1Q05JeoxNyvILhkJgPV0v7unhafOvHnL_kklZS9L-5Gz5gpcGCtjNrGxreEbmQ
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
[
{
"postback_subscription": {
"id": 1,
"http_method": "post",
"uri": "http://stracke.us",
"authorization_credentials": {},
"version": "v1",
"retry_limit": 15,
"subscribed_on": [
"tasks"
]
}
},
{
"postback_subscription": {
"id": 2,
"http_method": "post",
"uri": "http://schroeder.ca",
"authorization_credentials": {},
"version": "v1",
"retry_limit": 15,
"subscribed_on": [
"tasks"
]
}
}
]Оформить подпискуPOST/api/postback_subscriptions
Example URI
POST /api/postback_subscriptions
Request
POST /api/postback_subscriptions
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTksInRva2VuIjoiNGYxZWI2YjEzZGJiYjNjYmRiMzA0Mjc3NGU2ODlhYWMifQ.NZTZRFrEXhH85B5sXi64ZSUtMHxy00Uop6qTL4iJeLzPvVhyXRGnLGU3NjNnYbcRW3bt-TSW1BHDYvImTtgi4lVFdSMY-_GDcATqk7u9Eb07Xa2tbwXMG8XWNi6OA05K1bPqNzmWoKDFVu0N2b0HZbUwv2F2v1hrHvdUH58JSTu1XqLmtJjXYtFgribfw0SV1dDh60iG5qFBh1uBwanbn-7BPFBCCU47PcrAqg0c71vlRSwd0u1zV9076CK1w14pBRKZ-HKtFJIrlHmOJCJSh4T6KEeQVvW4NxE4O6e-UtMroJ42r-AkYJLZWj9K6WGifsm1uA4lrJnyu_Bidgfhaw
Content-Type: application/jsonBody
{
"http_method": "get",
"uri": "https://example.com",
"subscribed_on": [
"tasks",
"executors"
],
"authorization_credentials": {
"type": "Basic",
"value": "cm9ja2V0d29yazp3b3Jr\n"
}
}Response
201Headers
Content-Type: application/json; charset=utf-8Body
{
"postback_subscription": {
"id": 3,
"http_method": "get",
"uri": "https://example.com",
"authorization_credentials": {
"type": "Basic",
"value": "cm9ja2V0d29yazp3b3Jr\n"
},
"version": "v2",
"retry_limit": 15,
"subscribed_on": [
"tasks",
"executors"
]
}
}Request
POST /api/postback_subscriptions
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTksInRva2VuIjoiOTk3MWE2ZjA3YzIwMDMyOGQ4ZmZhODM4YmM3MjIxNWIifQ.lBEgKvu8LbVgGIlwCiFlJRUNp2nZDTIcTuvAdzjvnDaoyEulCC0kE1ZQvYoJJn3iSWJZ6YOCJcThXVoYfgYAxvzI2Vwo6qZBOQABoRQg3gDclyw61XdTmmO40YUgSeIcqFvY7LDt4a8HTvODwnVoykb7Vglo7JyvIGOrhjgDNUpKeH-lj-BfJLMEdXI6k-6C-hxgO4eNetrrLC-zwVDa3Ekou-d6vZgToRkah5q-umWSk_9v61FKJFACGHohTBr9RxWSxjCE-4OUSDlge97EwJ7T8TCKQ6gYQuVrjmZGcmcG1rv9FfhJfTl7eZsHqYTq0qNegSbDxETP8w0K8nPivg
Content-Type: application/jsonBody
{
"http_method": "get",
"uri": "https://example.com",
"subscribed_on": [
"tasks",
"executors"
],
"authorization_credentials": {
"type": "Bearer",
"value": "eyJhbGciOiJIUzI1NiJ9.InJvY2tldHdvcmsi.RB6DpWQO4sX_1Ywo67JJ0yctOkSsDnSd-yhmnj2kz5k"
}
}Response
201Headers
Content-Type: application/json; charset=utf-8Body
{
"postback_subscription": {
"id": 4,
"http_method": "get",
"uri": "https://example.com",
"authorization_credentials": {
"type": "Bearer",
"value": "eyJhbGciOiJIUzI1NiJ9.InJvY2tldHdvcmsi.RB6DpWQO4sX_1Ywo67JJ0yctOkSsDnSd-yhmnj2kz5k"
},
"version": "v2",
"retry_limit": 15,
"subscribed_on": [
"tasks",
"executors"
]
}
}Отменить подпискуDELETE/api/postback_subscriptions/{id}
Example URI
DELETE /api/postback_subscriptions/5
URI Parameters
- id
number(required) Example: 5
Request
DELETE /api/postback_subscriptions/5
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTksInRva2VuIjoiNjBiMjZmY2RlNTYxNjVhZGMwODVjNDQ5NWZhNjg0OTEifQ.EtbAYsxZG3-6cm-wNeooq6WRw97uZLrvN9L_nazFKn73uS6xgbTheI63807l9Yg8JZWb1hbC07CUl0OcoxrwZ4OCtGFVEN7oIwS_fowZsmQMKJAQ4vwKaJu-jIjyZqtwaBsD_pYZHQJcfkwhpPBRzJDpsndTZuyr9ZNPd0IXidDmxQzRSI7DnttRxjPHDQ8iHTuz-t6_G2TFxp2rqQKVlNcm9tXUWBBYyyRJA0Dw2--XLRB9JaeehZTfLLR_cmNKSb90zsbEjUj__K-C5Fk9qUEuC1d_j5sd_yMBDaQoji9vI7qrQNZrByAd-R-BSj_uPcqpPxYDP8LJqBN2vVu21Q
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"postback_subscription": {
"id": 5,
"http_method": "post",
"uri": "http://pacocharaynor.ca",
"authorization_credentials": {},
"version": "v1",
"retry_limit": 15,
"subscribed_on": [
"tasks"
]
}
}3. История постбэков ¶
Постбэки ¶
Есть возможность прочитать историю постбэк-событий
Фильтры
| Фильтр | Описание | Пример |
|---|---|---|
filter[event] |
Конкретное событие | tasks.paid |
filter[status] |
Статус отправки постбэка (failed, dead, completed) |
dead |
filter[happened_at_gte] |
Время события ОТ (iso8601) | 2023-09-16T06:39:49 03:00 |
filter[happened_at_lte] |
Время события ДО (iso8601) | 2023-09-17T06:41:49 03:00 |
filter[subscription] |
Стрим | tasks |
Параметры пагинации
| Параметр | Описание | Пример |
|---|---|---|
page[per_page] |
Кол-во событий на странице (по умолчанию - 100, максимум 500) | 500 |
page[number] |
Номер страницы (по умолчанию - 1) | 1 |
Статусы отправки
-
created— постбэк создан, отправка не происходила -
completed— постбэк успешно отправлен -
failed— последняя попытка отправки неуспешна -
dead— попытки отправки закончились
Ответ
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
postbacks |
array | Массив событий | |
postbacks.id |
int | ID события | 1 |
postbacks.event |
int | Код события | tasks.paid |
postbacks.data |
object | Данные по событию (см. Подписки. Тело запроса) | |
postbacks.happened_at |
string | timestamp события (iso8691) | 2023-09-16T03:40:49Z |
postbacks.status |
string | Статус отправки | completed |
meta |
object | Мета информация о пагинации | |
meta.current |
int | Текущая страница | 1 |
meta.total |
int | Общее количество постбэков | 1000 |
meta.last |
int | Последняя страница | 10 |
Получить список постбэков по фильтрамGET/api/postbacks
Example URI
GET /api/postbacks
Request
— Список постбэковGET /api/postbacks?filter[event]=&filter[happened_at_gte]=2024-02-19T13:14:27 03:00&filter[happened_at_lte]=2024-02-19T13:16:27 03:00&filter[status]=&filter[subscription]=tasks
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MjcsInRva2VuIjoiN2JiYmUyODIyOTJkMDVlOGIxNjFmOWQ1ZGI0ZGUxNjcifQ.arV7hqCDjhOPKBiCYIQYpJOLeFHaSeo4iWsPLhDpWbx_RB_zWpDDO0m2Xp6xUKzZzfTFehbyuE94Jve9cMQJFzEjFmWYa97vFDvjcWRKuiREtu3IsI4_ERFVOIo7tkkZJPQrudxhlFhXoaL1tZd9zuOvvgQ4m87BLzjE4XNhFOtJnIj021jvHaxPjCr6xNvefJ1FTuBvAv9USshI0qnJGs7VMQT-Ud4GuI3VHMKevwqnN3K-LYzd_kEwhpUwxIoPrqTlcKtCzgUMYnT9hCn8LA-oS5H1mlLWK4602ajvpUBNSYarbYkPsjmPCDcJkSN1CN3JjPN9Ch8fVBBG-gxqbQResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"postbacks": [
{
"id": 1,
"data": {
"id": 101,
"fee": "100.0",
"type": "OneTime",
"event": "task_updated",
"title": "Доставить ужин",
"status": "draft",
"paid_at": null,
"category": "Доставка ЕДЫ",
"executor": {
"id": 49,
"inn": "9247107867",
"type": "Individual",
"email": "myles@douglasmoore.co.uk",
"phone": "+79514718161",
"last_name": "Ширяева",
"first_name": "Нонна",
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"is_resident": true,
"second_name": "Вячеславовна",
"employment_kind": "selfemployed",
"payment_readiness": null,
"selfemployed_status": "validated"
},
"metadata": {},
"services": [],
"period_to": null,
"signed_at": "2024-02-19T10:15:27Z",
"commission": "5.0",
"created_at": "2024-02-19T10:15:27Z",
"updated_at": "2024-02-19T10:15:27Z",
"autopayable": false,
"canceled_by": null,
"description": [],
"external_id": null,
"period_from": null,
"receipt_uri": null,
"act_required": false,
"amount_gross": "100.0",
"autosignable": false,
"completed_at": null,
"agreement_uri": "https://test.test/api/tasks/f43447ac7f2ce467b2f22c3bb8f13de96dee427d9561bde0bd4ee27b570b4c0f/agreement?state=with_stamp",
"document_date": null,
"refund_amount": "0.0",
"tax_retention": true,
"acceptance_uri": null,
"payment_errors": [],
"signature_form": "online",
"acquiring_order": {},
"additional_info": null,
"document_number": null,
"period_duration": 30,
"executor_signed_at": null,
"acceptance_signed_at": null,
"agreement_signing_uri": null,
"acceptance_signing_uri": null,
"current_employment_kind": null,
"additional_commission_url": null,
"additional_commission_from": null,
"additional_commission_value": null,
"additional_commission_result": "0.0",
"additional_commission_ofd_url": null,
"refund_additional_commission_url": null,
"additional_commission_beneficiary": "himself",
"additional_commission_ofd_receipt": true
},
"event": "ev3pdz",
"happened_at": "2024-02-19T10:15:27Z",
"status": "created"
}
],
"meta": {
"current": 1,
"total": 1,
"last": 1
}
}4. Создание и получение данных о счете организации ¶
Счет организации ¶
В API Рокет Ворк есть возможность получения данных о балансе счета организации, а также реквизитов для пополнения.
В ответе сервис возвращает следующие данные:
| Параметр | Тип | Описание |
|---|---|---|
| company_name | str | Наименование организации |
| company_inn | str | ИНН организации |
| balance | float | Баланс счета |
| requisites | json | Реквизиты для пополнения |
| requisites[bank_bik] | str | БИК банка |
| requisites[account_number] | str | Номер счета |
| requisites[correspondent_account] | str | Номер корреспондентского счета банка |
| requisites[bank_name] | str | Наименование банка |
| requisites[inn] | str | ИНН платформы |
| requisites[kpp] | str | КПП платформы |
| requisites[purpose] | str | Назначение платежа |
Получение баланса счета и реквизитов для пополненияGET/api/account
Example URI
GET /api/account
Request
— Данные полученыGET /api/account
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTcsInRva2VuIjoiMmI3MDMxMWQzZTEzNmJhNTlkNTQyNWI5ZjNjOTFmZGMifQ.nAMHg18JE0ClxcM8d3vbRsB5DVKhyCIO3BWie59zGDG85I2a7H68314-uVZ6q6nL6zGdmpO61HqnZ1URR5wnvZzJ-8DVmzzr1mBkOHb0BgbyyPpmjVRmQKKZecCaO-XtyPPlzyXLEFHA05lzvEpNi0ttAoVy8d6iV7O7kkl2v3EwRKFJfwRZ71pK-VqqyMhZxMkcEk_Uf7nJgPRVUFFtnk-TUrtxS2Qyacy-LqeJvWOtJBpgmQ8akUdefDR1Qa7uvSrDqdWUBPxeqlyK1pVLDKvkqv9v_-sK5VRF3mEwc-yrot9L_twXH_DQjZ67Bm8TRbSZ5whms-cyM-pvPS8m9Q
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"balance": 307856.09,
"company_inn": "797314482869",
"company_name": "LLC Name",
"requisites": {
"bank_bik": "044525999",
"account_number": "40702810701500083029",
"correspondent_account": "30101810845250000999",
"bank_name": "ТОЧКА ПАО БАНКА \"ФК ОТКРЫТИЕ\"",
"kpp": "770101001",
"purpose": "Перечисление собственных денежных средств LLC Name, ИНН 797314482869 по Соглашению об использовании электронного сервиса Рокет Ворк для оплаты исполнителям. Без НДС",
"inn": "7720496561"
}
}Request
— API токен неактивенGET /api/account
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTcsInRva2VuIjoiYjBlOWMwYzc2ZDkxODYzNTAxMWNiYzlkMTZhNTRhODgifQ.Lgp0VvFEyhZZctjAQzMqkLv0oHXsx3DtvtDUzCjv1Nwf3SqaQGgUSsbldrL1O7Ymtf5VA_nMUqSjsdRv1v9zxoe0y7VJ1Nk4JbBd8rBPdOBd7VgkiH60Cc2_SJDI4C_nZG3MKxPmpWQNbdDWfpmHHZ6Aa1Q6zVoLnVupvLKloqEIunkTVmvcWdBd0OiSWiFAildhWECo3EH8wQ6sGKwjqDusUrFRupz2sCDo5qQDTIeZ4nVbQKPEm-Vm2JQs8eGjD2uy9oN4oSbTtZgE_wiPupYSzm6kRD8LJfVfoiNPzVm6tzkeCQ_jrLrZByKh0GRNelvdUd7ncTG6WxqckMqHLg
Content-Type: application/jsonResponse
401Headers
Content-Type: application/json; charset=utf-8Body
{
"message": "Inactive authorization token. Contact administrator to reissue"
}Request
— Некорректный API токенGET /api/account
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTcsInRva2VuIjoiNjhiZGE2YTNkYzM3ZTA5ZjQ2ZDMzNDdmZjkyMjAwZTIifQ.M63TFgdZRUT_SoDNKUV0QyFbLK4TDZY0vHOVpjh3oXDnM-L4Vhk5rDE28e6AstWvW2rv9nzsF4Er590QbTgnPoa4AlMVd6FRbjuwnSBCcI1Ft6Ujpk-Q6sjK5kkppNOSNu-AJoYS4FhiW8QhFaNNnmya_voC77EovU-cqlpbT8xMwfeNv5xS90CqIAjYirSL548-X1f1nnvXhGdHLme5gDkUcnix75mEQrIDOP34XJ2NdbTw9zAueRFPqkvC4AV-dPb5AZpCTJGnuonKSKopgNYshj9YMe5Xoz-QbSc7YgP0G4mtLPUmZeyD73_uEG-tpI_i7fjNtj0W1ewQr0PNNw
Content-Type: application/jsonResponse
401Headers
Content-Type: application/json; charset=utf-8Body
{
"message": "Authorization token signature verification failed. Check token correctness or contact administrator to reissue"
}5. Создание и получение данных об исполнителях ¶
Исполнители ¶
Данные исполнителя:
-
type— тип -
first_name— имя -
second_name— отчество -
last_name— фамилия -
phone— номер телефона -
inn— ИНН исполнителя -
is_resident— Резидент ли исполнитель -
employment_kind— тип занятости исполнителя. По умолчанию —selfemployedselfemployed- самозанятыйcivil_contract- исполнитель, работающий по договору ГПХentrepreneur- индивидуальный предпринимательself- собственный счёт для вывода денежных средств
-
selfemployed_status— статус самозанятости, один из:unknown— Неизвестно. Исполнитель не указал ИНН для проверкиnot_selfemployed— Исполнитель не стоит на учете как самозанятыйpending— Отправлен запрос на выдачу правneed_permissions— Исполнитель отозвал права или отказал в выдачеvalidated— Исполнитель выдал права
-
payment_readiness— статус исполнителя, один из:all_is_well— Всё в порядкеno_payments— Выплаты недоступны. Исполнитель не указал ИНН или паспортные данныеno_tax_account— Недоступна уплата налогов. Исполнитель не предоставил необходимые персональные данные для уплаты налоговno_tax_payment— Недоступна уплата налогов. Исполнитель не предоставил права на уплату налоговdebts— Задолженность перед ФНС. У исполнителя есть неуплаченные налоги за предыдущие периодыno_requisites— Нет доступных способов оплаты у исполнителя
-
payment_info— данные о счете самозанятогоbank_account— данные о банковском счетеbic— БИК банкаaccount_number— номер счетаerrors— описание ошибки создания картыerror_effective_for— дата и время, в которое ошибка была актуальна
bank_card— данные картыcard_number— маска картыerrors— описание ошибки создания картыerror_effective_for— дата и время, в которое ошибка была актуальна
sbp_account— данные о СБПbic— БИК банка, в котором у исполнителя подключен СБПbank_id— ID банка в ОПКЦ СБП НСПКphone— номер телефона в формате +7XXXXXXXXXXerrors— описание ошибки создания картыerror_effective_for— дата и время, в которое ошибка была актуальна
-
citizenship— гражданство исполнителяcode— код страны в формате ISO 3166 alpha 2name— название страны на русском языке
Параметры для создания исполнителя:
| Параметр | Тип | Обязательное? | Описание |
|---|---|---|---|
type |
str | Да | Тип исполнителя:Individual - физлицо (самозанятый, ГПХ, ИП)Withdrawal - счёт для вывода собственных средств |
phone |
str | Да | Номер телефона исполнителя в международном формате |
inn |
str | Да | ИНН исполнителя (12 символов) |
last_name |
str | Да | Фамилия исполнителя |
first_name |
str | Да | Имя исполнителя |
second_name |
str | Нет | Отчество исполнителя (при наличии) |
gender |
str | Нет | Пол. Одно из:malefemale |
birthdate |
str | Нет | Дата рождения (YYYY-MM-DD) |
birth_place |
str | Нет | Место рождения |
passport_series |
str | Нет | Серия паспорта |
passport_number |
str | Нет | Номер паспорта |
passport_issued_at |
str | Нет | Дата выдачи паспорта (YYY-MM-DD) |
passport_issued_by_name |
str | Нет | Орган, выдавший паспорт |
passport_issued_by_code |
str | Нет | Код подразделения |
registration_address |
str | Нет | Адрес регистрации с точностью до номера квартиры |
employment_kind |
str | Нет | Тип занятости исполнителя. Одно из:selfemployedcivil_contractentrepreneur |
payment_info |
json | Нет | Платежные данные исполнителя |
payment_info[bank_account] |
json | Нет | данные банковского счета |
payment_info[bank_account][bic] |
str | Нет | БИК банка |
payment_info[bank_account][account_number] |
str | Нет | Номер текущего счета |
payment_info[card_number] |
str | Нет | Номер карты российского банка |
payment_info[sbp_account] |
json | Нет | данные о СБП |
payment_info[sbp_account][bic] |
str | Нет | БИК банка |
payment_info[sbp_account][bank_id] |
str | Нет | ID банка в ОПКЦ СБП НСПК / Допустимо использовать вместо БИК |
payment_info[sbp_account][phone] |
str | Нет | номер телефона, к которому подключен СБП |
Применение
Зарегистрировать исполнителя в Рокет ВоркPOST/api/executors
Example URI
POST /api/executors
Request
— Исполнитель успешно созданPOST /api/executors
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTcsInRva2VuIjoiMGE2NmQ2OTg0MzQzYTQwYjk2NDEyZTI0MjQ0MmZmZjMifQ.MgrnetVz_A47Nt1outDKYQR2G54UcIUOQZTsO0uV2z-YavHQ5pN47c_51KSLmJzFwJA8LPqL7UC0UJS1Qt4puFxCimCZaQNBmty890_Uz9XHf-4NAXbq7QoDd56TFWgDrvincbMuNq-6BXEuDSxAkamchO4PbrHq083vvdi9F-2fEr4zDD7JJ0i2wzfx_93droCSzFFx0VgxkVt4Xqzy9DyhOQUjuyGZ0XODBNY3Ht0W4DHM7e8gyxFntp4no5HnMuT2tSxdcHkRE2QCDOyvKfnhhtJUzF5Hl_NOMhcvgM1bYFDli7ASWEREVX3If7DOHL5zCJEUZSzE82kmozF9Tg
Content-Type: application/jsonBody
{
"executor": {
"external_id": "a0dd5049-d414-4eee-b96c-46e48c598ac0",
"inn": "770001100077",
"phone": "+79000000000",
"first_name": "Имя",
"last_name": "Фамилия",
"second_name": "Отчество",
"payment_info": {
"bank_account": {
"bic": "044525000",
"account_number": "408178100000000000000"
},
"card_number": "5443310000000000",
"sbp_account": {
"bic": "044525000",
"phone": "+79000000000"
}
}
}
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"executor": {
"id": 1,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "",
"employment_kind": "selfemployed",
"external_id": "a0dd5049-d414-4eee-b96c-46e48c598ac0",
"first_name": "Имя",
"inn": "770001100077",
"is_resident": false,
"last_name": "Фамилия",
"payment_info": {
"save_active": null,
"bank_card": {
"card_number": "544331******0000",
"errors": [],
"error_effective_for": null
},
"sbp_account": {
"bic": "044525000",
"bank_id": null,
"phone": "+79000000000",
"sbp_check": null,
"errors": [],
"error_effective_for": null,
"name_sensitive": null
},
"bank_account": {
"bic": "044525000",
"account_number": "40817810000000000000",
"errors": [],
"error_effective_for": null
}
},
"payment_readiness": null,
"phone": "+79000000000",
"second_name": "Отчество",
"selfemployed_status": "unknown",
"type": "Individual"
}
}Request
— Исполнитель успешно создан | Добавление СБП с идентификатором банка в НСПКPOST /api/executors
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTgsInRva2VuIjoiMzBjYmRmZDQxYjAwNGMwZWE4NGJhMWVlMDFjMDJmODgifQ.txdvLUQ2TL7jmjXYbB7xo99Os1Mgax6F1-ZM-0e4bjWx94V_AqBkRnjcH9efwmHPPDCxa6r7kG6I2jnjYz9S2EsmuSSLI7HadewkzSSeUKv2UshzOaL7zHVTNHKSLSUPIgMuY9_Jhnlv_b5CufEq9Shf99PDXkqUQYN56XpZNwmdtqIcZ7n-P2zm5efMqs7PHZbeH2hij2w5ygpuliU6sGHmY4n4R5GKtrX7KfOk5ObLdzdAWAE1qtG_YEf_T8b01lm08zcshotEP_PRWWPAPBWBzwq2xLs1X1TWiFnz-QMUTKEYMEyKVCokCB3hheyMJQsDtVaN0jXQjjJW1aVBDA
Content-Type: application/jsonBody
{
"executor": {
"external_id": "7be7a511-ca4e-4a68-ab74-852c13567f08",
"inn": "770001100077",
"phone": "+79000000000",
"first_name": "Имя",
"last_name": "Фамилия",
"second_name": "Отчество",
"payment_info": {
"sbp_account": {
"bank_id": "10000000000",
"phone": "+79000000000"
}
}
}
}Response
200Headers
Content-Type: application/json; charset=utf-8Body
{
"executor": {
"id": 2,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "",
"employment_kind": "selfemployed",
"external_id": "7be7a511-ca4e-4a68-ab74-852c13567f08",
"first_name": "Имя",
"inn": "770001100077",
"is_resident": false,
"last_name": "Фамилия",
"payment_info": {
"save_active": null,
"bank_card": {
"card_number": null,
"errors": [],
"error_effective_for": null
},
"sbp_account": {
"bic": "044525000",
"bank_id": null,
"phone": "+79000000000",
"sbp_check": null,
"errors": [],
"error_effective_for": null,
"name_sensitive": null
},
"bank_account": {
"bic": null,
"account_number": null,
"errors": [],
"error_effective_for": null
}
},
"payment_readiness": null,
"phone": "+79000000000",
"second_name": "Отчество",
"selfemployed_status": "unknown",
"type": "Individual"
}
}Request
— Исполнитель не созданPOST /api/executors
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTgsInRva2VuIjoiOGIzMzZkMTFkYzcxYjRlMWIxNzA3YmJhZTEyNTA1ZTEifQ.C0ebBLdYmOAgZCTbokIpnL-AvDZO6RwEsdDLu8eoU7EFTJOJZijuXSWAsp82IG2WQBdeb-Xvfdx2P3SbNyNqFUTs2bc3zYnfmDZjYPj9afE_B3uWKPuBto9f-HzmESykbT8eScR8Ns32ufvQcuQ0EOOaV1dDcSPcY-xZuPn6-GoXNcqqVyk0bc5CUAuTLE_uP7zDWTSZrKSvUIrZo0HTddfvgYrtVY5BJWGbSNnlUm2z2KYj3GydBXugk0sr3yUpofd7PnayS8FR2d1FepHqtgRc_MyipGtfh6vjt0dnlWBFm_WXihLFZOCLAUZIHpoOz8KLv376oydIidDdB_uNHQ
Content-Type: application/jsonBody
{
"executor": {
"inn": "7700011000",
"phone": "+79000000000",
"first_name": "Имя",
"last_name": "Фамилия",
"second_name": "Отчество",
"payment_info": {
"bank_account": {
"bic": "044525000",
"account_number": "408178100000000000000"
},
"card_number": "5443310000000000",
"sbp_account": {
"bic": "044525000",
"phone": "+79000000000"
}
}
}
}Response
400Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"ИНН должен состоять из 12 цифр"
]
}Request
— Ошибка добавления картыPOST /api/executors
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTgsInRva2VuIjoiZGU2MmFlNjcyMzczNzVhNTFmNzNhZmExNDBlYzlkOGEifQ.LV_JxukMMMpFFOkVWtQKjlnA1IdlywcTdrZQTub4tDj_LAtVEGGznyYk3nGagvB-9q020tAXtKL_OjK5GGaelxnWZqgYm6hwk3mOveC_1faWexp4JtFUBimJ3FBF_zozMmp23eFEMA2eR2JpDOk8iMRy_9YCbOzj_kev2WByFPZSAt_0gVmLC8kxVLPo65XvqNiY3vtqaxNGfGhkgqNJdBYUMOKiqwdsFOVO8kuMoUqrISrOj5XqJFb8J5MPf2xMts9pKEPXJWriSWSMkSzE8k0CWSI-xRdCyfD4swutJnf_XvAGk4_N7tmPqg2dngSiXdi2rdk-g5TMq_CUXJixOw
Content-Type: application/jsonBody
{
"executor": {
"external_id": "e92387a6-1abb-4a6a-8781-405da6734a9e",
"inn": "770001100077",
"phone": "+79000000000",
"first_name": "Имя",
"last_name": "Фамилия",
"second_name": "Отчество",
"payment_info": {
"card_number": "5443310000000000"
}
}
}Response
400Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
{
"card_number": "544331******0000",
"created": false,
"errors": [
"Банк не найден"
]
}
]
}Request
— Ошибка добавления СБПPOST /api/executors
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTgsInRva2VuIjoiMzhkMmUyZTFjNDJhNDJkMTA5ZTM4OWJlYTQyYWE5NDUifQ.bc-JMA-NfehIcksJmrhXrRK41AqZWsZ-OLrAgKl2MD3E1KTih-2Gj6ScxGticklzTXExKCmoiYGCfturBxnlc2wyQYV2imvwqFAsCASu1rZ-1WCRZaaWsKb6dfu8fbbgD1ViS48BEQqAX9iybxafd5WE-ONhd-Cri4sq5LJDIISiY3qyHN-M77nDosny77OgXwWnuWjQrXveFcxeVcRVKsGOmcKUZnDxW0k_NLMsHNkJG7bzSBZayLVaXv3UfUldi8-zPyuLAoS-1rQDdvbwNnEGy9d71cBNPcC4Y5RsOe8lzZD1mDA3u0oWJ76gNPRiwY0qo0RSb6zn_MVUKyON-g
Content-Type: application/jsonBody
{
"executor": {
"external_id": "deb4107f-df87-4002-bab1-72e0d184f2be",
"inn": "770001100077",
"phone": "+79000000000",
"first_name": "Имя",
"last_name": "Фамилия",
"second_name": "Отчество",
"payment_info": {
"sbp_account": {
"bic": "044525000",
"phone": "+79000000000"
}
}
}
}Response
400Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
{
"phone": "+79000000000",
"created": false,
"bik": "044525000",
"errors": [
"Банк не подключен к СБП"
]
}
]
}Request
— Ошибка добавления СБПPOST /api/executors
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTgsInRva2VuIjoiMTJjZTkzMDAzNzI2ZWVhZGQwZjY1ZDRkNDA5YTg0NjUifQ.V-OA26-Y3vYRtgO3tYI1R6XBAxz_hxXIm6OMzvjkOynqDrqLEDcjl-iyzPUrJeX5wQ5ZuYxGcCFRI_BbkwdtaI8NdxcyAixyltK1pzF_buzhFEcPeq60QLCvdvwExkzqxXkZ7A5QTJjuVdgtl3r-42qlKSNXjOirvGHLYX9AhxbMrAiuH8nGYw6-pUGg2uBlv1BAODdi79CLS1QOr8eZcP534b2JAZ3OfGb67thE46WJHAfW_CUoBfNGh1IQwlDvqnsleu1nEeyqYm07aB087pQSqx--rLWL1uZKwSmw4DHxdL4NekJW1cJCEq95W0rwFuPAMRGKG6phkuYwO7SeEg
Content-Type: application/jsonBody
{
"executor": {
"external_id": "4203eca3-33a1-4620-b8a5-0f3c04095323",
"inn": "770001100077",
"phone": "+79000000000",
"first_name": "Имя",
"last_name": "Фамилия",
"second_name": "Отчество",
"payment_info": {
"sbp_account": {
"bank_id": "10000000000",
"phone": "+79000000000"
}
}
}
}Response
400Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
{
"phone": "+79000000000",
"created": false,
"bank_id": "10000000000",
"errors": [
"Банк не подключен к СБП"
]
}
]
}Request
— Ошибка добавления реквизитов банковского счетаPOST /api/executors
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTgsInRva2VuIjoiNmQ5NWVkYWRkYWUwOWQwODNmYWEwZWM1YWI5MWU2MzYifQ.H9feqpzB19HfXWWZEOsYvnozwJwfDbtd3BBMcQAECEyofbM0LU2dfzO-Vp00TEE_BstsGYip8ne0fMtvN22X5VOUKFVI4AYPniHpS3gFP7mPZS7eNvyOz7mTaPg8Nfm8d8rRFL0kMyw5W63IpcjPUPuhMfZsD4pZOa9py21fJ9EoTTEhfW0af8Kg4A0YInBWHt7fLIKKbHQxgwKjFLCj8SBUgI7J8HitWVU5-AAll3TEc3uKjCxwttYHPgxm-u1qaM5qbb7KNRMJg-9rHWHTpT7HaMkrv5-zOPaT1SJc3AJnhrnB2mNpQlFqTwEfggTtWf1K_NxeMGvhxI1muaaNaA
Content-Type: application/jsonBody
{
"executor": {
"external_id": "a6087272-fd64-45fe-8494-38d0e9664feb",
"inn": "770001100077",
"phone": "+79000000000",
"first_name": "Имя",
"last_name": "Фамилия",
"second_name": "Отчество",
"payment_info": {
"bank_account": {
"bic": "044525000",
"account_number": "47416810000000000000"
}
}
}
}Response
400Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
{
"account_number": "47416810000000000000",
"created": false,
"bik": "044525000",
"errors": [
"Account number not keying"
]
}
]
}Поиск по номеру телефонаGET/api/executors/+79000000000
Example URI
GET /api/executors/+79000000000
URI Parameters
- id
string(required) Example: %2B79000000000
Request
- Исполнитель найденGET /api/executors/ 79000000000
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTgsInRva2VuIjoiMTZiMjJjZjc5MmMyZjMwMjgzNzhhYWIxY2FmN2U3Y2YifQ.BeM3iZhVaWp77Dxqy8SeVL0oIOpsQuHRoBnXBTPFDHFnj-t4tpQwbZylWS0IGD_ekcBDOf58mxSdnQj_-VKJhHPv7J1pWG3FOalr1aj6H59_wTDYLIC6xPHu7490YK5LQz1LXhz5fbXz9t5A3eG4al7TlJF_px084CWUy11Cpw7x6UzkQHe5aZxz1MHQ6PeFHuCsarnvg-QoI9u0z13XevpS3k895C-7_52_rKJhuTHNskEEAKDS-T62QRm-vJvwhlqFsdEH-Sq3ZRbdvBJVIMtSv3kDr39NkFIyk760Hr-zA3B-aU3oOBIV7Fgz4ZYMltN0ICAIfdNX5sPxb3AW-Q
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"executor": {
"id": 7,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "hello@test.test",
"employment_kind": "selfemployed",
"first_name": "Октябрина",
"inn": "770001100077",
"is_resident": true,
"last_name": "Анисимова",
"payment_info": null,
"payment_readiness": "all_is_well",
"phone": "+79000000000",
"second_name": "Федоровна",
"selfemployed_status": "validated",
"type": "Individual"
}
}Request
- Исполнитель не найденGET /api/executors/ 79101230000
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTgsInRva2VuIjoiZTlkYjk0YzQ0NWM0NzAzZmU3YTQ2MGE2MjgyYjE5NWUifQ.Gim5y2G8mqAXVTF590XHMD3_Etsq65jKfijWaSAxamBM-B5fOHTElNrOqzznMeOs9GJPlQ3IProgBuC_r46o76L7SrCpFXXluiNSELkQSf4_SgHmOq6QpnJzsvXXdzXkMzWuOWCnwOBMk2tLZ3Fcx31w05gUbDkjxqLQ5Pj-Tpxt9Bznf-y2MQKxj688rs3qCq-Z_oHxhfbury6LIRILg8372aABihyaE_i2QmBSdbZHSGoAIOMCoBg01UDsiifPHx8RKUxtNsEessKB3CNCUG5cnRiKvOcJNpiaD-2fyTbzuITt2PSz3T_oizB5C9aAhaC9Klp7dBe5AcGu2GtF0A
Content-Type: application/jsonResponse
404Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Исполнитель не найден"
]
}Поиск по ИННGET/api/executors/{id}
Example URI
GET /api/executors/770001100077
URI Parameters
- id
number(required) Example: 770001100077
Request
- Исполнитель найденGET /api/executors/770001100077
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTksInRva2VuIjoiZGZlNjVjMzNjNDFhMzFiZmJmY2JlMGRmMzg0ZTliNTMifQ.yJq6SsAhny-t7z6pUo_WSA8-E_RQJXw381uWhWydNil6b_DTPg4hwv37pcKefs-UKrb-7L6DvgQuk10kCjbqGBs4i2L48iimqW1KO3Wc530HRWwY1cHIUGqnV7dIhlCoVxSvVcyQxU0PS9mHsg1CxOinXo2jvbVM4leCogsXf9-1NaR_DZvV9pCl1AZbnUpFPLikJ1MgDc-KIDVYpjwqKU5RL6OR3zQ3m3_fq0GBIAUIl2mDuIw9lqfr2TcjHHztD2UVvS_IdWBXUbuvz9z4aV4_qrWT8iVANqZ5n3kL2pmvVKhCktO-ZzeOQlp-4iNIQtOudq_Va0zC9kf61j7H7w
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"executor": {
"id": 9,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "hello@test.test",
"employment_kind": "selfemployed",
"first_name": "Серафима",
"inn": "770001100077",
"is_resident": true,
"last_name": "Григорьева",
"payment_info": null,
"payment_readiness": "all_is_well",
"phone": "+79000000000",
"second_name": "Витальевна",
"selfemployed_status": "validated",
"type": "Individual"
}
}Request
- Исполнитель не найденGET /api/executors/1234567890
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTksInRva2VuIjoiOWU3YzZhY2QxOWY0YWIwZmY1N2I0ZjRhMWQxNTc3YTEifQ.dl8MPUT1lvjnyXDbCKwzER-dmlYCxYLsb9BsedKnm-G0DyQFnqTk7qq2TayYJU1JsJBFF_7gHupH8Qtx40T80gPb57Qv98mL96MllTIB6xUPx_WqxlGdMLiIx6SMMqX69d4FwHdmpNvJyxX67tQ3OrvXcJbrNoqMvb4qojbY4o-MdwJ8XBn2U6Qaf5STG9HWUoUlQSB3xaFlbCSu-wXnTmgKheHumSstYUD-KNYiPDsyp3Na_YOMD-S-utWup_qT9C_FUQlXglPtWt_nkVrwG-dnYVwTllE3nxNzNUp0HtH8k8kxaPgYZlse2IUbVs0TcT6ffEqyy-LxiEhXJVlCPg
Content-Type: application/jsonResponse
404Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Исполнитель не найден"
]
}Поиск по emailGET/api/executors/hello@test.test
Example URI
GET /api/executors/hello@test.test
URI Parameters
- id
string(required) Example: hello%40test
Request
- Исполнитель найденGET /api/executors/hello@test.test
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTksInRva2VuIjoiYTRjNmFmNWEyMmFkZWRmYjM2MjQ2ZTI3YzdmODYzNTgifQ.swVM_G1XVpsYvzSIT-_St5Z-LfHuu3ox2fTfg8TeCifXwQbH4SD2PpcyNI2gM5Fp5cbP2BKESoL5WeI0e1XNHPaS1Q9DaNYTPPWbo1Na3DMy99xJUQbrw718qnwZHBT21ymMiKvcDLL9RCGk37zgmrsb4D4E42dk1xkoYbj_in_LiMFOpkHYNX4hcoxlEZNnEDF-Mwd0NsuBXPSqd-M_a3cdOZaks8943OFgo251dQPSsEXQG1xk1EBoi3WA207yOGhBi0-D2pm2P-e6CNAUpWmF13vKFC-fLxasKQpUjL0Ks0TEdCFFpU0tKlgr7Cm-Pb3zUzYEgGxQ792r5tBC2Q
Content-Type: application/jsonResponse
200Headers
Content-Type: application/json; charset=utf-8Body
{
"executor": {
"id": 11,
"citizenship": {
"code": null,
"name": "Неизвестно"
},
"email": "hello@test.test",
"employment_kind": "selfemployed",
"first_name": "Лариса",
"inn": "770001100077",
"is_resident": true,
"last_name": "Фролова",
"payment_info": null,
"payment_readiness": "all_is_well",
"phone": "+79000000000",
"second_name": "Михайловна",
"selfemployed_status": "validated",
"type": "Individual"
}
}Request
- Исполнитель не найденGET /api/executors/hello@bye.com
Headers
Accept: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MDgzMzc3MTksInRva2VuIjoiMzUxMjkyYzNjMTc1NDhjMTRmNTM3YmI2MTE4MzQ0NjkifQ.lnCx2ChK8LMlkMeXd-LKedAAUHyT1gtiWvFr_T39d52ODPdN7QO78SQH1wOtzjsdbCQISnloeaKtFY5ZLOXouSCqoYnLFCAlSTGc94Ei26t4ezarAnd5P1Mh_em2lBt8vjhXDGFfJVgYC6A4lU5Rt8Xn_W3Pvw19lk2Zg-GKW8QXhrwZn1fm74VfTipNH2qhgqd3qndP5qdjeCa7kNTWcfWp4Or0FmNlITH-1lO-vUtF7CszuHFJ_wF1zDa3jNWjoOU7ZyEJr-KUib2iRVoCdKHhobJhZTgpC5UaXZNQc4bBbJgtUvGRRi9kwwIbex1BipozNIagNTNq0fe_QCZTow
Content-Type: application/jsonResponse
404Headers
Content-Type: application/json; charset=utf-8Body
{
"errors": [
"Исполнитель не найден"
]
}