Оплатить ККТ

Внимание

Новые ключи временно не выпускаются в связи с обновлением продукта.

Выполняет оплату ККТ с помощью купона или квоты.

Формат запроса

POST https://api.ofd.yandex.net/{v1}/cashboxes/{id}/pay
  • v1
    Номер версии API ОФД.
  • id
    Идентификатор ККТ.

Заголовок запроса

Заголовки запроса должны содержать ключи (см. раздел Доступ к API):

Заголовок Значение
X-Yandex-Key <аутентификационный ключ>
X-OFD-Key <авторизационный ключ>
Content-Type application/json

Тело запроса

{
  "coupon": {
    "code": "{string}",
    "quota": {
       "month": {integer}
    }
  }
}
  • coupon
    Способ оплаты за обслуживание ККТ. В запросе можно указать только один способ оплаты.
    • code
      Купон. Указывается код, предоставленный партнером.
    • quota
      Квота. Указывается период, оплата за который выполняется из квоты.
      • month
        Количество месяцев.

Общий формат ответа приведен ниже. В реальном ответе порядок следования элементов может отличаться, а некоторые элементы могут отсутствовать. Также в ответе могут находиться служебные параметры, которые не описаны в документе.

Формат ответа

Если запрос выполнен успешно, сервер возвращает HTTP-статус выполнения операции: «204 No Content».

В случае возникновения ошибок при обработке запроса ответ сервера содержит код и описание ошибки.

Коды ответа

Список кодов, которые поддерживаются в API ОФД см. в разделе Коды ответов и ошибки.

Пример запроса

Метод и адрес:

POST https://api.ofd.yandex.net/v1/cashboxes/915/pay

Заголовки:

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Content-Type: application/json

Тело:

{
  "coupon": {
    "code": "8814210958160400"
  }
}
Пример запроса в формате cURL
curl -X POST \
  https://api.ofd.yandex.net/v1/cashboxes/915/pay \
  -H 'Content-Type: application/json' \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -d '{
  "coupon": {
    "code": "8814210958160400"
  }
}'