API платёжного шлюза Сбербанка (1.1.6)

Download OpenAPI specification:Download

Switch to English

Настоящий документ описывает программные интерфейсы платёжного шлюза Сбербанка, который позволяет проводить платежи в интернет-эквайринге.

По вопросам работы с API необходимо обращаться в Службу Поддержки (email: Support_ecomm@sberbank.ru). При обращении желательно указывать, что вопрос по целевому шлюзу интернет-эквайринга.

По вопросам получения доступов, операционой деятельности и прочим вопросам обслуживания необходимо обращаться к вашему менеджеру.

История изменений

Дата Версия документа Описание изменений
16.01.2026 1.1.6 Добавлено описание оплаты Цифровым рублем
02.10.2025 1.1.5 Важное изменение! Обновлены координаты подключения к боевой среде в разделе Обработка сообщений. Добавлены ограничения на повторные запросы по ряду ошибок в разделе Описание кодов ответа Процессинга
08.08.2025 1.1.4 Добавлен сервис формирования чеков коррекции [doCorrection]. Добавлены параметры для фискальных тегов 1011 (часовой пояс) и 2003 (планируемое изменение статуса товара)
25.07.2025 1.1.3 Скорректирована структура в описании ошибок. Добавлен параметр для работы с динамическими callback-уведомлениями
13.03.2025 1.1.2 Уточнена методика округления при расчёте бонусов СберСпасибо при осуществлении возвратов. Добавлены тестовые карты для тестирования функционала СберСпасибо
02.11.2024 1.1.1 Добавлено описание сервисов проведения переводов
17.10.2024 1.1.0 Добавлена поддержка спецификации на двух языках
17.09.2024 1.0.9 Добавлено описание по оплате электронными сертификатами
10.09.2024 1.0.8 Уточнено описание объекта loyaltyInfo.awardBonus
28.05.2024 1.0.7 Добавлена информация по работе с программой лояльности СберСпасибо
15.03.2024 1.0.6 Добавлена информация по сервисам смены пароля, POS-кредитования
15.12.2023 1.0.5 Добавлена информация по повышению конверсии платежей
03.10.2023 1.0.4 Добавлена документация по фискализации, СБП. Добавлено видео по работе в личном кабинете.
18.07.2023 1.0.3 Добавлена документация по работе со связками
18.07.2023 1.0.2 Добавлена документация по тестированию SberPay, внесены коррективы в описание сервисов. Добавлены тестовые карты
14.06.2023 1.0.1 Добавлено описание регистрации QR-ссылок. Добавлены примеры запросов и ответов для различных бизнес-сценариев
21.05.2023 1.0.0 Начальная версия openAPI

Общая информация

Термины

  • Платёжный шлюз (ПШ, Шлюз) — комплекс решений для осуществления процесса интернет-эквайринга с использованием различных платёжных средств.
  • Партнер — система или лицо, которое взаимодействует с ПШ.
  • Плательщик — физическое или юридическое лицо, совершающее платёж по своей карте за услуги мерчанта в ПШ.
  • Заказ — элементарная сущность ПШ, описывающее заказ в некотором интернет-магазине или его аналоге.
  • Одностадийный платёж — операция по оплате товаров/услуг, не требующая дополнительного подтверждения (Завершения), то есть блокирование и списание средств происходит в один этап. Этот вид платежей предпочтительней, если товар или услуга предоставляется сразу после оплаты.
  • Двухстадийный платёж — операция по оплате товаров/услуг, требующая дополнительного подтверждения (Завершения), то есть оплата производится в два этапа. На первом этапе происходит проверка наличия и блокирование средств плательщика (предавторизация); далее, на втором этапе, компания либо подтверждает необходимость списания средств, либо отменяет блокировку средств. Сумма списания может отличаться от суммы блокировки в меньшую сторону.
  • Универсальная Платежная Ссылка - Платежная ссылка предназначенная для оплаты Цифровым Рублем (ЦР). Использование ЦР доступно при соблюдении следующих условий:
    • Открыт счет в ЦР через Сбербанк / получен доступ к счету через Сбербанк;
    • Подписан договор по СБП;
    • Подписано доп/соглашение к договору СБП об использовании УПК (Универсального платежного кода) для приема оплат цифровым рублем;
    • Выполнено подключение к ecom АПИ Сбербанка.
  • Холдирование (Блокировка средств) - Состояние суммы средств, предназначенных для возмещения по проведенной операции, с момента успешной авторизации до момента завершения расчетов между банками-участниками. На данном этапе средства еще находятся на счете Плательщика, но уже недоступны для использования на карте.
  • Возврат средств (Refund) — частичный или полный возврат денежных средств Плательщика в случае его отказа от получения товара/услуг или его возврата. Возврат — это офлайн-операция, которая производится после списания денежных средств с Плательщика. Сроки возмещения, как правило, зависят от банка-эмитента и могут достигать 30 дней.
  • Отмена операции оплаты (Reversal) — операция снятия (отмены) удержания денежных средств Плательщика. Отмена — это онлайн-операция, то есть эмитент карты сразу получает запрос на разблокировку суммы. Отмена может быть произведена до начала взаиморасчётов банков-участников, поэтому доступна ограниченное время.
  • Связка — соответствие между Плательщиком и платёжными реквизитами карты (номер карты или токена и срок его действия).
  • 3-D Secure (3DS) — протокол дополнительной аутентификации Плательщика, основанный на концепции трёх доменов: эквайрера, эмитента и совместимости.
  • Access Control Server (ACS) — элемент инфраструктуры 3-D Secure, обеспечивающий аутентификацию Плательщика на стороне банка-эмитента.
  • MPI, 3DS Server — элемент инфраструктуры 3-D Secure на стороне банка-эквайрера или Партнера.
  • Фискализация (54-ФЗ) - процедура формирования фискального чека по успешно оплаченному Заказу. В данное понятие входит как формирование чека по успешной оплате, так и формирование чека возврата, закрывающего чека и т.д.
  • ФФД - Формат Фискальных Документов. Стандарт Федеральной Налоговой Службы, согласно которому формируются все фискальные чеки.
  • Электронный сертификат (ЭС) — запись в Государственной информационной системе электронных сертификатов (ГИС ЭС). Держатель ЭС получает доступ к этой записи с помощью национального платежного инструмента, в качестве которого выступает карта ПС «Мир».
  • ТРУ — Товар/работа/услуга
  • НСПК — Национальная система платёжных карт
  • ФЭС — Фронт-офис Электронных Сертификатов НСПК – решение для торгово-сервисного предприятия для реализации возможности приобретения отдельных видов товаров, работ, услуг с использованием средств ЭС

Обработка сообщений

  • Координаты подключения. Информация о координатах подключения к тестовой среде также доступна в индивидуальном разделе для каждого сервиса (в правой части страницы).

Внимание! Для корректного взаимодействия со шлюзом необходимо установить сертификат НУЦ Минцифры.

Внимание! На тестовом контуре предусмотрены технические окна: в будние дни зарезервированы временные интервалы 02:00 - 06:00, 09:00 - 10:00 и 18:00 - 20:00 (время Московское) в течение которых могут осуществляться работы по внедрению функционала на тестовый стенд. Стабильность работоспособности контура в это время не гарантируется.

Тестовая среда: https://ecomtest.sberbank.ru/...(полная ссылка для конкретного сервиса указана в примерах)

Боевая среда: https://epay.sberbank.ru/...(полная ссылка для конкретного сервиса указана в примерах)

  • Платёжный шлюз представляет HTTP REST сервисы методом POST, с передачей в заголовках "Content-Type: application/json" и набором символов в кодировке UTF-8. Сообщения передаются в формате JSON (RFC 7159);
  • Наименования объектов в сервисах передаются с учетом регистра;
  • При взаимодействии используется протокол TLS версии 1.2 и 1.3;
  • После регистрации Партнера, предоставляются логин и пароль, который необходимо использовать при подключении к ПШ;
  • Для взаимодействия с сервисами ПШ требуется установить сертификат НУЦ Минцифры.

Внимание! Не допускается присвоение значения "null" параметрам! Если параметр принимает значение "null", его необходимо полностью исключить из тела запроса.

Сценарии проведения платежей

В зависимости от целей и потребностей Партнер может использовать сценарии, предоставленные в текущем разделе, для проведения платежей следующих типов:

  • Одностадийный платеж - операция, не требующая отдельного запроса на проведение расчетов: эта процедура осуществляется автоматически в конце текущего дня (~23:59 МСК)
  • Двухстадийный платеж - операция с предавторизацией. Проходит в два этапа: на первом этапе осуществляется предавторизация (PreAuth) в результате чего на карте Плательщика происходит Холдирование средств. На втором этапе Партнер инициирует проведение расчетов на сумму не более суммы Холдирования.

При использовании сценария с Предавторизацией рекомендуется инициировать проведение расчетов в течение 7 календарных дней.

Ввод реквизитов на стороне Партнера без 3DS на стороне Шлюза

Ввод реквизитов на стороне Партнера c 3DS на стороне Шлюза

Ввод реквизитов на стороне Партнера с упрощённым 3DS на стороне Шлюза

Ввод реквизитов на стороне Шлюза

Оплата с использованием связок

Общий алгоритм проведения оплаты по связке.

Сценарий разбит на два этапа:

1. Создание связки.

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

1.1. После получения согласия со стороны Плательщика на дальнейшее использование данных карты для проведения оплат, Партнер регистрирует заказ с помощью register.do (с обязательной передачей параметра clientId.

Внимание! В случае отсутствия указанного параметра (clientId) в запросе - связка не будет создана. В запросе так же может быть передан features=VERIFY. В этом случае сумма заказа должна составлять 0 рублей 0 копеек, средства с Плательщика не списываются. При этом сохраняется проведение всех необходимых проверок. Данный способ регистрации заказа является наиболее корректным для формирования связок.

1.2. Плательщик оплачивает заказ со всеми аттрибутами: вводом карточных данных и 3DS или оплатой операции через SberPay.

1.3. При успешной оплате заказа будет создана связка, идентификатор которой можно будет получить с помощью запросов getOrderStatusExtended.do и/или getBindings.do.

1.4. Опциональный шаг. При необходимости возврата средств по заказу (при авторизации на сумму, отличную от 0 рублей 0 копеек) может быть направлен запрос reverse.do. Отмена требуется для предотвращения фактического списания средств в случае использования технической операции для привязки карты.

Создание связки завершено.

2. Оплата с использованием связки

Ниже приведено краткое описание алгоритма проведения оплаты с использованием имеющейся связки.

Доступно несколько путей оплаты, инициатором которой может выступать как Плательщик, так и Партнер.

  1. Инициатором выступает Партнер.

Способ 1.

1.1.1. Партнер отправляет запрос recurrentPayment.do.

1.1.2. Платежный шлюз обогащает запрос данными карты, соответствующими полученному от Партнера bindingId.

1.1.3. Проводится авторизация с использованием данных карт, заполненных в п. 1.1.2.

1.1.4. Партнеру направляется результат авторизации.

Способ 2.

1.2.1. Партнер регистрирует заказ с помощью register.do / registerPreAuth.do с обязательной передачей параметра clientId.

1.2.2. Инициируется оплата заказа с помощью paymentOrderBinding.do с передачей параметра bindingId.

Внимание! Параметр bindingId должен соответствовать переданному при регистрации заказа clientId. В случае попытки оплаты связкой, созданной для другого clientId вернется ошибка "Заказ не может быть оплачен данной связкой"

1.2.3. Платежный шлюз проверяет соответствие clientId и bindingId. При корректном результате проверки Платежный шлюз обогащает запрос данными карты, соответствующими переданному значению bindingId.

1.2.4. Проводится авторизация с использованием данных карт, заполненных в п. 1.2.3.

1.2.5. Партнеру направляется результат авторизации.

  1. Инициатором выступает Плательщик.

2.1. Плательщик выбирает оплату сохраненной картой.

2.2. Партнер регистрирует заказ с помощью register.do / registerPreAuth.do с обязательной передачей параметра clientId.

2.3. Инициируется оплата заказа с помощью paymentOrderBinding.do с передачей параметра bindingId.

Внимание! Параметр bindingId должен соответствовать переданному при регистрации заказа clientId. В случае попытки оплаты связкой, созданной для другого clientId вернется ошибка "Заказ не может быть оплачен данной связкой"

2.4. Платежный шлюз проверяет соответствие clientId и bindingId. При корректном результате проверки Платежный шлюз обогащает запрос данными карты, соответствующими переданному значению bindingId.

2.5. Проводится авторизация с использованием данных карт, заполненных в п. 1.2.3.

2.6. Партнеру направляется результат авторизации.

2.7. Партнер оповещает Плательщика о результате авторизации.

Внимание! При несоответствии clientId и bindingId Партнеру возвращается ошибка "Заказ не может быть оплачен данной связкой".

Повышение конверсии платежей

В сфере электронной коммерции конверсия является одним из важнейших показателей. При корректной интеграции и интуитивном клиентском пути одним из основных способов улучшения показателей является передача дополнительных параметров.

Дополнительные параметры позволяют получить более полную информацию о клиентах и их платежных операциях, позволяя весомо снизить риски мошенничества и исключить избыточные блокировки операций со стороны Банка, НСПК и иных эмитентов. Передача дополнительных параметров доступна при регистрации заказа и в сервисах оплаты в блоках jsonParams или additionalParameters в соответствии с описанием сервиса в документации.

Передача корзины и идентификатора аккаунта плательщика партнера являются наиболее весомыми факторами, позволяющими повысить конверсию. Передача корзины заказа может использоваться без функционала фискализации.

Дополнительные параметры могут пересекаться с параметрами 3DS и в большинстве случаев влияют на результат аутентификации плательщика, повышая вероятность работы по frictionless flow.

Состояния заказа в Шлюзе

Описание кодов ошибок Шлюза на этапе валидации запросов

Ошибки данного блока возвращаются на этапе валидации запроса к Шлюзу

errorCode errorMessage
0 Обработка запроса прошла без системных ошибок
5 Доступ запрещен
5 Error, value of the request parameter
7 System error

Описание кодов ошибок Шлюза при успешной валидации запросов

Ошибки данного блока возвращаются на этапе обработки вызываемого сервиса

errorCode errorMessage
0 Обработка запроса прошла без системных ошибок
0 Запрос принят в обработку
1 Заказ с таким номером уже обработан
1 Заказ не может быть оплачен данной связкой
1 Неверный номер карты
1 Срок действия карты неверен
1 Создание связок по данной карте недоступно
1 Связка не найдена
2 Связка неактивна
2 Связка уже создана
2 Неверное состояние связки
3 Неизвестная (запрещенная) валюта
4 В запросе не передан обязательный параметр или передан некорректный обязательный параметр
4 Username не соответствует значению при регистрации заказа
4 Номер заказа не может быть пуст
5 Неверный параметр операции
5 Доступ запрещен
5 Операция запрещена
5 Мерчант не найден в системе
5 Терминал не найден в системе
5 Заказ не найден
5 Срок жизни заказа истек
5 Неверная сумма
5 Нельзя провести частичную отмену более одного раза
5 Сумма завершения превышает сумму холдирования
5 Общая сумма возвратов превышает сумму заказа
5 Ошибка валидации данных запроса
5 Ошибка при проведении операции
5 Ошибка при выполнении запроса
5 При отсутствующем orderId не заполнен OrderNumber
5 Превышено допустимое количество попыток оплаты
5 Невозможно оплатить заказ - заблокирован другим действием
5 Невозможно завершить оплату заказа - заблокирован другим действием
5 Невозможно отменить заказ - заблокирован другим действием
5 Операция отклонена. Проверьте введенные данные, достаточность средств на карте и повторите операцию. Происходит переадресация
5 Ошибка при проведении платежа
6 Неверный номер заказа
7 Неверный статус заказа
7 Не найдена успешная предавторизация
7 Общая сумма возвратов превышает сумму заказа
7 Не найдена успешная платежная операция
7 Не найдена операция валидации
7 Системная ошибка
8 Валюта в Корзине не совпадает с валютой заказа
8 Сумма товарных позиций в Корзине не совпадает с общей суммой заказа
8 Неверный формат корзины
9 Ошибка валидации данных
9 Превышено кол-во попыток отправки уведомлений
9 Некорректный номер телефона
9 Заказ не найден
9 Клиент не найден
9 Клиент не верифицирован
9 Недостаточно данных по клиенту
9 Клиент неактивен
9 Недостаточно данных по клиенту
9 У найденного клиента есть отметка о смерти
9 Неклассифицированный профиль клиента
9 Найдено несколько клиентов
14 Features указаны некорректно
15 Связка деактивирована клиентом

Описание кодов ответа Процессинга

Ошибки данного блока возвращаются при успешной обработке операции Процессинговым центром. Каждый заказ имеет 3 попытки оплаты до истечения срока действия заказа (по умолчанию — 20 минут, значение может быть указано при регистрации заказа).

actionCode actionCodeDescription Расшифровка кода ответа Рекомендация для Партнера/Плательщика
-5031 Ошибка при оплате СБП Подписка клиента не найдена
-3101 Плательщик запретил выполнение операций по данной связке Повторить оплату с использованием альтернативного инструмента платежа
-3100 Связка деактивирована Повторить оплату с использованием альтернативного инструмента платежа
-2020 Операция отклонена. Обратитесь в банк, выпустивший карту Полученный в операции ECI не соответствует допустимым значениям для данной МПС Повторить оплату с использованием альтернативного инструмента платежа
-2019 Операция отклонена. Обратитесь в банк, выпустивший карту Получена ошибка в процессе обработки 3-D Secure сообщений Повторить оплату с использованием альтернативного инструмента платежа
-2018 Операция отклонена. Обратитесь в банк, выпустивший карту Недоступность Directory Server МПС Повторить попытку позже (но в пределах лимита времени, отведенного на оплату заказа) или использовать альтернативный инструмент оплаты заказа
-2017 Операция отклонена. Обратитесь в магазин Плательщик не аутентифицирован (статус 3-D Secure не Y) Не пройдена 3ds-аутентификация держателя карты. Повторить оплату с использованием альтернативного инструмента платежа
-2016 Операция отклонена. Обратитесь в банк, выпустивший карту Невозможно провести аутентификацию Плательщика (статус 3-D Secure U) Возникла ошибка во время проверки возможности проведения 3ds-аутентификации держателя карты в банке-эмитенте. Необходимо повторить попытку или использовать альтернативный инструмент оплаты заказа
-2015 Операция отклонена. Обратитесь в банк, выпустивший карту Получена ошибка в процессе обработки 3-D Secure сообщений Повторить оплату с использованием альтернативного инструмента платежа
-2013 Исчерпаны попытки оплаты Исчерпаны попытки оплаты Для данного заказа превышено установленное количество попыток оплаты. Необходимо создать новый заказ
-2011 Операция отклонена. Обратитесь в банк, выпустивший карту Невозможно провести аутентификацию Плательщика (статус 3-D Secure U) Возникла ошибка во время проверки возможности проведения 3ds-аутентификация держателя карты в банке-эмитенте. Необходимо повторить попытку или использовать альтернативный инструмент оплаты заказа
-2010 Операция отклонена. Обратитесь в банк, выпустивший карту Ошибка при валидации 3-D Secure сообщений (несовпадение XID) Повторить оплату с использованием альтернативного инструмента платежа
-2007 Истек срок ожидания ввода данных Истек срок, отведенный на оплату заказа с момента регистрации платежа (таймаут по умолчанию - 20 мин, продолжительность может быть указана при создании заказа) Необходимо создать новый заказ
-2006 Операция отклонена. Обратитесь в банк, выпустивший карту Аутентификация Плательщика завершена неуспешно (статус 3-D Secure N) Аутентификация держателя карты в банке-эмитенте прошла неуспешно. Необходимо повторить попытку или использовать альтернативный инструмент оплаты заказа
-2005 Операция отклонена. Обратитесь в банк, выпустивший карту Ошибка при валидации 3-D Secure сообщений Аутентификация держателя карты в банке-эмитенте прошла неуспешно. Необходимо повторить попытку или использовать альтернативный инструмент оплаты заказа
-100 Не было попыток оплаты Необходимо оплатить заказ
-99 Ошибка при оплате СБП Операция в обработке. Для операций Оплата/возврат СБП, Оплата с прерыванием и отмены/возвраты по QR POS Транзакция в обработке Действий не требуется
0 Платеж успешно прошел Действий не требуется
1 Операция отклонена. Обратитесь в банк, выпустивший карту Для успешного завершения транзакции требуется подтверждение личности Держателю карты необходимо обратиться в банк-эмитент для подтверждения операции
5 Операция отклонена. Обратитесь в банк, выпустивший карту Отказ сети проводить транзакцию Повторить оплату с использованием альтернативного инструмента платежа
7 Операция отклонена. Обратитесь в магазин Изъять карту. Мошенничество Повторить оплату с использованием альтернативного инструмента платежа
12 Операция отклонена. Обратитесь в банк, выпустивший карту Предпринята попытка выполнить транзакцию на сумму, превышающую лимит, заданный банком-эмитентом Отклонение запроса процессингом банка-эмитента по причине несоответствия суммы операции условиям ее проведения. Оплату заказа можно повторить с использованием альтернативного инструмента платежа
13 Операция отклонена. Обратитесь в магазин Неверно указана сумма транзакции Повторить оплату с использованием альтернативного инструмента платежа
14 Операция отклонена. Обратитесь в банк, выпустивший карту Неверный номер карты Проверить реквизиты карты или использовать другой инструмент для оплаты заказа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
15 Ошибка проведения платежа. Попробуйте позднее. Если данная ошибка возникла повторно, обратитесь в Ваш банк для разъяснения причин МПС не смогла определить эмитента карты Повторить оплату с использованием альтернативного инструмента платежа
31 Нет связи с банком. Повторите позже Нет связи с банком, выпустившим карту Повторить позже или использовать другой инструмент/метод оплаты
41 Операция отклонена. Обратитесь в магазин Изъять карту. Карта утеряна В процессинге банка-эмитента карта помечена как утерянная. Следует использовать альтернативный инструмент платежа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
43 Операция отклонена. Обратитесь в магазин Изъять карту. Карта украдена В процессинге банка-эмитента карта помечена как украденная. Следует использовать альтернативный инструмент платежа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
46 Ошибка при оплате СБП Операция отклонена. Обратитесь в банк, выпустивший карту. При оплате СБП Счет закрыт Отказ от процессинга банка-эмитента по причине закрытия счета или запроса или неверного типа счета.
53 Операция отклонена. Обратитесь в магазин Карты не существует в системах процессинга Отказ от процессинга банка-эмитента по причине закрытия счета или запроса или неверного типа счета. Оплату заказа можно повторить с использованием альтернативного инструмента платежа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
61 Операция отклонена. Обратитесь в банк, выпустивший карту Предпринята попытка выполнить транзакцию на сумму, превышающую дневной лимит, заданный банком-эмитентом Плательщику рекомендуется проверить установленные ограничения в банке-эмитенте или повторить оплату с использованием альтернативного инструмента платежа
62 Операция отклонена. Обратитесь в банк, выпустивший карту Карта заблокирована В процессинге банка-эмитента на карту наложены ограничения. Оплату заказа можно повторить с использованием альтернативного инструмента платежа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
65 Операция отклонена. Обратитесь в банк, выпустивший карту Превышен лимит на число транзакций: клиент выполнил максимально разрешенное число транзакций в течение лимитного цикла и пытается провести еще одну, либо клиентом самостоятельно установлено ограничение на выполнение операций без 3DS аутентификации Плательщику рекомендуется проверить установленные ограничения в банке-эмитенте или повторить оплату с использованием альтернативного инструмента платежа
75 Операция отклонена. Обратитесь в магазин Превышено допустимое число попыток ввода ПИН. Вероятно карта временно заблокирована Оплату заказа можно повторить с использованием альтернативного инструмента платежа
76 Операция отклонена. Обратитесь в магазин Не найдена транзакция (в случае завершения, отмены или возврата) Требуется создание нового заказа
81 Операция отклонена. Обратитесь в банк, выпустивший карту Отказ в проведении операции со стороны банка-эмитента Проверить реквизиты карты или использовать другой инструмент для оплаты заказа
82 Операция отклонена. Обратитесь в банк, выпустивший карту Некорректный CVC Проверить реквизиты карты или использовать другой инструмент для оплаты заказа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
93 Операция отклонена. Обратитесь в банк, выпустивший карту Транзакция незаконна Попытка провести транзакцию, нарушающую требования законодательства. Клиенту рекомендуется сообщить об отказе в выполнении операции без детализации причины
94 Операция отклонена. Обратитесь в магазин Получен дубликат транзакции (в случае завершения или отмены) Требуется уточнить статус обработки
96 Операция отклонена. Обратитесь в банк, выпустивший карту Невозможно провести операцию Повторить позже или использовать другой инструмент/метод оплаты
101 Операция отклонена. Проверьте введенные данные, достаточность средств на карте и повторите операцию Истек срок действия карты Рекомендовать держателю проверить корректность введенного срока действия карты и повторить оплату, либо использовать альтернативный инструмент оплаты заказа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
103 Операция отклонена. Обратитесь в банк, выпустивший карту Торговой точке необходимо связаться с банком-эмитентом Повторить попытку позже (но в пределах лимита времени, отведенного на оплату заказа) или использовать альтернативный инструмент оплаты заказа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
104 Операция отклонена. Обратитесь в банк, выпустивший карту Попытка выполнения операции по счету, на использование которого наложены ограничения В процессинге банка-эмитента на карту наложены ограничения. Оплату заказа можно повторить с использованием альтернативного инструмента платежа
106 Операция отклонена. Обратитесь в магазин Некорректный ПИН. Вероятно карта временно заблокирована Оплату заказа можно повторить с использованием альтернативного инструмента платежа
107 Операция отклонена. Обратитесь в банк, выпустивший карту Следует обратиться к банку-эмитенту Оплату заказа можно повторить с использованием альтернативного инструмента платежа
109 Операция отклонена. Обратитесь в магазин / Ошибка при оплате СБП Оплата в ТСТ приостановлена Неверно указан идентификатор мерчанта/терминала или АСС заблокирован на уровне процессинга Клиенту необходимо связаться с Банком для уточнения причин
110 Ошибка при оплате СБП Некорректный формат запроса или данные не найдены Ошибка при формировании запроса Клиенту необходимо проверить корректность использования параметров в запросе
111 Операция отклонена. Обратитесь в банк, выпустивший карту Неверный номер карты Проверить реквизиты карты или использовать другой инструмент для оплаты заказа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
116 Операция отклонена. Проверьте введенные данные, достаточность средств на карте и повторите операцию Сумма транзакции превышает доступный остаток средств на выбранном счете Рекомендовать держателю карты проверить достаточность средств на счете используемой карты, повторить попытку
118 Операция отклонена. Обратитесь в банк, выпустивший карту Сервис не разрешён (отказ от банка-эмитента) В настоящее время данный код не используется
120 Операция отклонена. Обратитесь в банк, выпустивший карту Отказ в проведении операции - транзакция не разрешена эмитентом Одна из возможных причин – установленное на уровне продукта ограничение в процессинге банка-эмитента. Оплату заказа можно повторить с использованием альтернативного инструмента платежа
125 Операция отклонена. Проверьте введенные данные, достаточность средств на карте и повторите операцию Неверный номер карты. Попытка возврата на сумму больше холда, попытка возврата нулевой суммы Проверить реквизиты карты или использовать другой инструмент для оплаты заказа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
200 Ожидает подтверждения от Банка Ожидает подтверждения от Банка (ошибка POS кредитования) Оплата заказа ожидается
239 Операция отклонена. По требованию банка, выпустившего карту, необходимо отменить подписку Банк, выпустивший карту, отклонил авторизацию и направил код ответа, подразумевающий отмену подписки, по которой направлялась авторизация Проверить реквизиты карты или использовать другой инструмент для оплаты заказа. Если ответ получен при попытке оплаты связкой - удалить связку. Повторные попытки списания по связке запрещены
258 Ошибка при оплате СБП ТСТ не найдено в системе Неверно указан идентификатор терминала. Клиенту необходимо связаться с Банком для уточнения причин
400 Реверсал обработан Успешная отмена. Действий не требуется
902 Операция отклонена. Обратитесь в банк, выпустивший карту / В случае операции по СБП Операция не была проведена успешно Ограничение по карте (владелец карты пытается выполнить транзакцию, которая для него не разрешена) Ошибка при обработке транзакции в процессинге банка-эмитента. Оплату заказа можно повторить с использованием альтернативного инструмента платежа
904 Операция отклонена. Обратитесь в банк, выпустивший карту Ошибочный формат сообщения с точки зрения банка эмитента. Повторить оплату с использованием альтернативного инструмента платежа
903 Ошибка при оплате СБП Превышение лимита по сумме или количеству операций по СБП Невозможно провести операцию Повторить позже или использовать другой инструмент/метод оплаты
909 Операция отклонена. Обратитесь в банк, выпустивший карту Невозможно провести операцию Повторить позже или использовать другой инструмент/метод оплаты
910 Нет связи с банком. Повторите позже Банк-эмитент недоступен Повторить позже или использовать другой инструмент/метод оплаты
913 Операция отклонена. Обратитесь в банк, выпустивший карту Неверный формат сообщения (Неправильный формат транзакции с точки зрения сети) При регистрации заказа был указан неверный код валюты. Необходимо создать новый заказ с корректной валютой.
914 Операция отклонена. Обратитесь в магазин / В случае операции по СБП Оригинальный заказ для отмены не найден Не найдена транзакция (когда посылается завершение или отмена или возврат) Требуется создание нового заказа
997 Требуется провести новую операцию с дополнительной аутентификацией (3-D Secure или аналог) Отсутствует начало авторизации транзакции. Отклонено по причине мошенничества или ошибка 3-D Secure Необходимо провести фронтальный сценарий 3-D Secure или аналог для плательщика
999 Операция отклонена. Обратитесь в магазин / В случае операции по СБП подозрительная операция Отсутствует начало авторизации транзакции. Отклонено по причине мошенничества или ошибка 3-D Secure Повторить позже или использовать другой инструмент/метод оплаты
1001 Не получен ответ от банка. Повторите позже Пусто (Выставляется в момент регистрации транзакции, т.е. когда еще по транзакции не было введено данных карт) Использовать другой инструмент/метод оплаты
1004 Ошибка при оплате СБП Операция не разрешена партнеру Ошибка при проведении операции (наиболее вероятная причина - не установлены соответствующие разрешения на терминале) Клиенту необходимо связаться с Банком для уточнения причин
1014 Операция отклонена. Обратитесь в магазин Код отказа платёжного шлюза по умолчанию Повторить позже или использовать другой инструмент/метод оплаты
1015 Операция отклонена. Проверьте введенные данные, достаточность средств на карте и повторите операцию Введены неправильные параметры карты Проверить реквизиты карты или использовать другой инструмент для оплаты заказа
1018 Не получен ответ от банка. Повторите позже Таймаут в процессинге Не удалось отправить Повторить позже или использовать другой инструмент/метод оплаты
1019 Не получен ответ от банка. Повторите позже Таймаут в процессинге Удалось отправить, но не получен ответ от банка Повторить позже или использовать другой инструмент/метод оплаты
2002 Операция отклонена. Обратитесь в магазин / В случае операции по СБП Нарушена последовательность запросов Неверная операция Попытка завершить оплату в двухстадийном сценарии при неуспешно обработанной предварительной авторизации. Необходимо создать новый заказ
2003 Операция отклонена. Обратитесь в магазин Операции без 3-D Secure запрещены Клиенту Оплата без дополнительной аутентификации держателей карт (3ds) не разрешена для магазина и попытка аутентификации завершилась неуспешно. Рекомендуется использовать другой инструмент/метод оплаты
2004 Операция отклонена. Обратитесь в магазин Оплата через SSL без ввода CVС2 запрещена Оплата без ввода проверочного кода с карты не разрешена для магазина. Повторить оплату заказа с обязательным вводом проверочного кода карты (CVC2/CVV2/CVP2) держателем
2005 Операция отклонена. Обратитесь в магазин Платеж не соответствует условиям проверки по 3-D Secure для Клиента Использовать другой инструмент/метод оплаты
2007 Операция отклонена. Обратитесь в магазин Заказ уже оплачен Заказ был оплачен ранее. Действий не требуется
2009 Операция отклонена. Обратитесь в магазин В случае операции по СБП Сумма отмены/возврата больше суммы оригинальной транзакции Сумма возврата превышает сумму оплаты Проверить сумму операции, скорректировать при необходимости и повторить возврат или завершение
2014 Операция отклонена. Обратитесь в магазин Ошибка выполнения 3DS правила Попытка провести операцию при настроенных на данном терминале ограничениях, соответствующую условиям ограничений
2016 Операция отклонена. Обратитесь в магазин Мерчант не имеет разрешения на 3-D Secure, необходимое для проведения платежа Попытка провести операцию с 3ds-аутентификацией держателя карты в магазине, который не имеет установленного разрешения на это. Необходимо создать новый заказ
2021 Клиент отказался от получения кредита Клиент отказался
2022 Заявка на кредит отклонена Заявка на кредит отклонена
2024 Заявка на кредит в статусе черновик Черновик Необходимо завершить оформление заявки
4005 Заказ отклонён продавцом Отклонено продавцом

Тестовые карты

PAN карты Срок действия CVC/CVV Код ACS Комментарий
2202 2050 0001 2424 05/35 669 -//- МИР 3DS 2.0 Frictionless, Authenticated
2202 2053 0006 8092 05/26 583 111111 МИР 3DS 2.0 Challenge, Authenticated. Фиксированный остаток - 100 рублей
4006 8009 0096 2514 05/30 706 111111 VISA 3DS 1.0
5469 9801 0004 8525 05/26 041 111111 MasterCard 3DS 1.0
2202 2061 0004 0083 05/26 061 -//- МИР, карта не вовлечена в 3DS
2202 2060 0027 0541 05/28 123 111111 МИР, корпоративная карта
2202 2050 0006 0910 06/28 810 111111 МИР, карта для воспроизведения 116 ошибки (недостаточно средств)
2202 2021 0759 3166 06/22 123 111111 МИР, карта для воспроизведения 101 ошибки (карта просрочена)

Оплата с помощью SberPay

При взаимодействии с Платежным шлюзом Партнеру доступен функционал оплаты с помощью SberPay в мобильном приложении "Сбербанк-Онлайн". Имплементация функционала для достижения наилучших возможных показателей конверсии предусматривает соответствие платежного опыта Партнера с требованиями Банка, описание функционала и примеры имплементации доступны в ознакомительных материалах.

Оплата в APP-канале

SberPay поддерживает платежный функционал в APP-канале. Применяются 2 схемы реализации платежного функционала:

  • SberPay SDK InApp
  • SberPay App2App

SberPay SDK InApp

SDK – Это набор средств для разработки, благодаря которым можно легко интегрировать SberPay в мобильное приложение партнера и улучшить клиентский опыт.

Преимущества SDK InApp: • Отсутствует потребность в доработках внедренного метода. Доработки и поддержку поверхности SDK InApp производит Банк; • Повышает конверсию в оплату. На поверхности SDK InApp доступны все карты Сбера, отображается баланс и дополнительные финансовые сервисы Сбера; • Продвинутый клиентский опыт. Минимальный клиентский путь. Поддержка длительной авторизации по куки. Не уводим клиентов с поверхности Партнера. Качественный UX/UI платежной поверхности; • Санкции не влияют на стабильность работы SDK InApp.

Материалы для разработчиков доступны по ссылке

SberPay App2App

Устаревший функционал SberPay позволяющий интегрировать SberPay в приложение партнера. Оплата подтверждается и производится в приложении Сбера посредством диплинка встраиваемого в кнопку оплаты со SberPay

Оплата в WEB-канале

SberPay поддерживает свой функционал оплаты на десктопных и мобильных WEB-сайтах.

SberPay WEB SDK

WEB SDK позволяет интегрировать с веб-сайтом партнера нативную платежную поверхность SberPay. Это техническое решение является передовым клиентским опытов в SberPay и обладает преимуществами:

  • Простое внедрение. Банк предоставляет готовую библиотеку, партнеру достаточно встроить ее на свой WEB-сайт;
  • Не уводим клиента с WEB-сайта. Для клиента оплата производится на сайте без переходов куда-либо. Удобная платежная штора позволяет видеть все карты клиента, их баланс и поддерживает финансовые сервисы Сбера;
  • Нет затрат на поддержку. Клиентский опыт на платежной поверхности обновляется и поддерживается силами Банка;
  • Достаточно войти один раз. Если клиент авторизовался на платежной поверхности – мы его запомним. Последующие оплаты производятся бесшовно.

Материалы для разработчиков доступны по ссылке

SberPay Web2App (нативная интеграция)

Альтернативный платежный опыт нативной оплаты на WEB поверхностях без использования платежной страницы. Функционал оплаты реализован по двум сценариям:

  • Партнер выводит на поверхность сайта QR-код. Для оплаты клиент должен его отсканировать. Подтверждение и завершение оплаты производится в приложении Сбербанка;
  • Партнер выводит кнопку «Оплатить по номеру телефона». Для оплаты клиент вводит свой номер, привязанный к приложению Сбербанка. После чего ему направляется ПУШ или смс. По ПУШ или по ссылке в СМС – откроется приложение Сбербанка, где клиент подтверждает и завершает оплату. ВАЖНО! В данном платежном функционале требуется особо тщательное соблюдение UX/UI рекомендаций Банка.

Платежная страница

Платежная страница СберБанка по умолчанию устанавливается при подключении эквайринга СБЕРа. У партнера есть возможность подключить еще и оплату через SberPay на поверхности платежной страницы. Это простой и удобный способ совершать онлайн-покупки. Клиенту достаточно нажать на кнопку оплаты со SberPay и отсканировать QR-код (или выбрать оплату по номеру телефона). Завершение оплаты производится в приложении СберБанка где клиенту доступна возможность выбрать любую карту из имеющихся. Вам не потребуется никаких доработок, если у вас подключен эквайринг СберБанка. Оставить заявку на подключение SberPay вы можете на сайте

Дополнительные материалы по интеграции сервиса

Обратите внимание! Работа с функционалом оплаты с помощью SberPay доступна в рамках сервисов, описанных в документации, но может быть интегрирована Партнером отдельно от других способов оплаты. При работе с функционалом SberPay использование блока "sberbankOnlineAttributes" в теле запроса в jsonParams является обязательным при регистрации заказа в сервисах register/registerPreAuth.

При интеграции сценария mweb2app на устройствах apple необходимо реализовывать процедуру перебора диплинков. Это связано с различными версиями приложений, установленных на устройствах пользователей. Подробная инструкция по реализации процедуры доступна в документе.

Дополнительно ознакомиться с процедурой тестирования SberPay можно в документации.

Описание требований к клиентскому опыту при реализации функционала SberPay в приложенном документе.

Описание интеграции функционала SberPay в приложенном документе.

Руководство по логотипам для SberbankOnline в приложенном документе.

Обработка операций и ответы Шлюза соответствуют описанию, размещенному в разделах Описание кодов ответа Шлюза и Описание кодов ошибок Шлюза.

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

Инструкции по имплементации SberPay SDK для сайтов и мобильных приложений находятся по ссылке.

С примером отрисовки кнопки SberPay можно ознакомиться по ссылке.

Допустимые варианты отрисовки логотипа SberPay находятся в приложенном документе

Фискализация (54-ФЗ)

В соответствии с Федеральным законом РФ №54-ФЗ c 01.07.2017 при осуществлении онлайн продаж, Продавец (в данной документации - Клиент), с помощью онлайн-кассы, обязан формировать кассовый чек и направлять его в ФНС и покупателю. В целях исполнения данного требования ПАО Сбербанк разработан механизм интеграции с онлайн-кассами, позволяющий упростить для Партнера данную процедуру. На текущий момент Платежным шлюзом поддерживаются только кассы "АТОЛ Онлайн", “Цифровая касса ЭВОТОР”, "Бизнес.ру" с версиями ФФД 1.05 и 1.2, а так же "OFD.RU" с версиями ФФД 1.1 и 1.2.

Доступный функционал

  • Отправка данных онлайн-кассе для формирования чеков в форматах ФФД 1.05 и 1.2;
  • Формирование чеков прихода, возврата прихода (в том числе - частичного);
  • Возможность переотправки неуспешного чека с изменением корзины;
  • Переотправка чека в случае возникновения ошибки кассы или при таймауте отправки;
  • Создание чека отдельно от финансовой операции (закрывающий чек);
  • Возможность разделения чека на несколько, в случае превышения максимального размера;
  • Получение статуса чека отдельным API запросом.

Условия формирования чеков

Для успешной регистрации кассового чека необходимо выполнение следующих условий:

  • Для создания чека необходимо передать корзину с обязательным присутствием параметров ffdVersion и receiptType в любом из сервисов register, registerPreAuth, deposit, reverse, refund;
  • В каждом чеке будут присутствовать параметры, которые были переданы в составе соответствующего сервиса;
  • Функционал фискализации заказов подключен и успешно настроен для мерчанта: учетные данные для подключения онлайн-кассы корректны и внесены в настройки.

Разрешительный режим продажи маркированных товаров

С 01.04.2025 перед продажей маркированных товаров необходимо осуществлять онлайн проверку кода маркировки в Честном Знаке. Существует 2 способа осуществления проверки:

  1. На стороне вашего кассового сервиса необходимо включить проверку КМ и указать заранее полученный токен Честного Знака. Проверка будет осуществляться автоматически кассовым сервисом, и данные будут передаваться в Честный Знак. В этом случае нельзя передавать в составе корзины sectoralItemProps (тег 1260) и все вложенные объекты. Обратите внимание, данные способ поддерживают только кассовые сервисы Бизнес.Ру и Ferma от OFD.RU.
  2. Самостоятельная интеграция с Честным Знаком для получения данных о статусе кода маркировки, и включение этих данных в объект sectoralItemProps (тег 1260) при формировании "закрывающего" чека.

Состав тега 1260:

Тег Наименование Значение
1262 Идентификатор ФОИВ фиксированное: 030
1263 Дата документа основания фиксированное: 21.11.2023
1264 Номер документа основания фиксированное: 1944
1265 Значение отраслевого реквизита динамическое поле. В ответе метода проверки КМ в ЧЗ в режиме онлайн возвращаются атрибуты reqId (Идентификатор запроса) и reqTimestamp (Время запроса). Атрибуты необходимо передавать в тег 1265 в формате: UUID=reqId&Time=reqTimestamp

Подключение кассы

Для подключения кассы Эвотор необходимо:

  1. Зарегистрироваться в сервисе Цифровая касса для получения облачной кассы или установить приложение Цифровая касса из магазина Эвотор вашей онлайн-кассы.
  2. Самостоятельно, в соответствии с инструкцией или с помощью сотрудников Эвотор зарегистрируйте кассу в Федеральной Налоговой Службе (ФНС) и у Оператора Фискальных Данных (ОФД).
  3. В личном кабинете Цифровой кассы (если используете облачную кассу) или в личном кабинете Эвотор (если используете онлайн-кассу) получите учетные данные кассы – Код группы касс.
  4. Настроить интеграцию можно через личный кабинет СберБизнес или направив запрос в службу технической поддержки интернет-эквайринга Сбербанка. В запросе следует указать Код группы касс, используемую версию ФФД и merchantID, предоставленный Банком.

Для подключения кассы АТОЛ необходимо:

  1. Зарегистрироваться в сервисе "АТОЛ Онлайн";
  2. Самостоятельно, в соответствии с инструкцией или с помощью сотрудников АТОЛ Онлайн зарегистрируйте кассу в Федеральной Налоговой Службе (ФНС) и у Оператора Фискальных Данных (ОФД);
  3. В личном кабинете АТОЛ Онлайн получите учетные данные кассы (логин, пароль, код группы ККТ);
  4. Настроить интеграцию можно через личный кабинет СберБизнес или направив запрос в службу технической поддержки интернет-эквайринга Сбербанка. В запросе следует указать учетные данные кассы и используемую версию ФФД.

Для подключения кассы OFD.RU необходимо:

  1. Зарегистрироваться в личном кабинете Партнера OFD.RU;
  2. Зарегистрируйте кассу в Федеральной Налоговой Службе (ФНС);
  3. В личном кабинете Партнер OFD.RU получите учетные данные кассы (логин и пароль);
  4. Настроить интеграцию можно через личный кабинет СберБизнес или направив запрос в службу технической поддержки интернет-эквайринга Сбербанка. В запросе следует указать учетные данные кассы и используемую версию ФФД.

Для подключения кассы Бизнес.Ру необходимо:

  1. Зарегистрироваться в личном кабинете Бизнес.Ру;
  2. Зарегистрируйте кассу в Федеральной Налоговой Службе (ФНС);
  3. Обратиться в поддержку Бизнес.Ру с запросом подключения интеграции Сбербанка api-sberbank;
  4. В личном кабинете Бизнес.Ру получите учетные данные кассы (логин и пароль);
  5. Настроить интеграцию можно через личный кабинет СберБизнес или направив запрос в службу технической поддержки интернет-эквайринга Сбербанка. В запросе следует указать учетные данные кассы и используемую версию ФФД.

Сценарии работы с чеками

Программа лояльности СберСпасибо

Функционал находится в разработке

СберСпасибо - это бонусная программа лояльности от ПАО «Сбербанк» для своих клиентов.

На специальный бонусный счет Плательщика, начисляется процент от суммы покупки, которую Плательщик совершает по карте.

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

Накопленными бонусами (1 бонус равен 1 рублю) можно оплачивать товары в магазинах-партнёрах программы. Предоставление возможности оплачивать товары/услуги бонусами возможно несколькими способами.

Схемы интеграции при оплате бонусами

Оплата с использованием бонусов на платёжной странице ПШ

Оплата с использованием бонусов в SberPay

Оплата с использованием бонусов по связке

Ограничения при работе с программой лояльности СберСпасибо

  • Заказ должен быть оформлен в рублях РФ
  • Доступна только полная отмена заказа (частичная отмена заказа недоступна)
  • Вместо стандартных сервисов завершения двухстадийного сценария deposit и возврата средств Плательщика refund необходимо использовать аналогичные сервисы autoCompletion и autoRefund с указанием общей суммы операции в рублях и бонусах
  • В случае завершения двухстадийного сценария или возврата на частичную сумму Платежный шлюз произведёт перерасчёт пропорции бонусов и рублей
  • При работе с товарной корзиной осуществляются дополнительные проверки на содержание корзины:
    • Для каждой товарной позиции произведение стоимости единицы товара itemPrice на количество товарных позиций quantity.value должно строго равняться итоговой стоимости товарной позиции itemAmount

    • Сумма стоимостей всех товарных позиций itemAmount должна равняться итоговой сумме чека total и сумме операции в запросе amount/compositeAmount

    • Для связанных операций в рамках одного заказа (завершение двухстадийного сценария, отмена, возврат) необходимо:

      • Передавать корзину в случае, если она была передана при регистрации заказа
      • Обеспечить неизменность уникальных идентификаторов товарных позиций внутри Корзины positionId и itemCode
      • Передавать стоимости товаров itemPrice и itemAmount до вычета бонусов
    • Уникальный идентификатор товарной позиции внутри Корзины (positionId) должен быть больше или равен 1

    • Доступен возврат только товарных позиций, участвовавших в оплате при одностадийном сценарии (переданных в запросе register) или в завершении платежа при двухстадийном сценарии (переданных в запросе autoCompletion)

    • За распределение скидки по товарной корзине при оплате бонусами отвечает процессинг лояльности СберСпасибо

    • В связи с особенностью распределения бонусов СберСпасибо на стороне процессинга лояльности по переданным товарным позициям Шлюз использует следующую методику округления при осуществлении возвратов:

      • определяется стоимость позиции со скидкой путем вычитания из изначальной стоимости позиции размера скидки на позицию;
      • определяется цена единицы товара путем разделения стоимости позиции со скидкой на количество товара с применением математического округления;
      • при возврате стоимости последней единицы товара в позиции её цена рассчитывается путем вычитания из стоимости позиции со скидкой цены всех предыдущих товаров.

      Пример:

      • В корзине 3 товара с ценой 33.00. Применяется скидка бонусами СберСпасибо 29.99.
      • Стоимость позиции с учетом скидки: 33.00 - 29.99 = 3.01.
      • Цена единицы товара с учетом скидки: 3.01 / 3 = 1.00
      • Цена последней возвращаемой единицы товара: 3.01 - 1.00 - 1.00 = 1.01.

      Данная методика применима при реализации собственного решения по фискализации.

    • В случае использования функционала фискализации на стороне Шлюза (функционал находится в разработке):

      • Платежный шлюз вычитает применённую скидку бонусами из стоимости товарной позиции. Вычитание скидки за счет бонусов не распространяется на сервис создания нового чека doReceipt
      • В случае, если после применения скидки бонусами невозможно корректно рассчитать цену за единицу товара, производится разделение одной товарной позиции на две товарные позиции с разными ценами за единицу товара с сохранением общей стоимости товарных позиций
  • Данные о состоянии бонусов по программам лояльности в заказе доступны в ответе на сервис получения информации о заказе getOrderStatusExtended

Электронные сертификаты (491-ФЗ)

Функционал находится в разработке

Электронный сертификат – это новый платежный инструмент, который предоставляет возможность самостоятельно приобретать отдельные виды товаров, работ и услуг за счет средств бюджетов при наличии оснований на получение мер государственной поддержки в натуральной форме. Электронный сертификат выпускается к карте ПС «Мир», а оплата работает аналогично операциям с использованием банковских карт и позволяет мгновенно оплатить отдельные виды товаров при наличии оснований на предоставление мер социальной поддержки.

Сертификат содержит сведения о том, какие товары, работы или услуги, в каком количестве и на какую предельную сумму можно приобрести с его использованием. Сами денежные средства на карту ПС «Мир» не перечисляются, а резервируются в бюджете до совершения покупки. При этом использовать собственные средства необходимо только в случае, если количество и (или) стоимость приобретаемых товаров, работ или услуг превышает количество и (или) предельную стоимость в электронном сертификате.

Доступ к функционалу

Для того, чтобы подключить возможность принимать оплаты с помощью электронных сертификатов, Мерчанту необходимо:

  1. Для осуществления расчетов по операциям с использованием ЭС требуется заключить дополнительное соглашение к договору ИЭ.

  2. Для возможности взаимодействия с Фронт-офисом Электронных Сертификатов НСПК ТСП Мерчанту необходимо поддерживать кодировку товаров, согласованную с перечнем товаров/работ/услуг - truCode.

  3. Зарегистрироваться в Государственной информационной системе электронных сертификатов ГИС ЭС

  4. В системах внутреннего учета продавца требуется обеспечить кодировку ТРУ согласно перечню, утвержденному в соответствии с постановлением Правительства Российской Федерации от 23.04.2021 № 631 «О порядке формирования и утверждения Перечней отдельных видов товаров, работ, услуг, приобретаемых с использованием электронного сертификата за счет средств бюджета бюджетной системы Российской Федерации». Актуальный перечень публикуется в Единой системе нормативной справочной информации.

  5. Пройти регистрацию продавца и магазинов в Автоматизированной системе сбора анкет (АССА) для получения ключа доступа (API KEY). На электронный адрес сотрудника продавца, указанного при заполнении формы на сайте Государственной информационной системы электронных сертификатов (ГИС ЭС) на шаге 3 в качестве технического специалиста , АО «НСПК» направляет ссылку для входа в АССА и создания пароля для доступа в личный кабинет продавца в АССА. При первом входе АССА предложит установить пароль для входа.

  6. Имея API KEY, Мерчант должен получить идентификатор кассы (cashboxId) и ключа кассы (MAC KEY) в ФЭС НСПК.

  7. Мерчант должен передать API KEY, cashboxId, MAC KEY Банку-эквайеру и провести тестовую операцию.

  8. Перейти в промышленную среду.

Руководство для торгово-сервисных предприятий по организации приема электронных сертификатов при оплате отдельных видов товаров, работ, услуг размещено на официальном сайте АО «НСПК» в разделе Электронные сертификаты – Оферта для ТСП

Схемы интеграции при оплате ЭС

Оплата с использованием ЭС на платёжной странице ПШ

Ограничения при работе с ЭС

  • Заказ должен быть оформлен в рублях РФ
  • По операциям, оплаченным с помощью ЭС, недоступна отмена операции. Поддерживаются частичные и полные возвраты товаров, приобретенных c использованием средств ЭС. При возврате товара, приобретенного с использованием средств ЭС, средства возвращаются на счет ЭС.
  • За счет средств ЭС частично или полностью оплачиваются только товары, по которым переданы коды ТРУ (truCode), товары из товарной корзины без кодов ТРУ не участвуют в процессе оплаты ЭС.
  • При работе с ЭС передача товарной корзины является обязательной. На стороне ПШ осуществляются дополнительные проверки на содержание товарной корзины:
    • Для каждой товарной позиции произведение стоимости единицы товара itemPrice на количество товарных позиций quantity.value должно строго равняться итоговой стоимости товарной позиции itemAmount
    • Сумма стоимостей всех товарных позиций itemAmount должна равняться итоговой сумме чека total и сумме операции amount в запросе
    • При формировании операции возврата необходимо обеспечить неизменность параметров товарных позиций корзины: positionId, itemCode, itemPrice, truCode
    • Доступен возврат только товарных позиций, участвовавших в оплате (переданных в запросе register)
  • Данные о состоянии средств ЭС в заказе доступны в ответе на сервис получения информации о заказе getOrderStatusExtended
  • В случае проведения фискализации на стороне Клиента, после получения реквизитов фискального чека покупки или возврата от онлайн кассы, необходимо передать данные параметры фискального чека в сервисе externalReceipt для передачи их в ФЭС. Если фискализация осуществляется на стороне ПШ, то дополнительных вызовов для работы с ЭС не требуется.

Личный кабинет

Ознакомиться с инструкциями по работе в личном кабинете Сбербанк Бизнес Онлайн вы сможете на сайте Сбербанка. Ниже приведены наиболее востребованные ссылка на разделы по работе с заказами интернет-эквайринга.

Оплата с помощью Универсальной Платежной Ссылки и Цифрового Рубля.

Сервис доступен при соблюдении следующих условий:

  1. Открыт счет в ЦР через Сбербанк / получен доступ к счету через Сбербанк

  2. Подписан договор по СБП

  3. Подписано доп/соглашение к договору СБП об использовании УПК (Универсального платежного кода) для приема оплат цифровым рублем.

  4. Выполнено подключение к ecom АПИ Сбербанка

Сценарий оплаты Цифровым Рублем:

  1. Партнер создает заказ методом register.do, указывая в блоке jsonParams "qrType" значение "DYNAMIC_QR_SBP", "sbp.scenario" значение "C2B", поле "description" заполняется опционально.

  2. При обработке запроса на создание заказа Сбер получает в НСПК универсальную платежную ссылку с двумя способами оплаты – СБП и ЦР (ссылка УПК), и передает ее партнеру в ответ на register.do.

  3. Партнер использует payload в своем app/mWEB, используя виджет НСПК https://widget.cbrpay.ru/v1, или формирует и отображает клиенту QR-код.

  4. Клиент-физическое лицо выбирает свой банк в списке банков-эмитентов, сформированном виджетом, или сканирует QR-код, далее переходит в приложение своего банка и подтверждает оплату цифровым рублем.

  5. После проведения оплаты через контур Платформы цифрового рубля Банка России, НСПК, Сбер получает подтверждение о получении платежа, и присваивает заказу статусы, соответствующие результату оплаты.

  6. Сбер направляет партнеру информацию о статусе заказа в ответ на запрос getOrderStatusExtended.do, либо в callback. Если заказ был оплачен Цифровыми рублями, то в ответе значение параметра в объекте cardAuthInfo "paymentWay" = "NSPK_DIGITAL_RUB", в объекте "transactionAttributes" параметр "extTransactionId" будет содержать идентификатор операции на Платформе Цифрового рубля.

Сервисы для работы с заказом

Методы API для создания заказа, отмены заказа, получения статуса заказа, осуществления возврата средств по заказу.

Регистрация заказа [register]

Запрос предназначен для регистрации (создания) заказа в Шлюзе. При успешной обработке запроса заказу присваивается номер (идентификатор), уникальный в рамках Шлюза. Метод используется для регистрации заказа с последующией оплатой любым способом:

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос регистрации заказа по одностадийному сценарию

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderNumber
required
string (orderNumber) [ 1 .. 36 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Уникальный номер (идентификатор) заказа в системе Партнера. Обязателен, если в запросе отсутствует orderId.

amount
required
integer (amount) [ 0 .. 999999999999 ]

Сумма операции в минимальных единицах валюты

currency
string (currency) = 3 characters ^\d{3}$
Default: "643"

Цифровой код валюты операции ISO-4217

returnUrl
required
string (returnUrl) [ 12 .. 2048 ] characters ^(http://|https://).*$

Адрес, на который требуется перенаправить Плательщика в случае успешной оплаты, когда Партнер использует платёжную страницу ПШ

Обратите внимание!

  1. Если доменное имя содержит кирилические символы, то его необходимо преобразовать по алгоритму ACE. Т.е. строка "сберпей.рф" будет выглядеть как "xn--90aiaq2afe.xn--p1ai"
  2. Если query параметр содержит символ % - считается, что к данному параметру уже применено экранирование и преобразование не осуществляется (параметр остается "как есть")
  3. Если query параметр содержит символы, отличные от множества [a-zA-Z0-9.-*_ ], эти символы экранируются через символ %. Строка вида "сберпей.рф" будет выглядеть как "%D1%81%D0%B1%D0%B5%D1%80%D0%BF%D0%B5%D0%B9%2E%D1%80%D1%84"
failUrl
string (failUrl) [ 12 .. 2048 ] characters ^(http://|https://).*$

Адрес, на который требуется перенаправить Плательщика в случае неуспешной оплаты, когда Партнер использует платёжную страницу ПШ. Если не указан, используется returnUrl

Обратите внимание!

  1. Если доменное имя содержит кирилические символы, то его необходимо преобразовать по алгоритму ACE. Т.е. строка "сберпей.рф" будет выглядеть как "xn--90aiaq2afe.xn--p1ai"
  2. Если query параметр содержит символ % - считается, что к данному параметру уже применено экранирование и преобразование не осуществляется (параметр остается "как есть")
  3. Если query параметр содержит символы, отличные от множества [a-zA-Z0-9.-*_ ], эти символы экранируются через символ %. Строка вида "сберпей.рф" будет выглядеть как "%D1%81%D0%B1%D0%B5%D1%80%D0%BF%D0%B5%D0%B9%2E%D1%80%D1%84"
description
string (description) [ 1 .. 512 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Описание заказа в свободной форме на стороне Партнера. Рекомендуемая длина до 99 символов

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

clientId
string (clientId) [ 1 .. 255 ] characters ^[ -~]+$

Номер (идентификатор) Плательщика в системе Партнера. Используется для реализации функционала Связок

merchantLogin
string (merchantLogin) [ 1 .. 30 ] characters ^[A-Za-z0-9-_.-]+$

Логин дочернего Партнера (если используется)

fmConversionAttributes (object) or sberbankOnlineAttributes (object) or qrAttributes (object) or paymentPageAttributes (object) or tdsDestinationNumberAttributes (object) or tdsAdditionalAttributes (object) or keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером. В случае, если необходима обработка блока jsonParams (отображение в СберБизнес, передача в отчетность/уведомления), требуется обязательная передача параметра pdAgreement со значением true в блоке jsonParams

sessionTimeoutSecs
integer (sessionTimeoutSecs) [ 0 .. 999999999 ]
Default: 1200

Продолжительность жизни заказа в секундах. В случае если параметр не задан, будет использовано значение, указанное в настройках Партнера или время по умолчанию (20 минут). Если в запросе присутствует параметр expirationDate, то значение параметра sessionTimeoutSecs не учитывается

expirationDate
string <date-time> (expirationDate)

Дата и время окончания жизни заказа на стороне ПШ в формате yyyy-MM-ddTHH:mm:ss. Если этот параметр не передаётся в запросе, то для определения времени окончания жизни заказа используется sessionTimeoutSecs

bindingId
string <uuid> (bindingId) = 36 characters ^[a-f0-9\-]+$

Идентификатор Связки, созданной ранее. Может использоваться, только если у магазина есть разрешение на работу со связками

features
string (features) [ 1 .. 255 ] characters ^[ -~]*$

Дополнительные параметры управления сценариями при использовании платёжных реквизитов (можно указать несколько через разделитель ";"):

  • VERIFY = Происходит верификация Плательщика без списания средств с его счёта, поэтому в запросе можно передавать нулевую сумму. Даже если сумма платежа будет передана в запросе, она не будет списана со счёта покупателя. После успешной верификации заказ сразу переводится в статус REVERSED (отменён);
  • AUTO_PAYMENT = Платёж проводится с использованием ранее сохраненных реквизитов карты (связке) без проверки подлинности владельца карты (без CVC и 3-D Secure). Чтобы проводить подобные платежи у продавца должны быть соответствующие разрешения. Функционал подключается по запросу;
  • FORCE_SSL = Принудительное проведение платежа без использования 3-D Secure. Не может быть использован для сохранения данных карты (создания связки) Функционал является высокорисковым, подключается по запросу;
  • FORCE_TDS = Принудительное проведение платежа с использованием 3-D Secure. Если карта не поддерживает 3-D Secure, операция будет отклонена;
  • FORCE_FULL_TDS = Принудительное проведение платежа только с успешной аутентификацией плательщика 3-D Secure (Y). В противном случае операция будет отклонена.
phone
string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$

Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email.

email
string (email) [ 3 .. 128 ] characters ^[ -~]+$

Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone.

object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

dynamicCallbackUrl
string (dynamicCallbackUrl) [ 12 .. 512 ] characters ^(https://).*$

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

Обратите внимание!

  1. Если доменное имя содержит кирилические символы, то его необходимо преобразовать по алгоритму ACE. Т.е. строка "сберпей.рф" будет выглядеть как "xn--90aiaq2afe.xn--p1ai"
  2. Если query параметр содержит символ % - считается, что к данному параметру уже применено экранирование и преобразование не осуществляется (параметр остается "как есть")
  3. Если query параметр содержит символы, отличные от множества [a-zA-Z0-9.-*_ ], эти символы экранируются через символ %. Строка вида "сберпей.рф" будет выглядеть как "%D1%81%D0%B1%D0%B5%D1%80%D0%BF%D0%B5%D0%B9%2E%D1%80%D1%84"

Responses

Request samples

Content type
application/json
Example
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
  • "amount": 19900,
  • "features": "FORCE_SSL"
}

Response samples

Content type
application/json
Example
{}

Регистрация заказа для двухстадийного сценария [registerPreAuth]

Запрос предназначен для регистрации (создания) заказа в Шлюзе, дальнейшая обработка (оплата) которого требует дополнительного подтверждения. При успешной обработке запроса заказу присваивается номер (идентификатор), уникальный в рамках Шлюза. Функционал подключается по запросу.

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос регистрации заказа по двухстадийному сценарию

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderNumber
required
string (orderNumber) [ 1 .. 36 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Уникальный номер (идентификатор) заказа в системе Партнера. Обязателен, если в запросе отсутствует orderId.

amount
required
integer (amount) [ 0 .. 999999999999 ]

Сумма операции в минимальных единицах валюты

currency
string (currency) = 3 characters ^\d{3}$
Default: "643"

Цифровой код валюты операции ISO-4217

returnUrl
required
string (returnUrl) [ 12 .. 2048 ] characters ^(http://|https://).*$

Адрес, на который требуется перенаправить Плательщика в случае успешной оплаты, когда Партнер использует платёжную страницу ПШ

Обратите внимание!

  1. Если доменное имя содержит кирилические символы, то его необходимо преобразовать по алгоритму ACE. Т.е. строка "сберпей.рф" будет выглядеть как "xn--90aiaq2afe.xn--p1ai"
  2. Если query параметр содержит символ % - считается, что к данному параметру уже применено экранирование и преобразование не осуществляется (параметр остается "как есть")
  3. Если query параметр содержит символы, отличные от множества [a-zA-Z0-9.-*_ ], эти символы экранируются через символ %. Строка вида "сберпей.рф" будет выглядеть как "%D1%81%D0%B1%D0%B5%D1%80%D0%BF%D0%B5%D0%B9%2E%D1%80%D1%84"
failUrl
string (failUrl) [ 12 .. 2048 ] characters ^(http://|https://).*$

Адрес, на который требуется перенаправить Плательщика в случае неуспешной оплаты, когда Партнер использует платёжную страницу ПШ. Если не указан, используется returnUrl

Обратите внимание!

  1. Если доменное имя содержит кирилические символы, то его необходимо преобразовать по алгоритму ACE. Т.е. строка "сберпей.рф" будет выглядеть как "xn--90aiaq2afe.xn--p1ai"
  2. Если query параметр содержит символ % - считается, что к данному параметру уже применено экранирование и преобразование не осуществляется (параметр остается "как есть")
  3. Если query параметр содержит символы, отличные от множества [a-zA-Z0-9.-*_ ], эти символы экранируются через символ %. Строка вида "сберпей.рф" будет выглядеть как "%D1%81%D0%B1%D0%B5%D1%80%D0%BF%D0%B5%D0%B9%2E%D1%80%D1%84"
description
string (description) [ 1 .. 512 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Описание заказа в свободной форме на стороне Партнера. Рекомендуемая длина до 99 символов

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

clientId
string (clientId) [ 1 .. 255 ] characters ^[ -~]+$

Номер (идентификатор) Плательщика в системе Партнера. Используется для реализации функционала Связок

merchantLogin
string (merchantLogin) [ 1 .. 30 ] characters ^[A-Za-z0-9-_.-]+$

Логин дочернего Партнера (если используется)

fmConversionAttributes (object) or sberbankOnlineAttributes (object) or qrAttributes (object) or paymentPageAttributes (object) or tdsDestinationNumberAttributes (object) or tdsAdditionalAttributes (object) or keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером

sessionTimeoutSecs
integer (sessionTimeoutSecs) [ 0 .. 999999999 ]
Default: 1200

Продолжительность жизни заказа в секундах. В случае если параметр не задан, будет использовано значение, указанное в настройках Партнера или время по умолчанию (20 минут). Если в запросе присутствует параметр expirationDate, то значение параметра sessionTimeoutSecs не учитывается

expirationDate
string <date-time> (expirationDate)

Дата и время окончания жизни заказа на стороне ПШ в формате yyyy-MM-ddTHH:mm:ss. Если этот параметр не передаётся в запросе, то для определения времени окончания жизни заказа используется sessionTimeoutSecs

bindingId
string <uuid> (bindingId) = 36 characters ^[a-f0-9\-]+$

Идентификатор Связки, созданной ранее. Может использоваться, только если у магазина есть разрешение на работу со связками

features
string (features) [ 1 .. 255 ] characters ^[ -~]*$

Дополнительные параметры управления сценариями при использовании платёжных реквизитов (можно указать несколько через разделитель ";"):

  • VERIFY = Происходит верификация Плательщика без списания средств с его счёта, поэтому в запросе можно передавать нулевую сумму. Даже если сумма платежа будет передана в запросе, она не будет списана со счёта покупателя. После успешной верификации заказ сразу переводится в статус REVERSED (отменён);
  • AUTO_PAYMENT = Платёж проводится с использованием ранее сохраненных реквизитов карты (связке) без проверки подлинности владельца карты (без CVC и 3-D Secure). Чтобы проводить подобные платежи у продавца должны быть соответствующие разрешения. Функционал подключается по запросу;
  • FORCE_SSL = Принудительное проведение платежа без использования 3-D Secure. Не может быть использован для сохранения данных карты (создания связки) Функционал является высокорисковым, подключается по запросу;
  • FORCE_TDS = Принудительное проведение платежа с использованием 3-D Secure. Если карта не поддерживает 3-D Secure, операция будет отклонена;
  • FORCE_FULL_TDS = Принудительное проведение платежа только с успешной аутентификацией плательщика 3-D Secure (Y). В противном случае операция будет отклонена.
phone
string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$

Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email.

email
string (email) [ 3 .. 128 ] characters ^[ -~]+$

Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone.

object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

dynamicCallbackUrl
string (dynamicCallbackUrl) [ 12 .. 512 ] characters ^(https://).*$

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

Обратите внимание!

  1. Если доменное имя содержит кирилические символы, то его необходимо преобразовать по алгоритму ACE. Т.е. строка "сберпей.рф" будет выглядеть как "xn--90aiaq2afe.xn--p1ai"
  2. Если query параметр содержит символ % - считается, что к данному параметру уже применено экранирование и преобразование не осуществляется (параметр остается "как есть")
  3. Если query параметр содержит символы, отличные от множества [a-zA-Z0-9.-*_ ], эти символы экранируются через символ %. Строка вида "сберпей.рф" будет выглядеть как "%D1%81%D0%B1%D0%B5%D1%80%D0%BF%D0%B5%D0%B9%2E%D1%80%D1%84"
autocompletionDate
string <date-time> (autocompletionDate)

Дата и время автоматического подтверждения заказа в формате yyyy-MM-ddTHH:mm:ss. Если передан параметр, то вызов метода deposit не требуется.

Responses

Request samples

Content type
application/json
Example
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
  • "amount": 19900,
  • "features": "FORCE_SSL"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "externalParams": {
    }
}

Завершение двухстадийного сценария [deposit]

Запрос предназначен для выполнения дополнительного подтверждения оплаты двухстадийного платежа. При успешной обработке подтверждается списание средств со счета Плательщика.

Внимание! При передаче в параметре amount суммы "0" подтверждение оплаты будет выполнено на полную сумму заказа, без учета ранее выполненной операции частичной отмены

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос завершения двухстадийного сценария

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

amount
required
integer (amount) [ 0 .. 999999999999 ]

Сумма операции в минимальных единицах валюты

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

Responses

Request samples

Content type
application/json
Example
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "amount": 14900
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок"
}

Отмена заказа [reverse]

Запрос предназначен для снятия блокировки средств по операции оплаты. Может быть осуществлена до момента начала взаиморасчетов банков-участников. При оплате Одностадийного платежа может быть выполнена в течение банковского дня совершения операции (~ до 23:59 МСК). При оплате по Двухстадийному сценарию может быть выполнена только до операции завершения двухстадийного сценария.

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос отмены заказа

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

amount
integer (amount) [ 0 .. 999999999999 ]

Сумма операции в минимальных единицах валюты

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером.

object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

Responses

Request samples

Content type
application/json
Example
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок"
}

Возврат средств Плательщика [refund]

Запрос предназначен для выполнения частичного или полного возврата средств Плательщика, после выполнения взаиморасчетов банков-участников по операции оплаты.

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос возврата средств Плательщика

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

amount
required
integer (amount) [ 0 .. 999999999999 ]

Сумма операции в минимальных единицах валюты

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

externalRefundId (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером.

object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

Responses

Request samples

Content type
application/json
Example
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "amount": 14900
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок"
}

Получение информации о заказе [getOrderStatusExtended]

Запрос предназначен для получения полных данных по ранее зарегистрированному заказу независимо от его статуса.

Request Body schema: application/json

Запрос получения информации о заказе

One of
orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "merchantOrderParams": [
    ],
  • "cardAuthInfo": {
    },
  • "bindingInfo": {
    },
  • "paymentAmountInfo": {
    },
  • "bankInfo": { },
  • "payerData": {
    },
  • "transactionAttributes": [
    ],
  • "attributes": [
    ],
  • "operations": [
    ],
  • "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
  • "orderStatus": 2,
  • "actionCode": 0,
  • "errorMessage": "Обработка запроса прошла без системных ошибок",
  • "amount": 19900,
  • "currency": "643",
  • "date": 1675169008805,
  • "depositedDate": 1675169010957,
  • "orderDescription": "Описание заказа",
  • "ip": "192.168.0.1",
  • "authRefNum": "303112098637",
  • "authDateTime": 1675169010957,
  • "terminalId": "20235777"
}

Отмена заказа до начала платежа [decline]

Запрос предназначен для отмены заказа до момента начала его оплаты Плательщиком (до ввода данных карты).

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос отмены заказа до начала платежа

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

merchantLogin
string (merchantLogin) [ 1 .. 30 ] characters ^[A-Za-z0-9-_.-]+$

Логин дочернего Партнера (если используется)

orderId
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

orderNumber
string (orderNumber) [ 1 .. 36 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Уникальный номер (идентификатор) заказа в системе Партнера. Обязателен, если в запросе отсутствует orderId.

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером.

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок"
}

Сервисы проведения оплаты

Методы API для проведения оплаты заказа

Проведение оплаты по карте [paymentOrder]

Запрос предназначен для блокировки средств на карте Плательщика для проведения дальнейших расчетов между банками-участниками. Доступен при наличии соответствующих разрешений.

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос проведения оплаты по карте

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

MDORDER
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

$PAN
required
string (pan) [ 13 .. 19 ] characters ^\d+$

Номер Карты Плательщика

$CVC
string (cvc) = 3 characters ^\d+$

Проверочный код Карты Плательщика (обычно с обратной стороны Карты). Обязательный параметр при проведении SSL операций.

YYYY
required
string (expiryYear) = 4 characters ^\d{4}$

Год окончания срока действия Карты

MM
required
string (expiryMonth) = 2 characters ^\d{2}$

Месяц окончания срока действия Карты

TEXT
string (cardholderName) [ 1 .. 200 ] characters ^[ -~]+$

Текст, изображенный на Карте Плательщика в ISO 8859-1. Допустимы Имя, Фамилия, инициалы или любые комбинации специальных символов ASCII, кроме кириллицы

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

ip
string (ip) [ 1 .. 39 ] characters ^[ -~]*$

IP-адрес Плательщика

email
string (email) [ 3 .. 128 ] characters ^[ -~]+$

Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone.

fmConversionAttributes (object) or dataEntryModeAttributes (object) or tdsDestinationNumberAttributes (object) or tdsDecoupledAttributes (object) or tdsBrowserAttributes (object) or tdsAdditionalAttributes (object) or tdsApplicationAttributes (object) or tdsExternalAttributes (object) or keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером.

Внимание! При использовании для оплаты сохраненных реквизитов карт передача параметров из вкладки dataEntryModeAttributes является обязательной.

threeDSMethodNotificationUrl
string (threeDSMethodNotificationUrl) [ 1 .. 2048 ] characters ^https?:\/\/(.*)$

URL адрес Партнера для получения уведомления о завершении вызова 3DS Method (3DS Method Notification URL)

termUrl
string (termUrl) [ 1 .. 256 ] characters ^https?:\/\/(.*)$

URL адрес Партнера для возврата после проведения 3-D Secure аутентификации Плательщика. Обязателен, если используется платёжная страница на стороне Партнера и 3DS Server Банка

bindingNotNeeded
boolean (bindingNotNeeded)

Признак отказа от создания Связки Плательщиком.

  • true = истина, создание Связки после платежа не происходит, а идентификатор Плательщика (clientId), переданный при регистрации заказа, после совершения платежа будет удалён или не будет сгенерирован автоматически;
  • false = ложь (по умолчанию), после успешного проведения платежа и выполнения ряда дополнительных условий - происходит создание Связки.

Responses

Request samples

Content type
application/json
Example
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "MDORDER": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "$PAN": "2201382000000047",
  • "$CVC": "123",
  • "YYYY": "2025",
  • "MM": "12"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "error": "Обработка запроса прошла без системных ошибок",
  • "info": "Ваш платёж обработан, происходит переадресация",
}

Проведение оплаты через мобильное приложение "Сбербанк-Онлайн" [paymentSberPay]

Запрос предназначен для выполнения оплаты посредством функционала SberPay, доступного в мобильном приложении "Сбербанк-Онлайн".

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос проведения оплаты через мобильное приложение "Сбербанк-Онлайн"

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

phone
required
string [ 1 .. 11 ] characters ^\d{7,11}$

Номер телефона Плательщика в формате 7XXXXXXXXXX.

merchantLogin
string (merchantLogin) [ 1 .. 30 ] characters ^[A-Za-z0-9-_.-]+$

Логин дочернего Партнера (если используется)

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "phone": "79011234567"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0"
}

Проведение оплаты по подписке СБП [paymentOrderBySubscription]

Запрос предназначен для выполнения оплаты по подписке СБП.

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос проведения оплаты по подписке СБП

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

subscriptionId
required
string = 32 characters ^[a-f0-9]+$

Идентификатор сохраненной подписки.

memberId
required
string = 12 characters ^\d{12}$

Идентификатор банка отправителя

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "subscriptionId": "c9403ef2f9254736a5af837238ce05b1",
  • "memberId": "100000000111"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0"
}

Сервисы для работы со связками

Методы API для создания, получения информации, активации, деактивации, проведения платежей по связкам. Внимание! Для некоторых категорий мерчантов (MCC) рекуррентные платежи по картам МИР недоступны.

Проведение оплаты по связке [paymentOrderBinding]

Запрос предназначен для совершения оплаты (блокировки средств) по ранее сохраненной связке.

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос проведения оплаты по связке

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

mdOrder
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

bindingId
required
string <uuid> (bindingId) = 36 characters ^[a-f0-9\-]+$

Идентификатор Связки, созданной ранее. Может использоваться, только если у магазина есть разрешение на работу со связками

cvc
string (cvc) = 3 characters ^\d+$

Проверочный код Карты Плательщика (обычно с обратной стороны Карты). Обязательный параметр при проведении SSL операций.

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

ip
required
string (ip) [ 1 .. 39 ] characters ^[ -~]*$

IP-адрес Плательщика

email
string (email) [ 3 .. 128 ] characters ^[ -~]+$

Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone.

fmConversionAttributes (object) or tdsDestinationNumberAttributes (object) or tdsDecoupledAttributes (object) or tdsBrowserAttributes (object) or tdsAdditionalAttributes (object) or tdsApplicationAttributes (object) or loyaltyAttributes (object) or keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером.

threeDSMethodNotificationUrl
string (threeDSMethodNotificationUrl) [ 1 .. 2048 ] characters ^https?:\/\/(.*)$

URL адрес Партнера для получения уведомления о завершении вызова 3DS Method (3DS Method Notification URL)

termUrl
string (termUrl) [ 1 .. 256 ] characters ^https?:\/\/(.*)$

URL адрес Партнера для возврата после проведения 3-D Secure аутентификации Плательщика. Обязателен, если используется платёжная страница на стороне Партнера и 3DS Server Банка

Responses

Request samples

Content type
application/json
Example
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "mdOrder": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
  • "ip": "127.0.0.1"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "error": "Обработка запроса прошла без системных ошибок",
  • "info": "Ваш платёж обработан, происходит переадресация",
}

Деактивация связки Плательщика [unbindCard]

Запрос предназначен для деактивации ранее сохраненной связки.

Request Body schema: application/json

Запрос деактивации связки Плательщика

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

bindingId
required
string <uuid> (bindingId) = 36 characters ^[a-f0-9\-]+$

Идентификатор Связки, созданной ранее. Может использоваться, только если у магазина есть разрешение на работу со связками

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
  • "language": "ru"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок"
}

Получение связок по идентификатору Плательщика [getBindings]

Запрос предназначен для получения списка связок, привязанных к конкретному идентификатору Плательщика.

Request Body schema: application/json

Запрос получения связок по идентификатору Плательщика

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

clientId
required
string (clientId) [ 1 .. 255 ] characters ^[ -~]+$

Номер (идентификатор) Плательщика в системе Партнера. Используется для реализации функционала Связок

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

showExpired
boolean (showExpired)

Признак необходимости отображать Связки с истёкшим сроком действия Карты. Возможны следующие значения:

  • true = истина;
  • false = ложь (по умолчанию).
showInactive
boolean (showInactive)

Признак необходимости отображать Связки с неактивным статусом. Возможны следующие значения:

  • true = истина;
  • false = ложь (по умолчанию).

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "clientId": "M79011234567",
  • "language": "ru",
  • "showExpired": true,
  • "showInactive": true
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок",
  • "bindings": [
    ]
}

Получение связок по номеру карты или идентификатору связки Плательщика [getBindingsByCardOrId]

Запрос предназначен для получения списка связок, привязанных к конкретному идентификатору Плательщика на основании переданной связки данного идентификатора Плательщика или полного номера карты. Для работы с полным номером карты необходимы дополнительные настройки учетной записи.

Request Body schema: application/json

Запрос получения связок по номеру карты или идентификатору связки Плательщика

One of
pan
required
string (pan) [ 13 .. 19 ] characters ^\d+$

Номер Карты Плательщика

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

showExpired
boolean (showExpired)

Признак необходимости отображать Связки с истёкшим сроком действия Карты. Возможны следующие значения:

  • true = истина;
  • false = ложь (по умолчанию).
showInactive
boolean (showInactive)

Признак необходимости отображать Связки с неактивным статусом. Возможны следующие значения:

  • true = истина;
  • false = ложь (по умолчанию).

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
  • "showExpired": true,
  • "showInactive": true
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок",
  • "bindings": [
    ]
}

Активация связки Плательщика [bindCard]

Запрос предназначен для активации ранее дективированной связки (при условии актуальности ее срока действия).

Request Body schema: application/json

Запрос активации связки Плательщика

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

bindingId
required
string <uuid> (bindingId) = 36 characters ^[a-f0-9\-]+$

Идентификатор Связки, созданной ранее. Может использоваться, только если у магазина есть разрешение на работу со связками

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
  • "language": "ru"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок"
}

Проведение периодического платежа [recurrentPayment]

Запрос предназначен для одновременной регистрации заказа и его оплаты с использованием связки. Совмещает в себе два действия register и paymentOrderBinding Внимание! Отправка фискальных чеков при использовании данного сервиса находится в разработке.

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос проведения периодического платежа

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderNumber
required
string (orderNumber) [ 1 .. 36 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Уникальный номер (идентификатор) заказа в системе Партнера. Обязателен, если в запросе отсутствует orderId.

bindingId
required
string <uuid> (bindingId) = 36 characters ^[a-f0-9\-]+$

Идентификатор Связки, созданной ранее. Может использоваться, только если у магазина есть разрешение на работу со связками

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

amount
required
integer (amount) [ 0 .. 999999999999 ]

Сумма операции в минимальных единицах валюты

currency
string (currency) = 3 characters ^\d{3}$
Default: "643"

Цифровой код валюты операции ISO-4217

description
string (description) [ 1 .. 512 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Описание заказа в свободной форме на стороне Партнера. Рекомендуемая длина до 99 символов

phone
string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$

Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email.

email
string (email) [ 3 .. 128 ] characters ^[ -~]+$

Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone.

fmConversionAttributes (object) or loyaltyAttributes (object) or keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером.

object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

Responses

Request samples

Content type
application/json
Example
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
  • "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
  • "amount": 19900
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "orderStatus": {
    }
}

Сервисы MirPay

Методы API для работы с платежами MirPay

Проведение платежа с использованием прямого взаимодействия Партнера с MirPay [paymentDirect]

Сервис проведения оплаты с использованием приложения MirPay (In-application) с интеграцией Партнера по схеме агрегатора и расшифровкой платёжных данных на стороне Партнера. Может выполняться как с предварительной регистрацией заказа (логины, сумма, идентифкатор заказа и сценарий проведения платежа в запросах должны совпадать), так и без неё

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос роведения платежа с использованием прямого взаимодействия Партнера с MirPay

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderNumber
required
string (orderNumber) [ 1 .. 36 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Уникальный номер (идентификатор) заказа в системе Партнера. Обязателен, если в запросе отсутствует orderId.

amount
required
integer (amount) [ 0 .. 999999999999 ]

Сумма операции в минимальных единицах валюты

currencyCode
string (currency) = 3 characters ^\d{3}$
Default: "643"

Цифровой код валюты операции ISO-4217

description
string (description) [ 1 .. 512 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Описание заказа в свободной форме на стороне Партнера. Рекомендуемая длина до 99 символов

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

preAuth
boolean (preAuth)

Признак предварительной авторизации. Возможны следующие значения:

  • true = истина, платёж обрабатывается по двухстадийному сценарию;
  • false = ложь (по умолчанию), платёж обрабатывается по одностадийному сценарию.
fmConversionAttributes (object) or threedsDestinationNumberAttributes (object) or dataEntryModeAttributes (object) or keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером.

clientId
string (clientId) [ 1 .. 255 ] characters ^[ -~]+$

Номер (идентификатор) Плательщика в системе Партнера. Используется для реализации функционала Связок

paymentToken
required
string <base64url> (paymentTokenDecrypted) [ 1 .. 8192 ] characters ^[ -~]*$

Закодированный в base64url JSON-объект с платёжными данными полученными и расшифрованными на стороне Партнера из JWT Payload (Claim) от MirPay. Состав JSON-объекта:

Объект Тип Обязательно Описание
tan string да Номер Токена (TAN)
cav string да/нет Authentication Value (NSPK-InApp криптограмма). Может отсутствовать для операций по сохраненным реквизитам
tey integer да Последние две цифры года срока окончания действия токена. Возможные значения: 18-99
tem integer да Порядковый номер месяца в году срока окончания действия токена. Возможные значения: 1-12
transId string да/нет Уникальный идентификатор In-App операции в формате UUID. Может отсутствовать для операций по сохраненным реквизитам
mId string да/нет Идентификатор ТСП (Merchant ID).Может отсутствовать для операций по сохраненным реквизитам
mx5c string да/нет Cертификат X.509 в Base64 открытого ключа ТСП. Может отсутствовать для операций по сохраненным реквизитам
orderId string да/нет Уникальный идентификатор заказа/транзакции на стороне ТСП. Может отсутствовать для операций по сохраненным реквизитам
sum integer да/нет Сумма платежа в минимальных единицах валюты. Должна совпадать с суммой заказа. Может отсутствовать для операций по сохраненным реквизитам
cur integer да/нет Цифровой код валюты по ISO 4217. Может отсутствовать для операций по сохраненным реквизитам
media string да/нет Тип источника, через который инициирована In-App операция. ISDK = In-Application SDK, DL = Deep link, UL = Universal link, TR = In-Application Mir HCE SDK
merchant
string (merchantLogin) [ 1 .. 30 ] characters ^[A-Za-z0-9-_.-]+$

Логин дочернего Партнера (если используется)

features
string (featuresVerify) [ 1 .. 255 ] characters ^[ -~]*$

Дополнительные параметры управления сценариями при использовании платёжных реквизитов:

  • VERIFY = Происходит верификация Плательщика без списания средств с его счёта, поэтому в запросе можно передавать нулевую сумму. Даже если сумма платежа будет передана в запросе, она не будет списана со счёта покупателя. После успешной верификации заказ сразу переводится в статус REVERSED (отменён);
object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

phone
string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$

Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email.

email
string (email) [ 3 .. 128 ] characters ^[ -~]+$

Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone.

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "amount": 10000,
  • "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
  • "paymentToken": "eyJ0YW4iOiIyMjAwMTIqKioqKioqKiozNDg2IiwiY2F2IjoiM0Q2RkM4MjZBMDhDODJCODk3ODAwMjlGNjk2NzBGRERDRjI5OUIiLCJ0ZXkiOjI5LCJ0ZW0iOjMsInRyYW5zSWQiOiI1YWI1MjQ4Ny0xNzdmLTQ2NGItYjY5NS0yOTU0ZmZjNDRhMTMiLCJtSWQiOiIwMDAwMDAwMDAwMDAwMDEiLCJteDVjIjoiTUlJRWpEQ0NBM1NnQXdJQkFnSURFaUVETUEwR0NTcUdTSWIzRFFFQkN3VUFNSUdGTVFzd0NRWURWUVFHRXdKU1ZURVpNQmNHQTFVRUNBd1FVMkZwYm5RdFVHVjBaWEp6WW5WeVp6RVhNQlVHQTFVRUNnd09WbTlrYTJFZ1FtRnVheUJLVTBNeER6QU5CZ05WQkFzTUJrSXdNREF3TVRFUE1BMEdBMVVFQXd3R1FqQXdNREF4TVNBd0hnWUpLb1pJaHZjTkFRa0JGaEY2YjNKeWIwQmxhMkZ6YzJseUxtTnZiVEFlRncweU1qRXhNRGt4TXpNMU5UTmFGdzB5TXpFeE1Ua3hNek0xTlROYU1JRzNNUXN3Q1FZRFZRUUdFd0pTVlRFWk1CY0dBMVVFQ0F3UVUyRnBiblF0VUdWMFpYSnpZblZ5WnpFWk1CY0dBMVVFQnd3UVUyRnBiblF0VUdWMFpYSnpZblZ5WnpFYU1CZ0dBMVVFQ2d3UlVHRnlZWE5sYm1ObElFeHBiV2wwWldReEdUQVhCZ05WQkFzTUVFMHdNREF3TURBd01EQXdNREF3TURFeEdUQVhCZ05WQkFNTUVFMHdNREF3TURBd01EQXdNREF3TURFeElEQWVCZ2txaGtpRzl3MEJDUUVXRVhwdmNuSnZRR1ZyWVhOemFYSXVZMjl0TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF1TzFteGU2Mk5kVzdLTTUwRlZ3Y29qNDVRSjNYVms4QWg2UkN4Q1IzdHZydXM3bm9OV2FLajljM2VEeDQ3V3N3MFZROUpiUVRPdFRqaSsrRFkwOEJ2WGtWK1J1SXNlekdnVzR4S1RJK3lwSGN4OHZJSU5oS0JLMmZZdTVJRFZkejRaYml1R3IySW13eHVPL3VYRW5iNXhDTS9wK01tTDBwZmpjaE9LWkZMVW1Xdm44clMxUGc5NzRRSjJiODl0TDlKSmR3K3NhMDlXWkpoQWZGYVNaRk9LM0dwQkc5azVmZEhvTXNKY2RJRmxOMzFIMFF2OFMvOEZVbGdqVVFCdW9TbmdneXJ6aUR6RXFWM1BIcXcwZURjOTc5WE1hYTZvWFJLYk1UaXFrR01qN0h4N2dVanFzRStPZ29EcFdDSlpWVGMzNWkrajJGTEVpRDZ4NHpBR2FjZndJREFRQUJvNEhRTUlITk1Ba0dBMVVkRXdRQ01BQXdFUVlKWUlaSUFZYjRRZ0VCQkFRREFnV2dNRE1HQ1dDR1NBR0crRUlCRFFRbUZpUlBjR1Z1VTFOTUlFZGxibVZ5WVhSbFpDQkRiR2xsYm5RZ1EyVnlkR2xtYVdOaGRHVXdIUVlEVlIwT0JCWUVGQnRrWDUvemNnSlpSYitHZUpKYUVZZytWVE9UTUI4R0ExVWRJd1FZTUJhQUZMWE9JclFpZHNuZ0J4cXhBQ3FtbURmajJTM0tNQTRHQTFVZER3RUIvd1FFQXdJRThEQWRCZ05WSFNVRUZqQVVCZ2dyQmdFRkJRY0RBZ1lJS3dZQkJRVUhBd1F3Q1FZRFZSMFNCQUl3QURBTkJna3Foa2lHOXcwQkFRc0ZBQU9DQVFFQU1EN3FITEVKakdEcyt2ZEQwTklKWnhzVVpITjBXVTdPMm83TUxkVE96bkRqQ0RaV0thNzBHQlRsUm5vNTU2ejQ0a2VxajVWWnRIOVhWZ1A0U3pwOEMyZnppT0F1alNyS1Z3MGxoN2lEUmNiMU9ESEx5U0IzMDRHOXpnZE0rRFBLeW9za3pxcC9KNGl5VWFGLzZyNVlqLzVxVmZ0d0xSQlRJbld0OGgycFdxU29aaE5xaFY1SmRVK1dtQ0Nzd0RLZzQzSTJTSC9sUHZVaXFkRFFYK2xscDZYVHVJNm83aUdQRmRQZ2tOWFVOVUVIL3NNTUNOU2xOQmNQUFhGeSs1SHhFYkFmS242WmJZN2xYTDZSbzJuSzRERFJSbENYMGJmT1BKWFBMK290dncrVXZuSXIyOGNpc0VTdzB5OWxYbTlOWmhhQnhEVEZWREFSTWZUT1lxdFJDdz09Iiwib3JkZXJJZCI6IjEyMzQ1NiIsInN1bSI6MTAwMDAsImN1ciI6NjQzLCJtZWRpYSI6IklTREsifQ"
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "data": {
    },
  • "orderStatus": {
    }
}

Сервисы 3-D Secure

Методы API для завершения 3-D Secure аутентификаций, прововдимых на стороне Партнера

Завершение 3DS Method [finish3dsMethod]

Запрос предназначен для завершения 3DS аутентификации Плательщика при проведении операции оплаты. Последовательность обработки запроса:

  • создать заказ через сервисы register или registerPreAuth, в зависимости от сценария платежа;
  • провести оплату через сервисы, указанные в paymentOrder или paymentOrderBinding с получением в ответе требований проведения 3DS Method (threeDSMethodURL). Значение threeDSMethodData возвращается, если в запросе был передан threeDSMethodNotificationUrl, в противном случае Партнер самостоятельно формирует объект threeDSMethodData= base64url({"threeDSServerTransID":"value","threeDSMethodNotificationURL":"value"});
  • визуализировать скрытый iframe в браузере Плательщика с отправкой HTML формы с threeDSMethodData через HTTP POST на threeDSMethodURL;
  • получить обратный вызов на threeDSMethodNotificationURL по результату обработки запроса 3DS Method с получением threeDSMethodData = base64url({"threeDSServerTransID":"value"} в течение таймаута 10 секунд;
  • вызвать сервис завершения 3DS аутентификации finish3dsMethod.
header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос завершения 3DS Method

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

mdOrder
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

threeDSServerTransId
required
string (threeDSServerTransId) [ 1 .. 36 ] characters ^[ -~]*$

Идентификатор 3DS Server Transaction ID

threeDSCompInd
required
string (threeDSCompInd) <= 1 characters
Enum: "Y" "N"

Статус завершения вызова 3DS Method:

  • Y = завершен успешно (получен 3DS Method Notification)
  • N = не завершен успешно (3DS Method Notification не получен в течение таймаута 10 сек)

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "mdOrder": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "threeDSServerTransId": "93045e61-d783-40f1-8934-33fd59387ca6",
  • "threeDSCompInd": "Y"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок",
  • "info": "Ваш платёж обработан, происходит переадресация",
}

Завершение аутентификации 3-D Secure [finish3dsPayment]

Запрос предназначен для передачи результата 3DS аутентификации Плательщиа при прямом взаимодействии с сервером ACS. Последовательность обрабтки запроса:

  • создать заказ через сервисы, указанные в register или registerPreAuth, в зависимости от сценария платежа;
  • провести оплату через сервисы, указанные в paymentOrder, paymentOrderBinding или finish3dsMethod с получением в ответе требований проведения 3-D Secure аутентификации (paReq или cReq);
  • перенаправить Плательщика на ACS по адресу, указанному в параметре acsUrl;
  • получить обратное перенаправление Плательщика в магазин от ACS с сообщением PARes или CRes на адрес termUrl;
  • вызвать сервис завершения 3DS аутентификации finish3dsPayment.
header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос завершения аутентификация 3-D Secure

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

mdOrder
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

paRes
string (paRes) [ 1 .. 8192 ] characters ^[ -~]*$

Сообщение Payer Authentication Response, полученное в ответе на запрос аутентификации Плательщика. Обязательно при использовании версии 3-D Secure 1.0.2

cRes
string (cRes) [ 1 .. 4096 ] characters ^[ -~]*$

Сообщение Challenge Response, полученное в ответе на запрос проведения Challenge с Плательщиком. Обязательно при использовании версии 3-D Secure 2.х.х

Responses

Request samples

Content type
application/json
Example
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "mdOrder": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "cRes": "eyJhY3NUcmFuc0lEIjogIjllNWUxMWViLTY1OTYtNDMyMi04NjU4LTJkNDY0MDUwMGYyZSIsICJ0cmFuc1N0YXR1cyI6ICJZIiwgIm1lc3NhZ2VWZXJzaW9uIjogIjIuMS4wIiwgIm1lc3NhZ2VUeXBlIjogIkNSZXMiLCAidGhyZWVEU1NlcnZlclRyYW5zSUQiOiAiOTMwNDVlNjEtZDc4My00MGYxLTg5MzQtMzNmZDU5Mzg3Y2E2In0="
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок",
  • "info": "Ваш платёж обработан, происходит переадресация",
}

Callback-уведомления

Методы API для отправки уведомлений по операциям и событиям по связкам

Уведомление о проведении платежа [callback]

Функционал предназначен для отправки callback уведомления при изменении статуса заказа. Callback уведомление представляет собой POST запрос, направляемый со стороны платежного шлюза на URL, указанный в настройках учетной записи. Осуществляется 3 попытки доставки уведомления с интервалом 60 секунд между попытками

Request Body schema: application/json

Запрос уведомления о проведении платежа

mdOrder
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

orderNumber
required
string (orderNumber) [ 1 .. 36 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Уникальный номер (идентификатор) заказа в системе Партнера. Обязателен, если в запросе отсутствует orderId.

operation
required
string (orderOperation) [ 1 .. 20 ] characters ^[A-Za-z0-9]*$

Тип операции, о которой формируется уведомление. Возможны следующие значения:

  • created = заказ создан;
  • approved = операция удержания (холдирования) суммы;
  • deposited = операция завершения;
  • reversed = операция отмены;
  • refunded = операция возврата;
  • declinedByTimeout = истекло время, отведенное на оплату заказа;
  • subscriptionCreated = подписка была создана Плательщиком.
status
required
integer (status) [ 0 .. 1 ]

Индикатор успешности операции о которой формируется уведомление. Возможны следующие значения:

  • 1 = операция прошла успешно;
  • 0 = операция завершилась ошибкой;
object (additionalParams)

Дополнительные параметры операции. Используется также при создании подписки СБП.

Responses

Request samples

Content type
application/json
{
  • "mdOrder": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
  • "operation": "deposited",
  • "status": 1,
  • "additionalParams": { }
}

Уведомление о событии со связкой [bindingCallback]

Функционал предназначен для отправки callback уведомления при изменении статуса связки. Callback уведомление представляет собой POST запрос, направляемый со стороны платежного шлюза на URL, указанный в настройках учетной записи. На текущий момент сервис отправки уведомлений доступен только для связок, созданных при проведении платежей через мобильное приложение "Сбербанк-Онлайн". Осуществляется 3 попытки доставки уведомления с интервалом 60 секунд между попытками

Request Body schema: application/json

Запрос уведомления о событии со связкой

bindingId
required
string <uuid> (bindingId) = 36 characters ^[a-f0-9\-]+$

Идентификатор Связки, созданной ранее. Может использоваться, только если у магазина есть разрешение на работу со связками

clientId
required
string (clientId) [ 1 .. 255 ] characters ^[ -~]+$

Номер (идентификатор) Плательщика в системе Партнера. Используется для реализации функционала Связок

operation
required
string (bindingOperation) [ 1 .. 20 ] characters ^[A-Za-z0-9]*$

Тип операции, о которой формируется уведомление. Возможны следующие значения:

  • bindingCreated = данные связки были изменены Плательщиком.
  • bindingDeactivated = связка была деактивирована Плательщиком.

Responses

Request samples

Content type
application/json
{
  • "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
  • "clientId": "M79011234567",
  • "operation": "bindingCreated"
}

Сервисы переводов

Методы API для осуществления переводов на карту

Сервис регистрации заказа на перевод [registerP2P]

Запрос предназначен для регистрации (создания) заказа на перевод в Шлюзе. При успешной обработке запроса заказу присваивается номер (идентификатор), уникальный в рамках Шлюза. Метод используется для регистрации заказа с последующией оплатой сервисом performP2P

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос регистрации заказа на перевод

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderNumber
required
string (orderNumber) [ 1 .. 36 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Уникальный номер (идентификатор) заказа в системе Партнера. Обязателен, если в запросе отсутствует orderId.

amount
required
integer (amount) [ 0 .. 999999999999 ]

Сумма операции в минимальных единицах валюты

currency
string (currency) = 3 characters ^\d{3}$
Default: "643"

Цифровой код валюты операции ISO-4217

returnUrl
required
string (returnUrl) [ 12 .. 2048 ] characters ^(http://|https://).*$

Адрес, на который требуется перенаправить Плательщика в случае успешной оплаты, когда Партнер использует платёжную страницу ПШ

Обратите внимание!

  1. Если доменное имя содержит кирилические символы, то его необходимо преобразовать по алгоритму ACE. Т.е. строка "сберпей.рф" будет выглядеть как "xn--90aiaq2afe.xn--p1ai"
  2. Если query параметр содержит символ % - считается, что к данному параметру уже применено экранирование и преобразование не осуществляется (параметр остается "как есть")
  3. Если query параметр содержит символы, отличные от множества [a-zA-Z0-9.-*_ ], эти символы экранируются через символ %. Строка вида "сберпей.рф" будет выглядеть как "%D1%81%D0%B1%D0%B5%D1%80%D0%BF%D0%B5%D0%B9%2E%D1%80%D1%84"
features
required
string (featuresP2P) [ 1 .. 255 ] characters ^[ -~]*$

Тип перевода. Доступные значения:

  • ORIGINAL_CREDIT - выплата B2C (Перевод средств на карту/токен)

Параметр обязателен для данного сервиса.

failUrl
string (failUrl) [ 12 .. 2048 ] characters ^(http://|https://).*$

Адрес, на который требуется перенаправить Плательщика в случае неуспешной оплаты, когда Партнер использует платёжную страницу ПШ. Если не указан, используется returnUrl

Обратите внимание!

  1. Если доменное имя содержит кирилические символы, то его необходимо преобразовать по алгоритму ACE. Т.е. строка "сберпей.рф" будет выглядеть как "xn--90aiaq2afe.xn--p1ai"
  2. Если query параметр содержит символ % - считается, что к данному параметру уже применено экранирование и преобразование не осуществляется (параметр остается "как есть")
  3. Если query параметр содержит символы, отличные от множества [a-zA-Z0-9.-*_ ], эти символы экранируются через символ %. Строка вида "сберпей.рф" будет выглядеть как "%D1%81%D0%B1%D0%B5%D1%80%D0%BF%D0%B5%D0%B9%2E%D1%80%D1%84"
description
string (description) [ 1 .. 512 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Описание заказа в свободной форме на стороне Партнера. Рекомендуемая длина до 99 символов

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

merchantLogin
string (merchantLogin) [ 1 .. 30 ] characters ^[A-Za-z0-9-_.-]+$

Логин дочернего Партнера (если используется)

required
object <= 99 properties

Блок для передачи дополнительных параметров Партнером. В случае, если значения параметров предполагают содержание персональных данных физического лица, необходимо получение согласия на обработку персональных данных Плательщика. Уведомление Платежного шлюза о наличии такого согласия осуществляется передачей параметра pdAgreement со значением true в блоке jsonParams

sessionTimeoutSecs
integer (sessionTimeoutSecs) [ 0 .. 999999999 ]
Default: 1200

Продолжительность жизни заказа в секундах. В случае если параметр не задан, будет использовано значение, указанное в настройках Партнера или время по умолчанию (20 минут). Если в запросе присутствует параметр expirationDate, то значение параметра sessionTimeoutSecs не учитывается

expirationDate
string <date-time> (expirationDate)

Дата и время окончания жизни заказа на стороне ПШ в формате yyyy-MM-ddTHH:mm:ss. Если этот параметр не передаётся в запросе, то для определения времени окончания жизни заказа используется sessionTimeoutSecs

phone
string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$

Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email.

email
required
string (email) [ 3 .. 128 ] characters ^[ -~]+$

Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone.

dynamicCallbackUrl
string (dynamicCallbackUrl) [ 12 .. 512 ] characters ^(https://).*$

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

Обратите внимание!

  1. Если доменное имя содержит кирилические символы, то его необходимо преобразовать по алгоритму ACE. Т.е. строка "сберпей.рф" будет выглядеть как "xn--90aiaq2afe.xn--p1ai"
  2. Если query параметр содержит символ % - считается, что к данному параметру уже применено экранирование и преобразование не осуществляется (параметр остается "как есть")
  3. Если query параметр содержит символы, отличные от множества [a-zA-Z0-9.-*_ ], эти символы экранируются через символ %. Строка вида "сберпей.рф" будет выглядеть как "%D1%81%D0%B1%D0%B5%D1%80%D0%BF%D0%B5%D0%B9%2E%D1%80%D1%84"

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
  • "amount": 19900,
  • "features": "ORIGINAL_CREDIT"
}

Response samples

Content type
application/json
Example
{}

Сервис проведения перевода [performP2P]

Запрос предназначен для проведения перевода средств по ранее созданному заказу на перевод

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос проведения перевода по заказу

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером.

email
string (email) [ 3 .. 128 ] characters ^[ -~]+$

Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone.

phone
string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$

Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email.

object

Блок для передачи параметров с реквизитами о зачисление на карту

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "toCard": {
    }
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "error": "Обработка запроса прошла без системных ошибок",
  • "info": "Ваш платёж обработан, происходит переадресация",
}

Сервисы фискализации

Методы API для формирования чеков

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

Получение информации о результате обработки чека [getReceiptStatus]

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

Request Body schema: application/json

Запрос статуса обработки чека. При передаче orderId или orderNumber отражаются все сформированные чеки по Заказу, при передаче receiptId - конкретный чек. Дополнительно доступен поиск по статусу чека. Рекомендуем запрашивать статус чека не ранее чем через 6 минут после проведения операции.

One of
receiptId
required
string <uuid> (receiptId) = 36 characters ^[a-f0-9\-]+$

Идентификатор чека, присвоенный кассовым сервисом (uuid)

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

receiptStatus
integer (receiptStatus) [ 0 .. 6 ]

Статус чека

  • 0 - не определен;
  • 1 - ожидается отправка или переотправка чека
  • 2 - чек отправлен, ожидание результата обработки
  • 3 - чек обработан успешно
  • 4 - ошибка обработки чека
  • 5 - ошибка отправки чека (исчерпаны попытки отправки)
  • 6 - некорректные данные для отправки чека

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}

Response samples

Content type
application/json
Example
{
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
  • "receipts": [
    ]
}

Переотправка чека без изменения Корзины [retryReceipt]

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

  • Запросить статус чека через getReceiptStatus.
  • Получить один из двух статусов, при котором возможна переотправка: Ошибка обработки чека (receiptStatus=4) или Ошибка отправки чека (исчерпаны попытки отправки) (receiptStatus=5).
  • Использовать retryReceipt с включением receiptId/externalId чека, который нужно переотправить. Возможна отправка массива receiptId/externalId, если необходимо переотправить несколько чеков. Внимание! В случае, если в ответе на результат обработки чека отсутствует receiptId/externalId, использование сервиса retryReceipt невозможно. Обратитесь в техническую поддержку для получения рекомендаций.
  • На этапе получения статуса регистрации, при получении кода ошибки 1 с типом ошибки “timeout” происходит несколько автоматических попыток повторной регистрации чека. В связи с этим рекомендуется использовать сервис retryReceipt после исчерпания всех попыток регистрации, не ранее 15 часов после создания начального чека.
  • При использовании сервиса обратите внимание на сроки предоставления чека согласно 54-ФЗ.
Request Body schema: application/json

Запрос переотправки чека.

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

receiptIds
Array of strings <uuid> (receiptId) <= 100 items [ items <uuid > = 36 characters ^[a-f0-9\-]+$ ]
externalIds
Array of strings (externalId) <= 100 items [ items <= 60 characters ^[a-f0-9_\\-]+$ ]

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "receiptIds": [
    ],
  • "externalIds": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Успешно",
  • "retryResult": [
    ]
}

Создание чека [doReceipt]

Сервис позволяет сформировать новый чек или изменить корзину в неуспешном чеке с использованием новой Корзины для повторной переотправки.

Создание нового чека

Сервис doReceipt используется для создания чека полного расчета, чека возврата предоплаты или аванса на холдирование отдельно от финансовой операции. Если ранее был создан чек на Предоплату или Аванс, рекомендуется перед формированием чека полного расчета убедиться в успешном создании чека Предоплаты через getReceiptStatus. Дополнительно возможно использование сервиса в случаях, если фискализация не была настроена в системах Банка или партнера, в связи с чем попыток создания чека не осуществлялось. Для создания чека необходимо передать контакт Покупателя email/phone и Корзину orderBundle. Если ранее был создан чек на Предоплату или Аванс, рекомендуется перед формированием чека полного расчета убедиться в успешном создании чека Предоплаты через getReceiptStatus.

Переотправка неуспешного чека с новой Корзиной

В некоторых случаях кассовый сервис не может зарегистрировать чек из-за некорректных данных в Корзине, ошибок в работе ККТ или по иным причинам. Сервис запроса статуса getReceiptStatus сообщит об этом в блоке error, предоставив код и описание ошибки. Поле recommendation позволяет определить, есть ли необходимость в корректировке корзины и повторной отправке чека. Для попытки переотправки чека с новой корзиной необходимо:

  • Запросить статус чека через getReceiptStatus;
  • Получить статус Ошибка обработки чека (receiptStatus=4) или Попытки отправки чека исчерпаны (receiptStatus=5) со значением recommendation 2 или 3;
  • Изучить текст ошибки, внести изменения в запрос;
  • Отправить запрос doReceipt с указанием receiptid исправляемого чека и контактами Покупателя email/phone.

Указание receiptId для исправления чека рекомендуется в целях корректного отражения чеков в СберБизнес.

Request Body schema: application/json

Запрос создания чека

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

orderNumber
string (orderNumber) [ 1 .. 36 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_№]*$

Уникальный номер (идентификатор) заказа в системе Партнера. Обязателен, если в запросе отсутствует orderId.

receiptId
string <uuid> (receiptId) = 36 characters ^[a-f0-9\-]+$

Идентификатор чека, присвоенный кассовым сервисом (uuid)

phone
string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$

Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email.

email
string (email) [ 3 .. 128 ] characters ^[ -~]+$

Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone.

required
object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "email": "customer@testmail.ru",
  • "orderBundle": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Успешно",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}

Чеки коррекции [doCorrection]

Функционал находится в разработке

Сервис позволяет формировать чеки коррекции. Поддерживается кассовыми сервисами Цифровая касса Эвотор, АТОЛ Онлайн, Ferma OFD.RU

Общие правила работы с сервисом:

В сервис необходимо передать корзину с receiptType желаемого чека коррекции. Например, для исправления чека с типом «Приход» необходимо передать "receiptType": "sell_correction", «Возврат прихода» - "receiptType": "sell_refund_correction". В связи с особенностью корректировки чеков в ФФД 1.05 типы создаваемых чеков автоматически будут определены как "sell" и "sell_refund". При наличии receiptId в запросе, система автоматически найдет и сформирует обратный чек, включив в него ФП (фискальный признак) некорректного чека в теге 1192, и, при необходимости, блок correctionInfo. В запрос необходимо всегда включать correctionInfo, за исключением исправления существующего чека при работе с ФФД 1.05.

Доступно 2 режима формирования чеков коррекции:

  • для исправления ошибки в существующем чеке (успешно зарегистрированном в кассовом сервисе),
  • для создания чека коррекции в случаях, когда фискальный чек не сформировался по каким то причинам (не были указаны настройки кассы, ошибки в формате запросов, массовом сбое и т.д.)

Создание нового чека коррекции:

  1. В сервисе doCorrection передать корзину с с receiptType желаемого чека коррекции, и блок correctionInfo.
  2. Будет создан чек коррекции на основании запроса doCorrection с указанном в нем receiptType;
  3. В случае, если у чека есть receiptId, но он неуспешен, для его исправления не нужно передавать receiptId.

Исправление успешно зарегистрированного чека:

  1. В сервисе doCorrection передать корзину, receiptId корректируемого чека, блок correctionInfo. Блок не нужно передавать в ФФД 1.05.
  2. Предполагается передача receiptId только успешного чека. Для исправления незарегистрированного чека в сервис doReceipt передавать receiptId не нужно.
  3. Для отмены некорректного чека будет автоматически сформирован обратный чек с включением в него ФД некорректного чека.
  4. Чек коррекции будет создан на основании переданного receiptType в doCorrection.
Request Body schema: application/json

Запрос создания чека коррекции

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

receiptId
string <uuid> (receiptId) = 36 characters ^[a-f0-9\-]+$

Идентификатор чека, присвоенный кассовым сервисом (uuid)

phone
string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$

Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email.

email
string (email) [ 3 .. 128 ] characters ^[ -~]+$

Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone.

required
object (correctionInfo)

Информация о коррекции. Не передается в случае исправления существующего чека в ФФД 1.05.

required
object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

Responses

Request samples

Content type
application/json
Example
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "correctionInfo": {
    },
  • "email": "customer@testmail.ru",
  • "orderBundle": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Успешно",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}

Сервисы программы лояльности СберСпасибо

Внимание! Функционал находится в разработке.

Методы API для работы с программой лояльности СберСпасибо

Внимание!В случае если на Ваших витринах используется SberPay SDK In-App то требуется скорректировать использование библиотеки в соответствии с документацией:

Получение баланса бонусов СберСпасибо [getLoyaltyBalance]

Запрос для получения бонусного баланса по связке Плательщика

Request Body schema: application/json

Запрос для получения бонусного баланса по идентификатору связки Плательщика. Для работы с данным сервисом необходимы дополнительные настройки учетной записи.

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

bindingId
required
string <uuid> (bindingId) = 36 characters ^[a-f0-9\-]+$

Идентификатор Связки, созданной ранее. Может использоваться, только если у магазина есть разрешение на работу со связками

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce"
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок",
  • "loyaltyOperations": [
    ]
}

Завершение двухстадийного сценария [autoCompletion]

Запрос предназначен для выполнения дополнительного подтверждения оплаты двухстадийного платежа. При успешной обработке подтверждается списание средств со счета Плательщика.

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос завершения двухстадийного сценария

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

compositeAmount
required
integer (compositeAmount) [ 0 .. 999999999999 ]

Сумма операции в минимальных единицах валюты, состоящая из суммы в деньгах и суммы бонусов. Может быть меньше или равна остатку в заказе

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "compositeAmount": 14900,
  • "orderBundle": {
    }
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок"
}

Возврат средств Плательщика [autoRefund]

Запрос предназначен для выполнения частичного или полного возврата средств Плательщика, после выполнения взаиморасчетов банков-участников по операции оплаты.

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос возврата средств Плательщика

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

compositeAmount
required
integer (compositeAmount) [ 0 .. 999999999999 ]

Сумма операции в минимальных единицах валюты, состоящая из суммы в деньгах и суммы бонусов. Может быть меньше или равна остатку в заказе

language
string (language) = 2 characters ^[a-z]+$
Default: "ru"

Язык в кодировке ISO 639-1 (ru). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера

externalRefundId (object) or keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером.

object (orderBundle)

Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "compositeAmount": 9900,
  • "orderBundle": {
    }
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок"
}

Сервисы для работы с ЭС

Методы API для взаимодействия при оплате электронными сертификатами

Передача данных чека [externalReceipt]

Запрос предназначен для передачи данных фискального чека покупки или возврата для завершения операции с участием средств электронных сертфикатов.

header Parameters
x-idempotencyKey
string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$
Example: 779165e0-1905-4edd-89fa-be46497b5044

Функционал обработки ключа идемпотентности находится в разработке

Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа.

Request Body schema: application/json

Запрос на передачу данных фискального чека

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

orderId
required
string <uuid> (orderId) = 36 characters ^[a-f0-9\-]+$

Уникальный номер заказа в Платёжном шлюзе.

eCertificateBasketId
required
string (eCertificateBasketId) = 24 characters ^[ -~]*$

Идентификатор корзины Basket ID покупки или возврата в ФЭС НСПК

cashboxId
required
string (cashboxId) = 18 characters ^[ -~]*$

Идентификатор кассы в ФЭС НСПК

required
object

Блок инфомрации с параметрами фискального чека

keyValue (object) <= 99 properties

Блок для передачи дополнительных параметров Партнером.

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
  • "eCertificateBasketId": "422100010001100000000108",
  • "cashboxId": "200000000000000011",
  • "receipt": {
    }
}

Response samples

Content type
application/json
Example
{
  • "errorCode": "0",
  • "errorMessage": "Обработка запроса прошла без системных ошибок"
}

Сервисы работы с учетной записью

Методы установки постоянного пароля и генерации apikey

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

Установка постоянного пароля [setPermanentPassword]

Сервис для смены временного пароля на постоянный

Request Body schema: application/json

Запрос предназначен для изменение временного пароля, выданного при регистрации Партнера на ПШ на постоянный пароль на стороне Партнера.

login
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

tmpPassword
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

password
string [ 18 .. 30 ] characters ^[A-Za-z0-9]+$

Постоянный пароль для Партнера. Если не передавать, то пароль будет сгенерирован автоматически. Требования к паролю: 1 цифра, 1 заглавная латинская буква, минимальная длина 18 символов

Responses

Request samples

Content type
application/json
{
  • "login": "testUserName",
  • "tmpPassword": "testPassword",
  • "password": "NewPassword"
}

Response samples

Content type
application/json
Example
{
  • "login:": "testUserName",
  • "password": "NewPassword"
}

Генерация ключа Партнера для работы с сервисами платежного шлюза через SDK [generateApiKey].

Сервис для генерации ключа Партнера для работы с сервисами платежного шлюза через SDK. Может быть создано не более 5 активных ключей. Внимание! При генерации ключа необходимо использовать ТОЛЬКО логины, полученные от технической поддержки.

Request Body schema: application/json

Запрос предназначен для генерации ключа Партнера для работы с сервисами платежного шлюза через SDK.

userName
required
string (userName) [ 1 .. 30 ] characters ^[A-Za-z0-9-_-]+$

Логин Партнера, полученный при подключении к ПШ

password
required
string (password) [ 1 .. 36 ] characters ^[ -~]+$

Пароль Партнера, полученный при подключении к ПШ

description
string [ 0 .. 1000 ] characters ^[ -~А-Яа-яЁёA-Za-z0-9-_]*$

Краткое обоснование создания api-key

merchantLogin
string [ 1 .. 30 ] characters ^[A-Za-z0-9-_. ]+$

Логин дочернего Партнера (если используется).

Внимание!

  • в случае если поле останется пустым, то api-key будет сгенерирован для merchantLogin = userName
  • при указании merchantLogin нужно руководствоваться только информацией, полученной от сопровождения шлюза электронной коммерции, при указании иных данных платежные операции для данного api-key осуществляться не будут.

Responses

Request samples

Content type
application/json
{
  • "userName": "testUserName",
  • "password": "testPassword",
  • "description": "testDescription",
  • "merchantLogin": "merchantLogin"
}

Response samples

Content type
application/json
Example
{
  • "id": "2f852119-0rhfdd-сe7a-b421-22be01a44311",
  • "apikey": "AC+FIRkBJk56sCFSvgGkQzMAAAAAAbqrr3ybcZc/7i33plZ0IWbgQ/MaADTsnGBy+TsRUImIs0EaJyQe1ObbTLgsbOQ63TWysFwWduamtmO ",
  • "message": "Api-key успешно создан"
}