Возвраты

Возвраты по заказам: сначала расчёт, затем возврат позиций и доставки; деньги уходят обратно способами оплаты, товар — на склад.

Загружаем поисковый индекс…

Возвраты

Объекты

Refund

  • idintegerобязательно

    ID записи, уникальный среди записей своего вида в магазине.

  • order_idintegerобязательно

    ID заказа.

  • pos_shift_idinteger или nullобязательно

    ID кассовой смены (/v1/pos-shifts), оформившей возврат; null — возврат не на кассе.

  • kindstringобязательно

    return — возврат товара; adjustment — корректировка суммы без товара; overpayment — возврат переплаты; tip — возврат чаевых.

    Значения:
    returnadjustmentoverpaymenttip
  • statusstringобязательно

    pending — ждёт провайдера или ручной выплаты; completed — выполнен; failed — не прошёл; reversed — отменён после выполнения.

    Значения:
    pendingcompletedfailedreversed
  • app_idinteger или nullобязательно

    Приложение, оформившее возврат (/v1/orders/{order}/refunds или отмена заказа), — его id из /v1/me; null у возврата кассы, сотрудника, покупателя или автоматики.

  • confirmablebooleanобязательно

    Возврат ждёт подтверждения, что деньги выплачены вне системы (POST /v1/refunds/{refund}/confirm).

  • currencystringобязательно

    Валюта сумм, код ISO 4217: валюта магазина.

  • amountintegerобязательно

    Сумма возврата: позиции и доставка.

  • shipping_amountintegerобязательно

    Часть amount, которая возвращает доставку.

  • tax_linesмассив object или nullобязательно

    Налог возвращённого по классификации товаров — состав кредит-ноты возврата: возвращённые позиции, кроме подарочных карт, и доставка; у возврата суммой без позиций — облагаемая часть по классу магазина по умолчанию. null — у магазина нет налоговых классов или облагаемого не вернули (подарочную карту).

    Поля · 6
    • regimestringобязательно

      Какой налог: vat — налог на добавленную стоимость (IVA); income — на прибыль; turnover — оборотный (Ingresos Brutos); municipal — муниципальный сбор; internal — акциз; social — социальные взносы; other — прочее. Налог продажи — vat: класс налога товара классифицирует НДС.

      Значения:
      vatincometurnovermunicipalinternalsocialother
    • kindstringобязательно

      taxed — по ставке; exempt — освобождено законом; untaxed — вне периметра налога. У строк exempt и untaxed rate_bps 0 и amount 0: сумма — в base.

      Значения:
      taxedexemptuntaxed
    • rate_bpsintegerобязательно

      Ставка в базисных пунктах: 2100 — это 21 %.

    • baseintegerобязательно

      База налога, без налога. Цены — с налогом: base + amount — сколько покупатель заплатил за эту часть.

    • amountintegerобязательно

      Сумма налога. Налог продажи считается по ставке для всего заказа: база к ближайшей единице, налог остатком; позиции и доставка получают доли, поэтому их строки в сумме дают строку заказа.

    • jurisdictionstring или nullобязательно

      Провинция или муниципалитет у налогов, которым они нужны (turnover, municipal); иначе null.

  • exchanged_to_order_idinteger или nullобязательно

    Заказ, выданный взамен (обмен); null у обычного возврата.

  • itemsмассив objectобязательно

    Возвращённые позиции.

    Поля · 4
    • order_item_idintegerобязательно

      ID позиции заказа (items в /v1/orders).

    • quantitystringобязательно

      Количество десятичной строкой в unit: штуки или вся мера весовой или объёмной позиции.

    • unitstring или nullобязательно

      Единица quantity: pcs, g или ml; null, если вариант больше не знает единицу своей меры.

      Значения:
      pcsgmlnull
    • amountintegerобязательно

      Сумма, возвращённая за позицию.

  • transactionsмассив objectобязательно

    Куда ушли деньги: проводки по платежам заказа.

    Поля · 7
    • idintegerобязательно

      ID проводки.

    • payment_idinteger или nullобязательно

      Платёж заказа, по которому возвращаются деньги; null, если такого платежа нет, например при возврате на баланс.

    • methodstringобязательно

      Способ оплаты проводки, те же значения, что у method платежа.

      Значения:
      cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_package
    • targetstringобязательно

      Куда уходят деньги: card — обратно на карту через провайдера; cash — наличными; balance — на баланс покупателя; gift_card — на подарочную карту; account — в счёт долга покупателя; manual — выплачено вручную вне системы; exchange — в заказ обмена; subscription — в подписку; deposit — в депозит.

      Значения:
      cardcashbalancegift_cardaccountmanualexchangesubscriptiondepositservice_package
    • amountintegerобязательно

      Сумма проводки.

    • statusstringобязательно

      pending, completed, failed или reversed — как status возврата.

      Значения:
      pendingcompletedfailedreversed
    • provider_refund_idstring или nullобязательно

      ID возврата у платёжного провайдера — для сверки с его выпиской; null, если провайдера нет.

  • created_atstring (date-time)обязательно

    Когда запись создана.

  • updated_atstring (date-time)обязательно

    Когда запись менялась последний раз.

RefundCalculation

  • order_idintegerобязательно

    ID заказа.

  • currencystringобязательно

    Валюта сумм, код ISO 4217: валюта магазина.

  • amountintegerобязательно

    Сумма, которая вернётся за выбранные позиции и доставку.

  • shipping_amountintegerобязательно

    Часть amount, которая возвращает доставку.

  • itemsмассив objectобязательно

    Позиции, которые будут возвращены.

    Поля · 4
    • order_item_idintegerобязательно

      ID позиции заказа (items в /v1/orders).

    • quantitystringобязательно

      Количество десятичной строкой в unit: штуки или вся мера весовой или объёмной позиции.

    • unitstring или nullобязательно

      Единица quantity: pcs, g или ml; null, если вариант больше не знает единицу своей меры.

      Значения:
      pcsgmlnull
    • amountintegerобязательно

      Сумма, возвращённая за позицию.

  • transactionsмассив objectобязательно

    Куда уйдут деньги: доли по платежам заказа — ровно так, как их проведёт возврат.

    Поля · 4
    • payment_idinteger или nullобязательно

      Платёж заказа, по которому возвращаются деньги; null, если такого платежа нет, например при возврате на баланс.

    • methodstring или nullобязательно

      Способ оплаты доли; null у доли без платежа.

      Значения:
      cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_packagenull
    • targetstringобязательно

      Куда уходят деньги: card — обратно на карту через провайдера; cash — наличными; balance — на баланс покупателя; gift_card — на подарочную карту; account — в счёт долга покупателя; manual — выплачено вручную вне системы; exchange — в заказ обмена; subscription — в подписку; deposit — в депозит.

      Значения:
      cardcashbalancegift_cardaccountmanualexchangesubscriptiondepositservice_package
    • amountintegerобязательно

      Сумма проводки.

  • balance_availablebooleanобязательно

    Долю необратимого способа (перевод, крипта, ручной способ) можно вернуть на баланс покупателя — irreversible_to: balance в возврате: такая доля в расчёте есть, у покупателя есть аккаунт, и магазин работает с балансами.

  • refundableobjectобязательно

    Что по заказу ещё можно вернуть: позиции с невозвращённым количеством и остаток доставки. Отменённый возврат его не уменьшает.

    Поля · 2
    • itemsмассив objectобязательно

      Позиции, по которым ещё есть что вернуть.

      Поля · 3
      • order_item_idintegerобязательно

        ID позиции заказа (items в /v1/orders).

      • quantitystringобязательно

        Сколько ещё можно вернуть, десятичной строкой в unit.

      • unitstring или nullобязательно

        Единица quantity: pcs, g или ml; null, если вариант больше не знает единицу своей меры.

        Значения:
        pcsgmlnull
    • shipping_amountintegerобязательно

      Сколько доставки ещё можно вернуть.

Методы

Возвраты по заказам, изменённые с указанного момента: позиции и проводки по платежам

get/refunds

Scope: refunds:read

Параметры

Строка запроса

  • limitinteger

    Размер страницы: до 250 записей; по умолчанию 50.

    Минимум:
    1
    Максимум:
    250
  • cursorstring

    Непрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.

    Макс. длина:
    4096
  • updated_sincestring (date-time)

    Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.

    Шаблон:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • include_deletedboolean

    true — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.

  • order_idinteger

    Только записи этого заказа.

    Минимум:
    1
  • pos_shift_idinteger

    Только записи, принятые этой кассовой сменой.

    Минимум:
    1

Ответы

200Успешно

application/json

  • dataмассив Refundобязательно

    Записи страницы.

  • deletedмассив objectобязательно

    Записи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.

    Поля · 2
    • idintegerобязательно

      ID стёртой записи.

    • deleted_atstring (date-time)обязательно

      Когда запись стёрта.

  • next_cursorstring или nullобязательно

    Курсор следующей страницы; null на последней.

  • has_morebooleanобязательно

    true, если есть следующая страница.

  • sync_cursorstring или nullобязательно

    На последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/refunds" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "order_id": 0,
      "pos_shift_id": 0,
      "kind": "return",
      "status": "pending",
      "app_id": 0,
      "confirmable": true,
      "currency": "string",
      "amount": 0,
      "shipping_amount": 0,
      "tax_lines": [
        {
          "regime": "vat",
          "kind": "taxed",
          "rate_bps": 0,
          "base": 0,
          "amount": 0,
          "jurisdiction": "string"
        }
      ],
      "exchanged_to_order_id": 0,
      "items": [
        {
          "order_item_id": 0,
          "quantity": "string",
          "unit": "pcs",
          "amount": 0
        }
      ],
      "transactions": [
        {
          "id": 0,
          "payment_id": 0,
          "method": "cash",
          "target": "card",
          "amount": 0,
          "status": "pending",
          "provider_refund_id": "string"
        }
      ],
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}

Возврат по заказу

get/refunds/{refund}

Scope: refunds:read

Параметры

Путь

  • refundintegerобязательно

    ID возврата.

Ответы

200Успешно

application/json

Возвращает Refund

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/refunds/{refund}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "order_id": 0,
  "pos_shift_id": 0,
  "kind": "return",
  "status": "pending",
  "app_id": 0,
  "confirmable": true,
  "currency": "string",
  "amount": 0,
  "shipping_amount": 0,
  "tax_lines": [
    {
      "regime": "vat",
      "kind": "taxed",
      "rate_bps": 0,
      "base": 0,
      "amount": 0,
      "jurisdiction": "string"
    }
  ],
  "exchanged_to_order_id": 0,
  "items": [
    {
      "order_item_id": 0,
      "quantity": "string",
      "unit": "pcs",
      "amount": 0
    }
  ],
  "transactions": [
    {
      "id": 0,
      "payment_id": 0,
      "method": "cash",
      "target": "card",
      "amount": 0,
      "status": "pending",
      "provider_refund_id": "string"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Рассчитать возврат по заказу и остаток к возврату — ничего не пишет

post/orders/{order}/refunds/calculate

Scope: refunds:write

Параметры

Путь

  • orderintegerобязательно

    ID заказа.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Тело запроса application/json

  • itemsмассив objectобязательно

    Возвращённые позиции.

    Макс. элементов:
    200
    Без повторов
    Поля · 2
    • order_item_idintegerобязательно

      ID позиции заказа (items в /v1/orders).

      Минимум:
      1
    • quantitystringобязательно

      Количество десятичной строкой в unit: штуки или вся мера весовой или объёмной позиции.

      Макс. длина:
      32
  • shipping_amountinteger

    Часть amount, которая возвращает доставку.

    Минимум:
    0
    Максимум:
    100000000000000
  • irreversible_tostring

    Куда идёт доля необратимого способа (перевод, крипта, ручной способ): manual — магазин выплачивает её вручную и подтверждает (POST /v1/refunds/{refund}/confirm); balance — на баланс покупателя (balance_available расчёта).

    Значения:
    manualbalance

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true

application/json

Возвращает RefundCalculation

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/orders/{order}/refunds/calculate" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "items": [
    {
      "order_item_id": 1,
      "quantity": "string"
    }
  ],
  "shipping_amount": 0,
  "irreversible_to": "manual"
}
Пример ответа · 200
{
  "order_id": 0,
  "currency": "string",
  "amount": 0,
  "shipping_amount": 0,
  "items": [
    {
      "order_item_id": 0,
      "quantity": "string",
      "unit": "pcs",
      "amount": 0
    }
  ],
  "transactions": [
    {
      "payment_id": 0,
      "method": "cash",
      "target": "card",
      "amount": 0
    }
  ],
  "balance_available": true,
  "refundable": {
    "items": [
      {
        "order_item_id": 0,
        "quantity": "string",
        "unit": "pcs"
      }
    ],
    "shipping_amount": 0
  }
}

Вернуть позиции и доставку заказа: деньги — по способам оплаты, товар — на склад

post/orders/{order}/refunds

Scope: refunds:write

Параметры

Путь

  • orderintegerобязательно

    ID заказа.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Тело запроса application/json

  • itemsмассив objectобязательно

    Возвращённые позиции.

    Макс. элементов:
    200
    Без повторов
    Поля · 2
    • order_item_idintegerобязательно

      ID позиции заказа (items в /v1/orders).

      Минимум:
      1
    • quantitystringобязательно

      Количество десятичной строкой в unit: штуки или вся мера весовой или объёмной позиции.

      Макс. длина:
      32
  • shipping_amountinteger

    Часть amount, которая возвращает доставку.

    Минимум:
    0
    Максимум:
    100000000000000
  • irreversible_tostring

    Куда идёт доля необратимого способа (перевод, крипта, ручной способ): manual — магазин выплачивает её вручную и подтверждает (POST /v1/refunds/{refund}/confirm); balance — на баланс покупателя (balance_available расчёта).

    Значения:
    manualbalance
  • expected_amountintegerобязательно

    Сумма из расчёта (/v1/orders/{order}/refunds/calculate), которую вы подтверждаете. Разнесённая скидка, прошлые возвраты или правка заказа меняют её после чтения; возврат на другую сумму не исполняется.

    Минимум:
    0
    Максимум:
    100000000000000

Ответы

201Создано

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true

application/json

Возвращает Refund

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/orders/{order}/refunds" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "items": [
    {
      "order_item_id": 1,
      "quantity": "string"
    }
  ],
  "shipping_amount": 0,
  "irreversible_to": "manual",
  "expected_amount": 0
}
Пример ответа · 201
{
  "id": 0,
  "order_id": 0,
  "pos_shift_id": 0,
  "kind": "return",
  "status": "pending",
  "app_id": 0,
  "confirmable": true,
  "currency": "string",
  "amount": 0,
  "shipping_amount": 0,
  "tax_lines": [
    {
      "regime": "vat",
      "kind": "taxed",
      "rate_bps": 0,
      "base": 0,
      "amount": 0,
      "jurisdiction": "string"
    }
  ],
  "exchanged_to_order_id": 0,
  "items": [
    {
      "order_item_id": 0,
      "quantity": "string",
      "unit": "pcs",
      "amount": 0
    }
  ],
  "transactions": [
    {
      "id": 0,
      "payment_id": 0,
      "method": "cash",
      "target": "card",
      "amount": 0,
      "status": "pending",
      "provider_refund_id": "string"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Подтвердить, что деньги возврата отданы вне системы

post/refunds/{refund}/confirm

Scope: refunds:write

Параметры

Путь

  • refundintegerобязательно

    ID возврата.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true

application/json

Возвращает Refund

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/refunds/{refund}/confirm" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "order_id": 0,
  "pos_shift_id": 0,
  "kind": "return",
  "status": "pending",
  "app_id": 0,
  "confirmable": true,
  "currency": "string",
  "amount": 0,
  "shipping_amount": 0,
  "tax_lines": [
    {
      "regime": "vat",
      "kind": "taxed",
      "rate_bps": 0,
      "base": 0,
      "amount": 0,
      "jurisdiction": "string"
    }
  ],
  "exchanged_to_order_id": 0,
  "items": [
    {
      "order_item_id": 0,
      "quantity": "string",
      "unit": "pcs",
      "amount": 0
    }
  ],
  "transactions": [
    {
      "id": 0,
      "payment_id": 0,
      "method": "cash",
      "target": "card",
      "amount": 0,
      "status": "pending",
      "provider_refund_id": "string"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}