...
Создание апелляции для счета или выплаты для начала процесса.
...
Эндпоинты:
- POST /merchant/Appeals/CreateInvoiceAppeal (для счетов)
- POST /merchant/Appeals/CreateWithdrawalAppeal (для выплат)
Запрос:
POST /merchant/Appeals/CreateInvoiceAppeal HTTP/1.1 |
...
Результат: Получение ID апелляции (H7OOOH-Q206B-ULЗY4V) для дальнейших действий.
---
Шаг 2: Прикрепление файлов
Загрузка файла (PDF, JPEG или PNG, до 10 МБ) для предоставления подтверждающих документов.
Эндпоинт: POST /merchant/Appeals/UploadFile
Запрос:
POST/merchant/Appeals/UploadFile?appealId=H7OOOH-Q206B-ULЗY4V&externalId=upload_123 HTTP/1.1 |
...
Результат: Получение ID загруженного файла (file_456) для ссылки.
---
Шаг 3: Проверка статуса апелляции
Периодический запрос данных апелляции для отслеживания статуса и обновлений.
Эндпоинт: GET /merchant/Appeals/GetById
Запрос:
GET/merchant/Appeals/GetById?id=H7OOOH-Q206B-ULЗY4V HTTP/1.1 |
...
Результат: Получение текущего статуса (Created, Rejected, Accepted и т.д.) и просмотр истории, сообщений и прикрепленных файлов.Шаг 3: Проверка статуса апелляции
---
Дополнительно: Получение коллбэка о сообщении Арбитра
Коллбэки отправляются на зарегистрированный URL-адрес мерчанта или агрегатора при появлении сообщения от арбитра в апелляции. Это позволяет оперативно получать уведомления об обновлениях без необходимости периодического опроса статуса через GET /merchant/Appeals/GetById.
Условие отправки коллбэка:
Коллбэк формируется, если в апелляции появляется сообщение от арбитра.
Эндпоинт для настройки коллбэков:
Мерчант или агрегатор должен зарегистрировать URL для получения коллбэков через соответствующий API-метод (например, POST /merchant/Callbacks/Register — уточните у администратора API).Структура коллбэка:
{ "entityType": "Appeal", |
...
- Поле entityType всегда имеет значение "Appeal".
- Поле appealId указывает ID апелляции.
- Для апелляций по счетам используются поля invoiceId и invoiceExternalId.
- Для апелляций по выплатам вместо invoiceId и invoiceExternalId используются поля withdrawalId и withdrawalExternalId.
- Поле message содержит текст сообщения от арбитра.
- Поле files содержит массив прикрепленных файлов (если есть), с их ID, ссылкой для скачивания и именем файла.
...
Получение коллбэка позволяет мерчанту или агрегатору оперативно реагировать на сообщения арбитра, загружать прикрепленные файлы (через GET /merchant/Appeals/DownloadFile) или отправлять ответные сообщения (через POST /merchant/Appeals/SendChatMessage).
Дополнительные действия
- Отправка сообщений в чат: Используйте POST /merchant/Appeals/SendChatMessage для общения в чате апелляции.
- Пометка как прочитано: Используйте POST /merchant/Appeals/MarkAsRead для отметки апелляции как прочитанной.
- Скачивание файлов: Используйте GET /merchant/Appeals/DownloadFile для получения прикрепленных файлов.
- Удаление файлов: Используйте POST /merchant/Appeals/RemoveFileAppointment для удаления загруженных файлов.
...