Download OpenAPI specification:Download
Настоящий документ описывает программные интерфейсы платёжного шлюза Сбербанка, который позволяет проводить платежи в интернет-эквайринге.
По вопросам работы с 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 |
Внимание! Для корректного взаимодействия со шлюзом необходимо установить сертификат НУЦ Минцифры.
Внимание! На тестовом контуре предусмотрены технические окна: в будние дни зарезервированы временные интервалы 02:00 - 06:00, 09:00 - 10:00 и 18:00 - 20:00 (время Московское) в течение которых могут осуществляться работы по внедрению функционала на тестовый стенд. Стабильность работоспособности контура в это время не гарантируется.
Тестовая среда: https://ecomtest.sberbank.ru/...(полная ссылка для конкретного сервиса указана в примерах)
Боевая среда: https://epay.sberbank.ru/...(полная ссылка для конкретного сервиса указана в примерах)
Внимание! Не допускается присвоение значения "null" параметрам! Если параметр принимает значение "null", его необходимо полностью исключить из тела запроса.
В зависимости от целей и потребностей Партнер может использовать сценарии, предоставленные в текущем разделе, для проведения платежей следующих типов:
При использовании сценария с Предавторизацией рекомендуется инициировать проведение расчетов в течение 7 календарных дней.
Общий алгоритм проведения оплаты по связке.
Сценарий разбит на два этапа:
Ниже приведено краткое описание алгоритма создания связки.
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. Отмена требуется для предотвращения фактического списания средств в случае использования технической операции для привязки карты.
Создание связки завершено.
Ниже приведено краткое описание алгоритма проведения оплаты с использованием имеющейся связки.
Доступно несколько путей оплаты, инициатором которой может выступать как Плательщик, так и Партнер.
Способ 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. Партнеру направляется результат авторизации.
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-канале. Применяются 2 схемы реализации платежного функционала:
SDK – Это набор средств для разработки, благодаря которым можно легко интегрировать SberPay в мобильное приложение партнера и улучшить клиентский опыт.
Преимущества SDK InApp: • Отсутствует потребность в доработках внедренного метода. Доработки и поддержку поверхности SDK InApp производит Банк; • Повышает конверсию в оплату. На поверхности SDK InApp доступны все карты Сбера, отображается баланс и дополнительные финансовые сервисы Сбера; • Продвинутый клиентский опыт. Минимальный клиентский путь. Поддержка длительной авторизации по куки. Не уводим клиентов с поверхности Партнера. Качественный UX/UI платежной поверхности; • Санкции не влияют на стабильность работы SDK InApp.
Материалы для разработчиков доступны по ссылке
Устаревший функционал SberPay позволяющий интегрировать SberPay в приложение партнера. Оплата подтверждается и производится в приложении Сбера посредством диплинка встраиваемого в кнопку оплаты со SberPay
SberPay поддерживает свой функционал оплаты на десктопных и мобильных WEB-сайтах.
WEB SDK позволяет интегрировать с веб-сайтом партнера нативную платежную поверхность SberPay. Это техническое решение является передовым клиентским опытов в SberPay и обладает преимуществами:
Материалы для разработчиков доступны по ссылке
Альтернативный платежный опыт нативной оплаты на WEB поверхностях без использования платежной страницы. Функционал оплаты реализован по двум сценариям:
Платежная страница СберБанка по умолчанию устанавливается при подключении эквайринга СБЕРа. У партнера есть возможность подключить еще и оплату через SberPay на поверхности платежной страницы. Это простой и удобный способ совершать онлайн-покупки. Клиенту достаточно нажать на кнопку оплаты со SberPay и отсканировать QR-код (или выбрать оплату по номеру телефона). Завершение оплаты производится в приложении СберБанка где клиенту доступна возможность выбрать любую карту из имеющихся. Вам не потребуется никаких доработок, если у вас подключен эквайринг СберБанка. Оставить заявку на подключение SberPay вы можете на сайте
Обратите внимание! Работа с функционалом оплаты с помощью SberPay доступна в рамках сервисов, описанных в документации, но может быть интегрирована Партнером отдельно от других способов оплаты. При работе с функционалом SberPay использование блока "sberbankOnlineAttributes" в теле запроса в jsonParams является обязательным при регистрации заказа в сервисах register/registerPreAuth.
При интеграции сценария mweb2app на устройствах apple необходимо реализовывать процедуру перебора диплинков. Это связано с различными версиями приложений, установленных на устройствах пользователей. Подробная инструкция по реализации процедуры доступна в документе.
Дополнительно ознакомиться с процедурой тестирования SberPay можно в документации.
Описание требований к клиентскому опыту при реализации функционала SberPay в приложенном документе.
Описание интеграции функционала SberPay в приложенном документе.
Руководство по логотипам для SberbankOnline в приложенном документе.
Обработка операций и ответы Шлюза соответствуют описанию, размещенному в разделах Описание кодов ответа Шлюза и Описание кодов ошибок Шлюза.
Пример оплаты с использованием SDK SberPay можно увидеть по ссылке.
Инструкции по имплементации SberPay SDK для сайтов и мобильных приложений находятся по ссылке.
С примером отрисовки кнопки SberPay можно ознакомиться по ссылке.
Допустимые варианты отрисовки логотипа SberPay находятся в приложенном документе
В соответствии с Федеральным законом РФ №54-ФЗ c 01.07.2017 при осуществлении онлайн продаж, Продавец (в данной документации - Клиент), с помощью онлайн-кассы, обязан формировать кассовый чек и направлять его в ФНС и покупателю. В целях исполнения данного требования ПАО Сбербанк разработан механизм интеграции с онлайн-кассами, позволяющий упростить для Партнера данную процедуру. На текущий момент Платежным шлюзом поддерживаются только кассы "АТОЛ Онлайн", “Цифровая касса ЭВОТОР”, "Бизнес.ру" с версиями ФФД 1.05 и 1.2, а так же "OFD.RU" с версиями ФФД 1.1 и 1.2.
Для успешной регистрации кассового чека необходимо выполнение следующих условий:
С 01.04.2025 перед продажей маркированных товаров необходимо осуществлять онлайн проверку кода маркировки в Честном Знаке. Существует 2 способа осуществления проверки:
Состав тега 1260:
| Тег | Наименование | Значение |
|---|---|---|
| 1262 | Идентификатор ФОИВ | фиксированное: 030 |
| 1263 | Дата документа основания | фиксированное: 21.11.2023 |
| 1264 | Номер документа основания | фиксированное: 1944 |
| 1265 | Значение отраслевого реквизита | динамическое поле. В ответе метода проверки КМ в ЧЗ в режиме онлайн возвращаются атрибуты reqId (Идентификатор запроса) и reqTimestamp (Время запроса). Атрибуты необходимо передавать в тег 1265 в формате: UUID=reqId&Time=reqTimestamp |
Для подключения кассы Эвотор необходимо:
Для подключения кассы АТОЛ необходимо:
Для подключения кассы OFD.RU необходимо:
Для подключения кассы Бизнес.Ру необходимо:
Функционал находится в разработке
СберСпасибо - это бонусная программа лояльности от ПАО «Сбербанк» для своих клиентов.
На специальный бонусный счет Плательщика, начисляется процент от суммы покупки, которую Плательщик совершает по карте.
Для того, чтобы на бонусный счёт Плательщика начислялись бонусы при оплате картой, магазину, подключённому к Платёжному шлюзу, не требуется выполнять дополнительных вызовов на своей стороне.
Накопленными бонусами (1 бонус равен 1 рублю) можно оплачивать товары в магазинах-партнёрах программы. Предоставление возможности оплачивать товары/услуги бонусами возможно несколькими способами.
deposit и возврата средств Плательщика refund необходимо использовать аналогичные сервисы autoCompletion и autoRefund с указанием общей суммы операции в рублях и бонусахДля каждой товарной позиции произведение стоимости единицы товара itemPrice на количество товарных позиций quantity.value должно строго равняться итоговой стоимости товарной позиции itemAmount
Сумма стоимостей всех товарных позиций itemAmount должна равняться итоговой сумме чека total и сумме операции в запросе amount/compositeAmount
Для связанных операций в рамках одного заказа (завершение двухстадийного сценария, отмена, возврат) необходимо:
positionId и itemCodeitemPrice и itemAmount до вычета бонусовУникальный идентификатор товарной позиции внутри Корзины (positionId) должен быть больше или равен 1
Доступен возврат только товарных позиций, участвовавших в оплате при одностадийном сценарии (переданных в запросе register) или в завершении платежа при двухстадийном сценарии (переданных в запросе autoCompletion)
За распределение скидки по товарной корзине при оплате бонусами отвечает процессинг лояльности СберСпасибо
В связи с особенностью распределения бонусов СберСпасибо на стороне процессинга лояльности по переданным товарным позициям Шлюз использует следующую методику округления при осуществлении возвратов:
Пример:
Данная методика применима при реализации собственного решения по фискализации.
В случае использования функционала фискализации на стороне Шлюза (функционал находится в разработке):
doReceiptgetOrderStatusExtendedФункционал находится в разработке
Электронный сертификат – это новый платежный инструмент, который предоставляет возможность самостоятельно приобретать отдельные виды товаров, работ и услуг за счет средств бюджетов при наличии оснований на получение мер государственной поддержки в натуральной форме. Электронный сертификат выпускается к карте ПС «Мир», а оплата работает аналогично операциям с использованием банковских карт и позволяет мгновенно оплатить отдельные виды товаров при наличии оснований на предоставление мер социальной поддержки.
Сертификат содержит сведения о том, какие товары, работы или услуги, в каком количестве и на какую предельную сумму можно приобрести с его использованием. Сами денежные средства на карту ПС «Мир» не перечисляются, а резервируются в бюджете до совершения покупки. При этом использовать собственные средства необходимо только в случае, если количество и (или) стоимость приобретаемых товаров, работ или услуг превышает количество и (или) предельную стоимость в электронном сертификате.
Для того, чтобы подключить возможность принимать оплаты с помощью электронных сертификатов, Мерчанту необходимо:
Для осуществления расчетов по операциям с использованием ЭС требуется заключить дополнительное соглашение к договору ИЭ.
Для возможности взаимодействия с Фронт-офисом Электронных Сертификатов НСПК ТСП Мерчанту необходимо поддерживать кодировку товаров, согласованную с перечнем товаров/работ/услуг - truCode.
Зарегистрироваться в Государственной информационной системе электронных сертификатов ГИС ЭС
В системах внутреннего учета продавца требуется обеспечить кодировку ТРУ согласно перечню, утвержденному в соответствии с постановлением Правительства Российской Федерации от 23.04.2021 № 631 «О порядке формирования и утверждения Перечней отдельных видов товаров, работ, услуг, приобретаемых с использованием электронного сертификата за счет средств бюджета бюджетной системы Российской Федерации». Актуальный перечень публикуется в Единой системе нормативной справочной информации.
Пройти регистрацию продавца и магазинов в Автоматизированной системе сбора анкет (АССА) для получения ключа доступа (API KEY). На электронный адрес сотрудника продавца, указанного при заполнении формы на сайте Государственной информационной системы электронных сертификатов (ГИС ЭС) на шаге 3 в качестве технического специалиста , АО «НСПК» направляет ссылку для входа в АССА и создания пароля для доступа в личный кабинет продавца в АССА. При первом входе АССА предложит установить пароль для входа.
Имея API KEY, Мерчант должен получить идентификатор кассы (cashboxId) и ключа кассы (MAC KEY) в ФЭС НСПК.
Мерчант должен передать API KEY, cashboxId, MAC KEY Банку-эквайеру и провести тестовую операцию.
Перейти в промышленную среду.
Руководство для торгово-сервисных предприятий по организации приема электронных сертификатов при оплате отдельных видов товаров, работ, услуг размещено на официальном сайте АО «НСПК» в разделе Электронные сертификаты – Оферта для ТСП
itemPrice на количество товарных позиций quantity.value должно строго равняться итоговой стоимости товарной позиции itemAmountitemAmount должна равняться итоговой сумме чека total и сумме операции amount в запросеpositionId, itemCode, itemPrice, truCoderegister)getOrderStatusExtendedexternalReceipt для передачи их в ФЭС. Если фискализация осуществляется на стороне ПШ, то дополнительных вызовов для работы с ЭС не требуется.Ознакомиться с инструкциями по работе в личном кабинете Сбербанк Бизнес Онлайн вы сможете на сайте Сбербанка. Ниже приведены наиболее востребованные ссылка на разделы по работе с заказами интернет-эквайринга.
Сервис доступен при соблюдении следующих условий:
Открыт счет в ЦР через Сбербанк / получен доступ к счету через Сбербанк
Подписан договор по СБП
Подписано доп/соглашение к договору СБП об использовании УПК (Универсального платежного кода) для приема оплат цифровым рублем.
Выполнено подключение к ecom АПИ Сбербанка
Партнер создает заказ методом register.do, указывая в блоке jsonParams "qrType" значение "DYNAMIC_QR_SBP", "sbp.scenario" значение "C2B", поле "description" заполняется опционально.
При обработке запроса на создание заказа Сбер получает в НСПК универсальную платежную ссылку с двумя способами оплаты – СБП и ЦР (ссылка УПК), и передает ее партнеру в ответ на register.do.
Партнер использует payload в своем app/mWEB, используя виджет НСПК https://widget.cbrpay.ru/v1, или формирует и отображает клиенту QR-код.
Клиент-физическое лицо выбирает свой банк в списке банков-эмитентов, сформированном виджетом, или сканирует QR-код, далее переходит в приложение своего банка и подтверждает оплату цифровым рублем.
После проведения оплаты через контур Платформы цифрового рубля Банка России, НСПК, Сбер получает подтверждение о получении платежа, и присваивает заказу статусы, соответствующие результату оплаты.
Сбер направляет партнеру информацию о статусе заказа в ответ на запрос getOrderStatusExtended.do, либо в callback. Если заказ был оплачен Цифровыми рублями, то в ответе значение параметра в объекте cardAuthInfo "paymentWay" = "NSPK_DIGITAL_RUB", в объекте "transactionAttributes" параметр "extTransactionId" будет содержать идентификатор операции на Платформе Цифрового рубля.
Методы API для создания заказа, отмены заказа, получения статуса заказа, осуществления возврата средств по заказу.
Запрос предназначен для регистрации (создания) заказа в Шлюзе. При успешной обработке запроса заказу присваивается номер (идентификатор), уникальный в рамках Шлюза. Метод используется для регистрации заказа с последующией оплатой любым способом:
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос регистрации заказа по одностадийному сценарию
| 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://).*$ Адрес, на который требуется перенаправить Плательщика в случае успешной оплаты, когда Партнер использует платёжную страницу ПШ Обратите внимание!
|
| failUrl | string (failUrl) [ 12 .. 2048 ] characters ^(http://|https://).*$ Адрес, на который требуется перенаправить Плательщика в случае неуспешной оплаты, когда Партнер использует платёжную страницу ПШ. Если не указан, используется returnUrl Обратите внимание!
|
| 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 ^[ -~]*$ Дополнительные параметры управления сценариями при использовании платёжных реквизитов (можно указать несколько через разделитель ";"):
|
| phone | string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$ Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email. |
string (email) [ 3 .. 128 ] characters ^[ -~]+$ Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone. | |
object (orderBundle) Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования | |
| dynamicCallbackUrl | string (dynamicCallbackUrl) [ 12 .. 512 ] characters ^(https://).*$ Адрес, на который требуется направить callback. Если параметр отсутствует - используется адрес, указанный в настройках мерчанта Обратите внимание!
|
{- "userName": "testUserName",
- "password": "testPassword",
- "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
- "amount": 19900,
- "features": "FORCE_SSL"
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "externalParams": {
- "sbolDeepLink": "sberpay://invoicing/v2?bankInvoiceId=a67b0cedc9a44cfbbce3b9595afaafc1&operationType=Web2App&option=Connect"
}
}Запрос предназначен для регистрации (создания) заказа в Шлюзе, дальнейшая обработка (оплата) которого требует дополнительного подтверждения. При успешной обработке запроса заказу присваивается номер (идентификатор), уникальный в рамках Шлюза. Функционал подключается по запросу.
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос регистрации заказа по двухстадийному сценарию
| 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://).*$ Адрес, на который требуется перенаправить Плательщика в случае успешной оплаты, когда Партнер использует платёжную страницу ПШ Обратите внимание!
|
| failUrl | string (failUrl) [ 12 .. 2048 ] characters ^(http://|https://).*$ Адрес, на который требуется перенаправить Плательщика в случае неуспешной оплаты, когда Партнер использует платёжную страницу ПШ. Если не указан, используется returnUrl Обратите внимание!
|
| 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 ^[ -~]*$ Дополнительные параметры управления сценариями при использовании платёжных реквизитов (можно указать несколько через разделитель ";"):
|
| phone | string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$ Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email. |
string (email) [ 3 .. 128 ] characters ^[ -~]+$ Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone. | |
object (orderBundle) Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования | |
| dynamicCallbackUrl | string (dynamicCallbackUrl) [ 12 .. 512 ] characters ^(https://).*$ Адрес, на который требуется направить callback. Если параметр отсутствует - используется адрес, указанный в настройках мерчанта Обратите внимание!
|
| autocompletionDate | string <date-time> (autocompletionDate) Дата и время автоматического подтверждения заказа в формате yyyy-MM-ddTHH:mm:ss. Если передан параметр, то вызов метода deposit не требуется. |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
- "amount": 19900,
- "features": "FORCE_SSL"
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "externalParams": {
- "sbolDeepLink": "sberpay://invoicing/v2?bankInvoiceId=a67b0cedc9a44cfbbce3b9595afaafc1&operationType=Web2App&option=Connect",
- "sbolBankInvoiceId": "a67b0cedc9a44cfbbce3b9595afaafc1"
}
}Запрос предназначен для выполнения дополнительного подтверждения оплаты двухстадийного платежа. При успешной обработке подтверждается списание средств со счета Плательщика.
Внимание! При передаче в параметре amount суммы "0" подтверждение оплаты будет выполнено на полную сумму заказа, без учета ранее выполненной операции частичной отмены
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос завершения двухстадийного сценария
| 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-кредитования |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "amount": 14900
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок"
}Запрос предназначен для снятия блокировки средств по операции оплаты. Может быть осуществлена до момента начала взаиморасчетов банков-участников. При оплате Одностадийного платежа может быть выполнена в течение банковского дня совершения операции (~ до 23:59 МСК). При оплате по Двухстадийному сценарию может быть выполнена только до операции завершения двухстадийного сценария.
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос отмены заказа
| 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-кредитования |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок"
}Запрос предназначен для выполнения частичного или полного возврата средств Плательщика, после выполнения взаиморасчетов банков-участников по операции оплаты.
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос возврата средств Плательщика
| 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-кредитования |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "amount": 14900
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок"
}Запрос предназначен для получения полных данных по ранее зарегистрированному заказу независимо от его статуса.
Запрос получения информации о заказе
| 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). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}{- "errorCode": "0",
- "merchantOrderParams": [
- {
- "name": "parameter1",
- "value": "test1"
}, - {
- "name": "parameter2",
- "value": "test2"
}
], - "cardAuthInfo": {
- "secureAuthInfo": {
- "threeDSInfo": {
- "cavv": "AAABCUKCEQAAAAADIIIRAbpUtuo=",
- "xid": "82dfc393-af33-4d8f-819e-e286d565d8a9"
}, - "eci": 2
}, - "maskedPan": "220138*******0047",
- "expiration": "202512",
- "cardHolderName": "PETR IVANOV",
- "approvalCode": "433187",
- "paymentSystem": "MIR",
- "paymentWay": "CARD"
}, - "bindingInfo": {
- "clientId": "M79011234567",
- "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce"
}, - "paymentAmountInfo": {
- "approvedAmount": 19900,
- "depositedAmount": 19900,
- "refundedAmount": 0,
- "paymentState": "DEPOSITED"
}, - "bankInfo": { },
- "payerData": {
- "email": "test@test.com"
}, - "transactionAttributes": [
- {
- "name": "SbolBankInvoiceId",
- "value": "a67b0cedc9a44cfbbce3b9595afaafc1"
}
], - "attributes": [
- {
- "name": "mdOrder",
- "value": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}
], - "operations": [
- {
- "date": 1675169010957,
- "type": "AUTHORIZATION",
- "amount": 19900,
- "referenceNumber": "303112098637",
- "approvalCode": "433187",
- "actionCode": 0
}
], - "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"
}Запрос предназначен для отмены заказа до момента начала его оплаты Плательщиком (до ввода данных карты).
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос отмены заказа до начала платежа
| 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 Блок для передачи дополнительных параметров Партнером. |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок"
}Запрос предназначен для блокировки средств на карте Плательщика для проведения дальнейших расчетов между банками-участниками. Доступен при наличии соответствующих разрешений.
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос проведения оплаты по карте
| 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-адрес Плательщика |
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) Признак отказа от создания Связки Плательщиком.
|
{- "userName": "testUserName",
- "password": "testPassword",
- "MDORDER": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "$PAN": "2201382000000047",
- "$CVC": "123",
- "YYYY": "2025",
- "MM": "12"
}{- "errorCode": "0",
- "error": "Обработка запроса прошла без системных ошибок",
- "info": "Ваш платёж обработан, происходит переадресация",
}Запрос предназначен для выполнения оплаты посредством функционала SberPay, доступного в мобильном приложении "Сбербанк-Онлайн".
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос проведения оплаты через мобильное приложение "Сбербанк-Онлайн"
| 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-_.-]+$ Логин дочернего Партнера (если используется) |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "phone": "79011234567"
}{- "errorCode": "0"
}Запрос предназначен для выполнения оплаты по подписке СБП.
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос проведения оплаты по подписке СБП
| 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}$ Идентификатор банка отправителя |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "subscriptionId": "c9403ef2f9254736a5af837238ce05b1",
- "memberId": "100000000111"
}{- "errorCode": "0"
}Методы API для создания, получения информации, активации, деактивации, проведения платежей по связкам. Внимание! Для некоторых категорий мерчантов (MCC) рекуррентные платежи по картам МИР недоступны.
Запрос предназначен для совершения оплаты (блокировки средств) по ранее сохраненной связке.
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос проведения оплаты по связке
| 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-адрес Плательщика |
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 Банка |
{- "userName": "testUserName",
- "password": "testPassword",
- "mdOrder": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
- "ip": "127.0.0.1"
}{- "errorCode": "0",
- "error": "Обработка запроса прошла без системных ошибок",
- "info": "Ваш платёж обработан, происходит переадресация",
}Запрос предназначен для деактивации ранее сохраненной связки.
Запрос деактивации связки Плательщика
| 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). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера |
{- "userName": "testUserName",
- "password": "testPassword",
- "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
- "language": "ru"
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок"
}Запрос предназначен для получения списка связок, привязанных к конкретному идентификатору Плательщика.
Запрос получения связок по идентификатору Плательщика
| 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) Признак необходимости отображать Связки с истёкшим сроком действия Карты. Возможны следующие значения:
|
| showInactive | boolean (showInactive) Признак необходимости отображать Связки с неактивным статусом. Возможны следующие значения:
|
{- "userName": "testUserName",
- "password": "testPassword",
- "clientId": "M79011234567",
- "language": "ru",
- "showExpired": true,
- "showInactive": true
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок",
- "bindings": [
- {
- "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
- "maskedPan": "220138******0047",
- "expiryDate": "202512",
- "bindingStatus": "0",
- "paymentWay": "CARD",
- "paymentSystem": "MIR"
}
]
}Запрос предназначен для получения списка связок, привязанных к конкретному идентификатору Плательщика на основании переданной связки данного идентификатора Плательщика или полного номера карты. Для работы с полным номером карты необходимы дополнительные настройки учетной записи.
Запрос получения связок по номеру карты или идентификатору связки Плательщика
| 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) Признак необходимости отображать Связки с истёкшим сроком действия Карты. Возможны следующие значения:
|
| showInactive | boolean (showInactive) Признак необходимости отображать Связки с неактивным статусом. Возможны следующие значения:
|
{- "userName": "testUserName",
- "password": "testPassword",
- "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
- "showExpired": true,
- "showInactive": true
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок",
- "bindings": [
- {
- "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
- "maskedPan": "220138******0047",
- "expiryDate": "202512",
- "clientId": "M79011234567",
- "bindingStatus": "0",
- "paymentWay": "CARD",
- "paymentSystem": "MIR"
}
]
}Запрос предназначен для активации ранее дективированной связки (при условии актуальности ее срока действия).
Запрос активации связки Плательщика
| 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). Если не указан, будет использовано значение по умолчанию, указанное в настройках Партнера |
{- "userName": "testUserName",
- "password": "testPassword",
- "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
- "language": "ru"
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок"
}Запрос предназначен для одновременной регистрации заказа и его оплаты с использованием связки. Совмещает в себе два действия register и paymentOrderBinding
Внимание! Отправка фискальных чеков при использовании данного сервиса находится в разработке.
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос проведения периодического платежа
| 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. |
string (email) [ 3 .. 128 ] characters ^[ -~]+$ Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone. | |
fmConversionAttributes (object) or loyaltyAttributes (object) or keyValue (object) <= 99 properties Блок для передачи дополнительных параметров Партнером. | |
object (orderBundle) Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
- "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
- "amount": 19900
}{- "success": true,
- "data": {
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "orderNumber": "e2574f1785324f1592d9029cb05adbbd"
}, - "orderStatus": {
- "actionCode": 0,
- "amount": 19900,
- "approvalCode": "433187",
- "authDateTime": 1675169010957,
- "authRefNum": "303112098637",
- "bankInfo": { },
- "cardAuthInfo": {
- "expiration": "202512",
- "pan": "220138******0047",
- "paymentSystem": "MIR"
}, - "currency": "643",
- "date": 1675169008805,
- "orderStatus": 2,
- "paymentAmountInfo": {
- "approvedAmount": 19900,
- "depositedAmount": 19900,
- "paymentState": "DEPOSITED",
- "refundedAmount": 0
}, - "terminalId": "20184020"
}
}Сервис проведения оплаты с использованием приложения MirPay (In-application) с интеграцией Партнера по схеме агрегатора и расшифровкой платёжных данных на стороне Партнера. Может выполняться как с предварительной регистрацией заказа (логины, сумма, идентифкатор заказа и сценарий проведения платежа в запросах должны совпадать), так и без неё
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос роведения платежа с использованием прямого взаимодействия Партнера с 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) Признак предварительной авторизации. Возможны следующие значения:
| ||||||||||||||||||||||||||||||||||||||||||||||||
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-объекта:
| ||||||||||||||||||||||||||||||||||||||||||||||||
| merchant | string (merchantLogin) [ 1 .. 30 ] characters ^[A-Za-z0-9-_.-]+$ Логин дочернего Партнера (если используется) | ||||||||||||||||||||||||||||||||||||||||||||||||
| features | string (featuresVerify) [ 1 .. 255 ] characters ^[ -~]*$ Дополнительные параметры управления сценариями при использовании платёжных реквизитов:
| ||||||||||||||||||||||||||||||||||||||||||||||||
object (orderBundle) Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования | |||||||||||||||||||||||||||||||||||||||||||||||||
| phone | string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$ Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email. | ||||||||||||||||||||||||||||||||||||||||||||||||
string (email) [ 3 .. 128 ] characters ^[ -~]+$ Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone. |
{- "userName": "testUserName",
- "password": "testPassword",
- "amount": 10000,
- "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
- "paymentToken": "eyJ0YW4iOiIyMjAwMTIqKioqKioqKiozNDg2IiwiY2F2IjoiM0Q2RkM4MjZBMDhDODJCODk3ODAwMjlGNjk2NzBGRERDRjI5OUIiLCJ0ZXkiOjI5LCJ0ZW0iOjMsInRyYW5zSWQiOiI1YWI1MjQ4Ny0xNzdmLTQ2NGItYjY5NS0yOTU0ZmZjNDRhMTMiLCJtSWQiOiIwMDAwMDAwMDAwMDAwMDEiLCJteDVjIjoiTUlJRWpEQ0NBM1NnQXdJQkFnSURFaUVETUEwR0NTcUdTSWIzRFFFQkN3VUFNSUdGTVFzd0NRWURWUVFHRXdKU1ZURVpNQmNHQTFVRUNBd1FVMkZwYm5RdFVHVjBaWEp6WW5WeVp6RVhNQlVHQTFVRUNnd09WbTlrYTJFZ1FtRnVheUJLVTBNeER6QU5CZ05WQkFzTUJrSXdNREF3TVRFUE1BMEdBMVVFQXd3R1FqQXdNREF4TVNBd0hnWUpLb1pJaHZjTkFRa0JGaEY2YjNKeWIwQmxhMkZ6YzJseUxtTnZiVEFlRncweU1qRXhNRGt4TXpNMU5UTmFGdzB5TXpFeE1Ua3hNek0xTlROYU1JRzNNUXN3Q1FZRFZRUUdFd0pTVlRFWk1CY0dBMVVFQ0F3UVUyRnBiblF0VUdWMFpYSnpZblZ5WnpFWk1CY0dBMVVFQnd3UVUyRnBiblF0VUdWMFpYSnpZblZ5WnpFYU1CZ0dBMVVFQ2d3UlVHRnlZWE5sYm1ObElFeHBiV2wwWldReEdUQVhCZ05WQkFzTUVFMHdNREF3TURBd01EQXdNREF3TURFeEdUQVhCZ05WQkFNTUVFMHdNREF3TURBd01EQXdNREF3TURFeElEQWVCZ2txaGtpRzl3MEJDUUVXRVhwdmNuSnZRR1ZyWVhOemFYSXVZMjl0TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUF1TzFteGU2Mk5kVzdLTTUwRlZ3Y29qNDVRSjNYVms4QWg2UkN4Q1IzdHZydXM3bm9OV2FLajljM2VEeDQ3V3N3MFZROUpiUVRPdFRqaSsrRFkwOEJ2WGtWK1J1SXNlekdnVzR4S1RJK3lwSGN4OHZJSU5oS0JLMmZZdTVJRFZkejRaYml1R3IySW13eHVPL3VYRW5iNXhDTS9wK01tTDBwZmpjaE9LWkZMVW1Xdm44clMxUGc5NzRRSjJiODl0TDlKSmR3K3NhMDlXWkpoQWZGYVNaRk9LM0dwQkc5azVmZEhvTXNKY2RJRmxOMzFIMFF2OFMvOEZVbGdqVVFCdW9TbmdneXJ6aUR6RXFWM1BIcXcwZURjOTc5WE1hYTZvWFJLYk1UaXFrR01qN0h4N2dVanFzRStPZ29EcFdDSlpWVGMzNWkrajJGTEVpRDZ4NHpBR2FjZndJREFRQUJvNEhRTUlITk1Ba0dBMVVkRXdRQ01BQXdFUVlKWUlaSUFZYjRRZ0VCQkFRREFnV2dNRE1HQ1dDR1NBR0crRUlCRFFRbUZpUlBjR1Z1VTFOTUlFZGxibVZ5WVhSbFpDQkRiR2xsYm5RZ1EyVnlkR2xtYVdOaGRHVXdIUVlEVlIwT0JCWUVGQnRrWDUvemNnSlpSYitHZUpKYUVZZytWVE9UTUI4R0ExVWRJd1FZTUJhQUZMWE9JclFpZHNuZ0J4cXhBQ3FtbURmajJTM0tNQTRHQTFVZER3RUIvd1FFQXdJRThEQWRCZ05WSFNVRUZqQVVCZ2dyQmdFRkJRY0RBZ1lJS3dZQkJRVUhBd1F3Q1FZRFZSMFNCQUl3QURBTkJna3Foa2lHOXcwQkFRc0ZBQU9DQVFFQU1EN3FITEVKakdEcyt2ZEQwTklKWnhzVVpITjBXVTdPMm83TUxkVE96bkRqQ0RaV0thNzBHQlRsUm5vNTU2ejQ0a2VxajVWWnRIOVhWZ1A0U3pwOEMyZnppT0F1alNyS1Z3MGxoN2lEUmNiMU9ESEx5U0IzMDRHOXpnZE0rRFBLeW9za3pxcC9KNGl5VWFGLzZyNVlqLzVxVmZ0d0xSQlRJbld0OGgycFdxU29aaE5xaFY1SmRVK1dtQ0Nzd0RLZzQzSTJTSC9sUHZVaXFkRFFYK2xscDZYVHVJNm83aUdQRmRQZ2tOWFVOVUVIL3NNTUNOU2xOQmNQUFhGeSs1SHhFYkFmS242WmJZN2xYTDZSbzJuSzRERFJSbENYMGJmT1BKWFBMK290dncrVXZuSXIyOGNpc0VTdzB5OWxYbTlOWmhhQnhEVEZWREFSTWZUT1lxdFJDdz09Iiwib3JkZXJJZCI6IjEyMzQ1NiIsInN1bSI6MTAwMDAsImN1ciI6NjQzLCJtZWRpYSI6IklTREsifQ"
}{- "success": true,
- "data": {
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "orderNumber": "e2574f1785324f1592d9029cb05adbbd"
}, - "orderStatus": {
- "actionCode": 0,
- "amount": 10000,
- "approvalCode": "433187",
- "authDateTime": 1675169010957,
- "authRefNum": "303112098637",
- "bankInfo": { },
- "cardAuthInfo": {
- "expiration": "202903",
- "pan": "220012*********3486",
- "paymentSystem": "MIR"
}, - "currency": "643",
- "date": 1675169008805,
- "orderStatus": 2,
- "paymentAmountInfo": {
- "approvedAmount": 10000,
- "depositedAmount": 10000,
- "paymentState": "DEPOSITED",
- "refundedAmount": 0
}, - "terminalId": "20184020"
}
}Методы API для завершения 3-D Secure аутентификаций, прововдимых на стороне Партнера
Запрос предназначен для завершения 3DS аутентификации Плательщика при проведении операции оплаты. Последовательность обработки запроса:
register или registerPreAuth, в зависимости от сценария платежа;paymentOrder или paymentOrderBinding с получением в ответе требований проведения 3DS Method (threeDSMethodURL). Значение threeDSMethodData возвращается, если в запросе был передан threeDSMethodNotificationUrl, в противном случае Партнер самостоятельно формирует объект threeDSMethodData= base64url({"threeDSServerTransID":"value","threeDSMethodNotificationURL":"value"});finish3dsMethod.| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос завершения 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:
|
{- "userName": "testUserName",
- "password": "testPassword",
- "mdOrder": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "threeDSServerTransId": "93045e61-d783-40f1-8934-33fd59387ca6",
- "threeDSCompInd": "Y"
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок",
- "info": "Ваш платёж обработан, происходит переадресация",
}Запрос предназначен для передачи результата 3DS аутентификации Плательщиа при прямом взаимодействии с сервером ACS. Последовательность обрабтки запроса:
register или registerPreAuth, в зависимости от сценария платежа;paymentOrder, paymentOrderBinding или finish3dsMethod с получением в ответе требований проведения 3-D Secure аутентификации (paReq или cReq);finish3dsPayment.| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос завершения аутентификация 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.х.х |
{- "userName": "testUserName",
- "password": "testPassword",
- "mdOrder": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "cRes": "eyJhY3NUcmFuc0lEIjogIjllNWUxMWViLTY1OTYtNDMyMi04NjU4LTJkNDY0MDUwMGYyZSIsICJ0cmFuc1N0YXR1cyI6ICJZIiwgIm1lc3NhZ2VWZXJzaW9uIjogIjIuMS4wIiwgIm1lc3NhZ2VUeXBlIjogIkNSZXMiLCAidGhyZWVEU1NlcnZlclRyYW5zSUQiOiAiOTMwNDVlNjEtZDc4My00MGYxLTg5MzQtMzNmZDU5Mzg3Y2E2In0="
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок",
- "info": "Ваш платёж обработан, происходит переадресация",
}Функционал предназначен для отправки callback уведомления при изменении статуса заказа. Callback уведомление представляет собой POST запрос, направляемый со стороны платежного шлюза на URL, указанный в настройках учетной записи. Осуществляется 3 попытки доставки уведомления с интервалом 60 секунд между попытками
Запрос уведомления о проведении платежа
| 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]*$ Тип операции, о которой формируется уведомление. Возможны следующие значения:
|
| status required | integer (status) [ 0 .. 1 ] Индикатор успешности операции о которой формируется уведомление. Возможны следующие значения:
|
object (additionalParams) Дополнительные параметры операции. Используется также при создании подписки СБП. |
{- "mdOrder": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
- "operation": "deposited",
- "status": 1,
- "additionalParams": { }
}Функционал предназначен для отправки callback уведомления при изменении статуса связки. Callback уведомление представляет собой POST запрос, направляемый со стороны платежного шлюза на URL, указанный в настройках учетной записи. На текущий момент сервис отправки уведомлений доступен только для связок, созданных при проведении платежей через мобильное приложение "Сбербанк-Онлайн". Осуществляется 3 попытки доставки уведомления с интервалом 60 секунд между попытками
Запрос уведомления о событии со связкой
| 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]*$ Тип операции, о которой формируется уведомление. Возможны следующие значения:
|
{- "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce",
- "clientId": "M79011234567",
- "operation": "bindingCreated"
}Запрос предназначен для регистрации (создания) заказа на перевод в Шлюзе. При успешной обработке запроса заказу присваивается номер (идентификатор), уникальный в рамках Шлюза. Метод используется для регистрации заказа с последующией оплатой сервисом performP2P
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос регистрации заказа на перевод
| 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://).*$ Адрес, на который требуется перенаправить Плательщика в случае успешной оплаты, когда Партнер использует платёжную страницу ПШ Обратите внимание!
|
| features required | string (featuresP2P) [ 1 .. 255 ] characters ^[ -~]*$ Тип перевода. Доступные значения:
Параметр обязателен для данного сервиса. |
| failUrl | string (failUrl) [ 12 .. 2048 ] characters ^(http://|https://).*$ Адрес, на который требуется перенаправить Плательщика в случае неуспешной оплаты, когда Партнер использует платёжную страницу ПШ. Если не указан, используется returnUrl Обратите внимание!
|
| 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. Если параметр отсутствует - используется адрес, указанный в настройках мерчанта Обратите внимание!
|
{- "userName": "testUserName",
- "password": "testPassword",
- "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
- "amount": 19900,
- "features": "ORIGINAL_CREDIT"
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
}Запрос предназначен для проведения перевода средств по ранее созданному заказу на перевод
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос проведения перевода по заказу
| 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 Блок для передачи дополнительных параметров Партнером. | |
string (email) [ 3 .. 128 ] characters ^[ -~]+$ Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone. | |
| phone | string (phone) [ 1 .. 16 ] characters ^(\+?)\d{7,15}$ Номер телефона Плательщика. Если в телефон включён код страны, номер должен начинаться со знака плюс («+»). Если телефон передаётся без знака плюс («+»), то код страны указывать не следует. В случае использования фискализации обязателен для передачи в формате +79998887700, при отсутствии номера телефона обязателен email. |
object Блок для передачи параметров с реквизитами о зачисление на карту |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "toCard": {
- "pan": "2201382000000047",
- "expirationYear": "2025",
- "expirationMonth": "12"
}
}{- "errorCode": "0",
- "error": "Обработка запроса прошла без системных ошибок",
- "info": "Ваш платёж обработан, происходит переадресация",
}Методы API для формирования чеков
Обратите внимание на используемый ендпойнт при отправке запроса.
Сервис для получения информации о результате обработки чека или чеков.
Запрос статуса обработки чека.
При передаче orderId или orderNumber отражаются все сформированные чеки по Заказу, при передаче receiptId - конкретный чек.
Дополнительно доступен поиск по статусу чека. Рекомендуем запрашивать статус чека не ранее чем через 6 минут после проведения операции.
| 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 ] Статус чека
|
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}{- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "orderNumber": "e2574f1785324f1592d9029cb05adbbd",
- "receipts": [
- {
- "receiptId": "822c6862-634c-11ee-8c99-0242ac120002",
- "externalId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1_ded07d1b",
- "operationId": "0ad563f9-c7ec-49ba-9062-a04de55b6f3f",
- "operationType": "AUTHORIZATION",
- "receiptType": "sell",
- "receiptStatus": 3,
- "origReceiptId": "23d72f20-a770-4548-9bcc-1d1a8567e071",
- "timestamp": "11.10.2023 13:24:59",
- "groupCode": "group_code_4612",
- "daemonCode": "quasar",
- "deviceCode": "KKT068508",
- "payload": {
- "fiscalReceiptNumber": 10,
- "shiftNumber": 188,
- "receiptDatetime": "09.10.2023 15:08:00",
- "total": 24600,
- "fnNumber": "9999078902013948",
- "ecrRegistrationNumber": "0000000005035122",
- "fiscalDocumentNumber": 783,
- "fiscalDocumentAttribute": 1837776948,
- "fnsSite": "www.nalog.ru",
- "ofdInn": "7709364346",
}
}
]
}Сервис позволяет сформировать повторный запрос на создание чека с Корзиной, идентичной первому чеку. Сервис используется только для переотправки неуспешных чеков. Последовательность обработки запроса:
getReceiptStatus.retryReceipt с включением receiptId/externalId чека, который нужно переотправить. Возможна отправка массива receiptId/externalId, если необходимо переотправить несколько чеков. Внимание! В случае, если в ответе на результат обработки чека отсутствует receiptId/externalId, использование сервиса retryReceipt невозможно. Обратитесь в техническую поддержку для получения рекомендаций.retryReceipt после исчерпания всех попыток регистрации, не ранее 15 часов после создания начального чека.Запрос переотправки чека.
| 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_\\-]+$ ] |
{- "userName": "testUserName",
- "password": "testPassword",
- "receiptIds": [
- "822c6862-634c-11ee-8c99-0242ac120002"
], - "externalIds": [
- "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1_ded07d1b"
]
}{- "message": "Успешно",
- "retryResult": [
- {
- "receiptId": "822c6862-634c-11ee-8c99-0242ac120002",
- "externalId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1_ded07d1b",
- "result": "Успешно"
}
]
}Сервис позволяет сформировать новый чек или изменить корзину в неуспешном чеке с использованием новой Корзины для повторной переотправки.
Создание нового чека
Сервис doReceipt используется для создания чека полного расчета, чека возврата предоплаты или аванса на холдирование отдельно от финансовой операции. Если ранее был создан чек на Предоплату или Аванс, рекомендуется перед формированием чека полного расчета убедиться в успешном создании чека Предоплаты через getReceiptStatus. Дополнительно возможно использование сервиса в случаях, если фискализация не была настроена в системах Банка или партнера, в связи с чем попыток создания чека не осуществлялось.
Для создания чека необходимо передать контакт Покупателя email/phone и Корзину orderBundle. Если ранее был создан чек на Предоплату или Аванс, рекомендуется перед формированием чека полного расчета убедиться в успешном создании чека Предоплаты через getReceiptStatus.
Переотправка неуспешного чека с новой Корзиной
В некоторых случаях кассовый сервис не может зарегистрировать чек из-за некорректных данных в Корзине, ошибок в работе ККТ или по иным причинам.
Сервис запроса статуса getReceiptStatus сообщит об этом в блоке error, предоставив код и описание ошибки. Поле recommendation позволяет определить, есть ли необходимость в корректировке корзины и повторной отправке чека.
Для попытки переотправки чека с новой корзиной необходимо:
getReceiptStatus;doReceipt с указанием receiptid исправляемого чека и контактами Покупателя email/phone.Указание receiptId для исправления чека рекомендуется в целях корректного отражения чеков в СберБизнес.
Запрос создания чека
| 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. |
string (email) [ 3 .. 128 ] characters ^[ -~]+$ Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone. | |
required | object (orderBundle) Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "email": "customer@testmail.ru",
- "orderBundle": {
- "ffdVersion": "1.2",
- "company": {
- "email": "email@testshop.ru",
- "sno": "osn",
- "inn": "5027119066",
}, - "payments": [
- {
- "type": 1,
- "sum": 24600
}
], - "total": 24600,
- "cartItems": {
- "items": [
- {
- "positionId": "1",
- "itemCode": "51",
- "name": "Сырок творожный со сгущенкой",
- "quantity": {
- "value": 1,
- "measure": "0"
}, - "markCode": {
- "gs1m": "MDEwNDYwNTg2NTQ4NzE2MjIxbj1ZR3lJbUhVOmlNWh05MUVFMDYdOTJYNE1sVzk2R1o2ZmV2RGhnUjJhaHNKNUltTmtVZUsyMkdGeEpVMmxjREpRPQ=="
}, - "itemPrice": 4700,
- "itemAmount": 4700,
- "paymentMethod": "full_payment",
- "paymentObject": "33",
- "tax": {
- "taxType": 2
}
}, - {
- "positionId": "2",
- "itemCode": "124",
- "name": "Виноград без косточек",
- "quantity": {
- "value": 0.4,
- "measure": "11"
}, - "itemPrice": 25000,
- "itemAmount": 10000,
- "paymentMethod": "full_payment",
- "paymentObject": "1",
- "tax": {
- "taxType": 4
}
}, - {
- "positionId": "3",
- "itemCode": "341",
- "name": "Услуга доставки",
- "quantity": {
- "value": 1,
- "measure": "0"
}, - "itemPrice": 9900,
- "itemAmount": 9900,
- "paymentMethod": "full_payment",
- "paymentObject": "4",
- "tax": {
- "taxType": 4
}
}
]
}
}
}{- "message": "Успешно",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}Функционал находится в разработке
Сервис позволяет формировать чеки коррекции. Поддерживается кассовыми сервисами Цифровая касса Эвотор, АТОЛ Онлайн, Ferma OFD.RU
Общие правила работы с сервисом:
В сервис необходимо передать корзину с receiptType желаемого чека коррекции. Например, для исправления чека с типом «Приход» необходимо передать "receiptType": "sell_correction", «Возврат прихода» - "receiptType": "sell_refund_correction". В связи с особенностью корректировки чеков в ФФД 1.05 типы создаваемых чеков автоматически будут определены как "sell" и "sell_refund". При наличии receiptId в запросе, система автоматически найдет и сформирует обратный чек, включив в него ФП (фискальный признак) некорректного чека в теге 1192, и, при необходимости, блок correctionInfo. В запрос необходимо всегда включать correctionInfo, за исключением исправления существующего чека при работе с ФФД 1.05.
Доступно 2 режима формирования чеков коррекции:
Создание нового чека коррекции:
Исправление успешно зарегистрированного чека:
Запрос создания чека коррекции
| 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. |
string (email) [ 3 .. 128 ] characters ^[ -~]+$ Адрес электронной почты Плательщика. В случае использования фискализации обязателен, при отсутствии phone. | |
required | object (correctionInfo) Информация о коррекции. Не передается в случае исправления существующего чека в ФФД 1.05. |
required | object (orderBundle) Блок, необходимый для формирования фискальных чеков. Содержит данные фискализации и корзину заказа. Также обязателен при регистрации заказов POS-кредитования |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "correctionInfo": {
- "type": "self",
- "baseDate": "29.07.2025",
- "baseNumber": "123"
}, - "email": "customer@testmail.ru",
- "orderBundle": {
- "cartItems": {
- "items": [
- {
- "positionId": "1",
- "itemCode": "001",
- "name": "Услуга 1",
- "measurementUnit": "шт",
- "quantity": {
- "value": 2
}, - "itemPrice": 500,
- "itemAmount": 1000,
- "paymentMethod": "full_payment",
- "paymentObject": "service",
- "tax": {
- "taxType": 0
}
}
]
}, - "ffdVersion": "1.05",
- "receiptType": "sell_correction",
- "company": {
- "email": "email@testshop.ru",
- "sno": "osn",
- "inn": "5027119066",
}, - "payments": [
- {
- "type": 1,
- "sum": 1000
}
], - "total": 1000
}
}{- "message": "Успешно",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1"
}Запрос для получения бонусного баланса по связке Плательщика
Запрос для получения бонусного баланса по идентификатору связки Плательщика. Для работы с данным сервисом необходимы дополнительные настройки учетной записи.
| 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\-]+$ Идентификатор Связки, созданной ранее. Может использоваться, только если у магазина есть разрешение на работу со связками |
{- "userName": "testUserName",
- "password": "testPassword",
- "bindingId": "fdbbc879-c171-4cff-b636-ceab16fd6fce"
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок",
- "loyaltyOperations": [
- {
- "serviceName": "sbrf_spasibo",
- "bonusBalance": 77700
}
]
}Запрос предназначен для выполнения дополнительного подтверждения оплаты двухстадийного платежа. При успешной обработке подтверждается списание средств со счета Плательщика.
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос завершения двухстадийного сценария
| 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-кредитования |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "compositeAmount": 14900,
- "orderBundle": {
- "cartItems": {
- "items": [
- {
- "positionId": "2",
- "itemCode": "654321",
- "name": "Товар 2",
- "quantity": {
- "value": 1
}, - "itemPrice": 9900,
- "itemAmount": 9900
}, - {
- "positionId": "3",
- "itemCode": "111111",
- "name": "Товар 3",
- "quantity": {
- "value": 1
}, - "itemPrice": 5000,
- "itemAmount": 5000
}
]
}
}
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок"
}Запрос предназначен для выполнения частичного или полного возврата средств Плательщика, после выполнения взаиморасчетов банков-участников по операции оплаты.
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос возврата средств Плательщика
| 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-кредитования |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "compositeAmount": 9900,
- "orderBundle": {
- "cartItems": {
- "items": [
- {
- "positionId": "2",
- "itemCode": "654321",
- "name": "Товар 2",
- "quantity": {
- "value": 1
}, - "itemPrice": 9900,
- "itemAmount": 9900
}
]
}
}
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок"
}Запрос предназначен для передачи данных фискального чека покупки или возврата для завершения операции с участием средств электронных сертфикатов.
| x-idempotencyKey | string [ 1 .. 255 ] characters ^[0-9a-zA-Z-_#]*$ Example: 779165e0-1905-4edd-89fa-be46497b5044 Функционал обработки ключа идемпотентности находится в разработке Ключ идемпотентности запроса. Повторный вызов с тем же ключом вернет результат выполнения предыдущего запроса и не приведет к выполнению нового. Срок хранения ключей - 24 часа. |
Запрос на передачу данных фискального чека
| 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 Блок для передачи дополнительных параметров Партнером. |
{- "userName": "testUserName",
- "password": "testPassword",
- "orderId": "a67b0ced-c9a4-4cfb-bce3-b9595afaafc1",
- "eCertificateBasketId": "422100010001100000000108",
- "cashboxId": "200000000000000011",
- "receipt": {
- "fnNumber": "9960440300133475",
- "fiscalDocumentNumber": "3304",
- "fiscalDocumentAttribute": "723840104",
- "total": 199,
- "receiptDateTime": "17.09.2024 09:59:59",
- "receiptType": "sell",
}
}{- "errorCode": "0",
- "errorMessage": "Обработка запроса прошла без системных ошибок"
}Методы установки постоянного пароля и генерации apikey
Обратите внимание на используемый ендпойнт при отправке запроса.
Сервис для смены временного пароля на постоянный
Запрос предназначен для изменение временного пароля, выданного при регистрации Партнера на ПШ на постоянный пароль на стороне Партнера.
| 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 символов |
{- "login": "testUserName",
- "tmpPassword": "testPassword",
- "password": "NewPassword"
}{- "login:": "testUserName",
- "password": "NewPassword"
}Сервис для генерации ключа Партнера для работы с сервисами платежного шлюза через SDK. Может быть создано не более 5 активных ключей. Внимание! При генерации ключа необходимо использовать ТОЛЬКО логины, полученные от технической поддержки.
Запрос предназначен для генерации ключа Партнера для работы с сервисами платежного шлюза через 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-_. ]+$ Логин дочернего Партнера (если используется). Внимание!
|
{- "userName": "testUserName",
- "password": "testPassword",
- "description": "testDescription",
- "merchantLogin": "merchantLogin"
}{- "id": "2f852119-0rhfdd-сe7a-b421-22be01a44311",
- "apikey": "AC+FIRkBJk56sCFSvgGkQzMAAAAAAbqrr3ybcZc/7i33plZ0IWbgQ/MaADTsnGBy+TsRUImIs0EaJyQe1ObbTLgsbOQ63TWysFwWduamtmO ",
- "message": "Api-key успешно создан"
}