ym88659208ym87991671
Получение данных по счету | Документация для разработчиков

Получение данных по счету

Обновлено 4 марта 2025
GET
/invoices/{invoice_id}

Получите данные по invoice_id. Возможен поиск счета по паре service_id+order_id, если invoice_id неизвестен. Для этого нужно указать invoice_id = 0, а в запросе — service_id и order_id.

Запрос

Path Parameters

    invoice_id
    string
    required

    ID счета

Query Parameters

    service_id
    string

    ID сервиса для поиска. Обычно используется в паре с параметром order_id

    order_id
    string

    Идентификатор заказа, переданный при создании счета

    inv_status
    string

    Статус счета для начала отслеживания изменений.

    Если при вызове запроса счет найден, статус равен значению этого параметра, то ответ отдается только при смене статуса или по таймауту. Используется в "long polling" запросах для отслеживания факта проведения оплаты

    wait
    integer

    Время в секундах, которое источник запроса будет ожидать до смены статуса счета. Используется в "long polling" запросах для отслеживания факта проведения оплаты.

    device_platform_type
    string

    Наименование операционной системы устройства

    Example: iOS
    device_platform_version
    string

    Версия операционной системы устройства

    Example: 13.6.1
    device_model
    string

    Модель устройства

    Example: iPhone 7
    device_manufacturer
    string

    Производитель устройства

    Example: Apple
    device_id
    string

    Серийный номер устройства

    Example: 83c3f257-46d8-41fe-951b-f79d04e288c2
    surface
    string

    Поверхность

    Example: SBOL
    surface_version
    string

    Версия ПО

    Example: 11.5.0

Ответы

Данные по счету, а также варианты оплаты, в зависимости от статуса

Schema

    error

    object

    user_message
    string

    Сообщение для пользователя

    error_description
    string

    Техническое описание ошибки

    error_code
    string

    Код ответа

    invoice_id
    string
    required

    Идентификатор счета

    invoice_date
    string

    Дата создания счета

    invoice_status
    string

    Статус счета.

    Возможные значения — в разделе Статусы счета

    invoice

    object

    Информация о счете

    purchaser

    object

    Информация о покупателе

    email
    string

    Электронный адрес клиента

    phone
    string

    Номер телефона клиента

    contact
    string

    Способ связи с клиентом

    delivery_info

    object

    Информация о доставке

    address

    object

    Адрес

    country
    string

    Страна

    city
    string

    Город

    address
    string

    Адрес

    delivery_type
    string

    Тип доставки

    description
    string

    Дополнительная информация о доставке

    invoice_params

    object[]

    Дополнительные параметры, уточняющие товарную позицию

  • Array [

    • key
    string
    required

    Название параметра

    value
    string
    required

    Значение параметра

  • ]

    • order

    object

    required

    order_id
    string

    Идентификатор заказа.

    Должен быть уникален в рамках выделенного для приложения service_id, иначе не будет создан новый invoice_id

    order_number
    string

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

    Рекомендуется сделать его максимально понятным и простым для восприятия

    order_date
    date-time

    Дата и время заказа в формате RFC 3339

    service_id
    string

    Идентификатор сервиса, полученный при выдаче токена для авторизации запроса

    amount
    integer
    required

    Сумма счета без разделителя, в копейках. Например, 1 рубль передается в этом поле как 100.

    Если в запросе указывается корзина товаров, то это поле должно быть равно сумме стоимости всех товаров в корзине sum(order_bundle.item_amount).

    currency
    string
    required

    Код валюты в формате ISO 4217.

    Поддерживается только значение RUB

    purpose
    string

    Краткое назначение платежа.

    Отображается при оплате/подтверждении безакцептного списания клиентом

    description
    string

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

    language
    string

    Язык текстовых полей в формате BCP 47.

    Поддерживается только значение ru-RU

    expiration_date
    date-time

    Дата и время истечения срока оплаты в формате RFC 3339.

    По умолчанию на оплату отводится 20 минут от момента регистрации платежа. Поле передается, если нужно изменить это время

    tax_system
    integer

    Система налогообложения:

    • 0 — общая;
    • 1 — упрощенная, доход;
    • 2 — упрощенная, доход минус расход;
    • 3 — единый налог на вмененный доход;
    • 4 — единый сельскохозяйственный налог;
    • 5 — патентная система налогообложения.
    trade_name
    string

    Торговое наименование организации

    visual_name
    string

    Наименование операции для отображения

    org_name
    string

    Наименование организации

    org_inn
    string

    ИНН организации

    visual_amount
    string

    Сумма для отображения

    order_bundle

    object[]

    Описание корзины покупок для передачи в налоговую и формирования фискального чека.

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

    Обязательно нужно указывать в счетах на оплату, иначе оплата не состоится

  • Array [

    • position_id
    integer
    required

    Номер позиции в корзине для добавления в фискальный чек.

    Должен быть уникален в рамках заказа

    name
    string
    required

    Наименование или описание товарной позиции

    item_params

    object[]

    Дополнительные параметры, уточняющие товарную позицию

  • Array [

    • key
    string
    required

    Название параметра

    value
    string
    required

    Значение параметра

  • ]

    • quantity

    object

    Описание количественных характеристик определенной позиции корзины

    value
    number
    required

    Количество товара в позиции.

    Для разделителя используйте точку. Не более 3 знаков после запятой

    measure
    string
    required

    Единица измерения товара в позиции

    item_amount
    integer

    Сумма стоимости всех товарных позиций одного positionId, в копейках

    currency
    string

    Код валюты в формате ISO 4217.

    Поддерживается только значение RUB

    item_code
    string

    Номер (идентификатор) товарной позиции в системе магазина.

    Параметр должен быть уникальным в рамках запроса

    item_price
    integer

    Стоимость одного товара в позиции без разделителя, в копейках

    discount_type
    string

    Тип скидки на товарную позицию

    discount_value
    number

    Значение скидки на товарную позицию.

    Используется для формирования фискального чека, сумму рассчитывает разработчик

    interest_type
    string

    Тип агентской комиссии за продажу товара.

    Применимо только для агентской схемы

    interest_value
    number

    Значение агентской комиссии за продажу товара.

    Применимо только для агентской схемы

    tax_type
    integer

    Ставка НДС:

    • 0 — без НДС;
    • 1 — НДС по ставке 0%
    • 2 — НДС чека по ставке 10%
    • 3 — НДС чека по ставке 18%
    • 4 — НДС чека по расчетной ставке 10/110;
    • 5 — НДС чека по расчетной ставке 18/118;
    • 6 — НДС чека по ставке 20%
    • 7 — НДС чека по расчетной ставке 20/120.

    Значение «НДС по ставке 0%» отличается от варианта «без НДС» только формированием чека в зависимости от системы налогообложения. По сумме налога разницы нет

    tax_sum
    integer

    Сумма налога, высчитанная продавцом, без разделителя, в копейках

    image
    url

    Ссылка на картинку

  • ]

    • image
    url

    Ссылка на картинку

    payment_info

    object

    Данные банковской карты (связки)

    payment_date
    date-time

    Дата и время оплаты счета в формате RFC 3339

    payment_id
    payment_id (string)

    Идентификатор платежа

    payment_params

    object

    Дополнительный параметр

    key
    string
    required

    Название параметра

    value
    string
    required

    Значение параметра

    device_info

    object

    Информация об устройстве

    device_platform_type
    string

    Наименование операционной системы устройства

    device_platform_version
    string

    Версия операционной системы устройства

    device_model
    string

    Модель устройства

    device_manufacturer
    string

    Производитель устройства

    device_id
    string

    Серийный номер устройства

    surface
    string

    Поверхность

    surface_version
    string

    Версия ПО

    loyalty_info

    object

    Информация по бонусам после оплаты

    service_code
    string
    required

    Код бонусной программы

    service_name
    string
    required

    Наименование бонусной программы

    change_rate
    number
    required

    Коэффициент обмена баллов на рубли.

    Например, 100 баллов / 1.25 (коэффициент) = 80 руб. Будет списано 100 баллов, сумма платежа уменьшена на 80 руб.

    payment_bonus
    integer

    Сумма бонусных баллов, использованных при оплате счета.

    Указывается в копейках. Например, 123 балла 50 копеек = 12350

    award_bonus
    integer

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

    Указывается в копейках. Например, 123 балла 50 копеек = 12350

    image
    url

    Ссылка на картинку

    card_id
    string
    required

    ID карты

    name
    string

    Алиас карты, указанный клиентом

    paysys_code
    string

    Код платежного оператора

    masked_pan
    string

    Маскированный номер карты

    expiry_date
    string

    Срок истечения действия карты в формате YYYYMM

    cardholder
    string

    Имя держателя карты, указанное при оплате

    payment_system
    string

    Наименование платежной системы

    payment_system_image
    url

    Логотип платежной системы

    image
    url

    Логотип карты

    paysys
    string

    Наименование платежного оператора

    paysys_image
    url

    Логотип платежного оператора

    payment_way
    string

    Наименование способа оплаты

    payment_way_code
    string

    Код способа оплаты

    payment_way_logo
    url

    Логотип способа оплаты

    bank_info

    object

    Данные банка-эмитента

    bank_name
    string

    Наименование банка-эмитента

    bank_country_code
    string

    Код страны банка-эмитента.

    bank_country_name
    string

    Наименование страны банка-эмитента

    bank_image
    string

    Ссылка на логотип банка

    payment_methods

    object

    Платежные инструменты

    user_message
    string

    Сообщение пользователю (необязательное)

    methods

    object[]

  • Array [

    • method
    string

    Возможные значения: [new, card, QR, app2sbol, invoice, applestore, googleplay, applepay, googlepay]

    Код метода оплаты

    action
    string

    Название кнопки оплаты

  • ]

Loading...
Loading...
Это полезный материал?
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей. Вы можете запретить сохранение cookie в настройках своего браузера.