Отклонить списание
const url = 'https://api-admin.billz.ai/v2/write-off/cancel/example?Billz-Response-Channel=HTTP';const options = { method: 'PUT', headers: { 'platform-id': '7d4a4c38-dd84-4902-b744-0488b80a4c01', 'Billz-Response-Channel': 'HTTP', Authorization: 'Bearer <token>' }};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url 'https://api-admin.billz.ai/v2/write-off/cancel/example?Billz-Response-Channel=HTTP' \ --header 'Authorization: Bearer <token>' \ --header 'Billz-Response-Channel: HTTP' \ --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'Асинхронный метод. Чтобы получить результат синхронно по HTTP, передайте заголовок Billz-Response-Channel: HTTP — иначе ответ будет 200 {"message": "<correlation_id>"}. Максимальное ожидание — 600 секунд, далее 408 с error.code = TIMEOUT.
Коды ошибок: 404 — объект не найден; 408 — таймаут ожидания асинхронного ответа; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.
Authorizations
Заголовок раздела «Authorizations»Parameters
Заголовок раздела «Parameters»Path Parameters
Заголовок раздела «Path Parameters»Берётся из пути
Header Parameters
Заголовок раздела «Header Parameters»Идентификатор платформы. Для интеграций используется статичное значение.
HTTP — дождаться результата обработки события и вернуть его в HTTP-ответе. Без заголовка метод вернёт только correlation_id опубликованного события.
Query Parameters
Заголовок раздела «Query Parameters»То же, что заголовок Billz-Response-Channel, — для клиентов, которые не могут передать свой заголовок. Если переданы оба, действует заголовок.
Responses
Заголовок раздела «Responses»Успех. С заголовком Billz-Response-Channel: HTTP — конверт асинхронного ответа, без него — {"message": "<correlation_id>"}.
Конверт асинхронного ответа. Возвращается, когда передан заголовок Billz-Response-Channel: HTTP. Итоговый HTTP-код запроса берётся из поля status_code.
object
Идентификатор сессии клиента
Статус обработки события (он же итоговый HTTP-код ответа)
object
Код ошибки, пустая строка если ошибки нет
Текст ошибки, пустая строка если ошибки нет
Идентификатор запроса, совпадает с ID опубликованного события
Тип ответного события, например <event_type>.success
Результат операции, если метод его возвращает
object
Ответ асинхронного метода без заголовка Billz-Response-Channel — событие опубликовано.
object
Correlation_id опубликованного события
object
object
Examplegenerated
{ "session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "status_code": 1, "error": { "code": "example", "message": "example" }, "correlation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "topic": "example", "data": {}}