Инструменты страницы



Запрос регистрации заказа с предавторизацией, передача корзины, интернет-кредитование (registerPreAuth.do)

Для регистрации заказа с предавторизацией в схеме приёма платежа на стороне платёжной системы используется запрос registerPreAuth.do. Товарная корзина передаётся в параметре orderBundle. Запрос на регистрацию должен соответствовать требованиям, представленным ниже.

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

  • A<n> – последовательность латинских букв длины <n>;
  • A..<n> – последовательность латинских букв длиной, не превышающей <n>;
  • N<n> – последовательность цифр длины <n>;
  • N..<n> – последовательность цифр длиной, не превышающей <n>;
  • AN<n> – последовательность латинских букв и цифр фиксированной длины <n>;
  • AN..<n> – последовательность латинских букв и цифр длиной, не превышающей <n>;
  • ANS<n> – последовательность латинских букв, цифр и символов фиксированной длины <n>
  • ANS..<n> – последовательность латинских букв, цифр и символов длиной, не превышающей <n>;
  • UTC – дата и время, при этом: дата должна быть передана без указания часового пояса, время московское, для протокола SOAP используется стандартная кодировка xs:dateTime.

Пользуясь протоколом REST, тело сообщения запроса следует отправлять с типом: 'Content-Type: application/x-www-form-urlencoded'.

Название Тип Обязательно Описание

userName

AN..30

Да

Логин служебной учётной записи продавца.

password

AN..200

Да

Пароль служебной учётной записи продавца.

orderNumber

ANS..32

Да

Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы.

Чтобы получить возможность отправлять это поле в процессинг, для включения в финансовую отчётность продавца, обратитесь в техническую поддержку.

amount

N..12

Да

Сумма платежа в минимальных единицах валюты (копейки, центы и т. п.). Должна совпадать с общей суммой по всем товарным позициям в корзине.

Перед суммированием всех товарных позиций для каждой товарной позиции произведение количества (quantity) и стоимости (price) округляется до целого числа. Т. е., если после десятичной запятой стоит 5 и более, то округление происходит в большую сторону. Ниже приведены примеры округления.

  1. Если quantity = 0,111, а price = 5500, то результат: 611 (округлённое 610,5).
  2. Если quantity = 1,455, а price = 6900, то результат: 10040 (округлённое 10039,5).
  3. Если quantity = 1,211, а price = 6988, то результат: 8462 (округлённое 8462,468).

Таким образом, параметр amount должен быть равен сумме округлённых товарных позиций.



Минимальная сумма кредита, 3000 рублей, поэтому минимальное значение amount:

  • 3000 рублей, в случае оформления кредита,
  • 3000 рублей + скидка партнера по рассрочке, в случае оформления рассрочки.

currency

N3

Да

Код валюты платежа ISO 4217. Если не указано, то используется значение по умолчанию.

returnUrl

ANS..512

Да

Адрес, на который требуется перенаправить пользователя в случае успешной оплаты, а также в случае неуспешной оплаты (при отсутствии переданного параметра failUrl). Адрес должен быть указан полностью, включая используемый протокол (например, https://test.ru вместо test.ru). В противном случае пользователь будет перенаправлен по адресу следующего вида: http://<адрес_платёжного_шлюза>/<адрес_продавца>.

Адрес нельзя указывать относительным путем, т.е. они не должны начинаться на «.» и «/». В противном случае вернется ошибка 4: «URL возврата некорректен». Например:

failUrl

ANS..512

Нет

Адрес, на который требуется перенаправить пользователя в случае неуспешной оплаты. Адрес должен быть указан полностью, включая используемый протокол (например, https://test.ru вместо test.ru). В противном случае пользователь будет перенаправлен по адресу следующего вида: http://<адрес_платёжного_шлюза>/<адрес_продавца>.

Адрес нельзя указывать относительным путем, т.е. они не должны начинаться на «.» и «/». В противном случае вернется ошибка 4: «URL возврата некорректен». Например:

Параметр необязательный.

description

ANS..512

Нет

Описание заказа в свободной форме. В процессинг банка для включения в финансовую отчётность продавца передаются только первые 24 символа этого поля.

Чтобы получить возможность отправлять это поле в процессинг, обратитесь в техническую поддержку.

language

A2

Нет

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

pageView

ANS..20

Нет

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

  • DESKTOP – для загрузки страниц, вёрстка которых предназначена для отображения на экранах ПК (в архиве страниц платёжного интерфейса будет осуществляться поиск страниц с названиями payment_<locale>.html и errors_<locale>.html).
  • MOBILE – для загрузки страниц, вёрстка которых предназначена для отображения на экранах мобильных устройств (в архиве страниц платёжного интерфейса будет осуществляться поиск страниц с названиями mobile_payment_<locale>.html и mobile_errors_<locale>.html).
  • Если магазин создал страницы платёжного интерфейса, добавив в название файлов страниц произвольные префиксы, передайте значение нужного префикса в параметре pageView для загрузки соответствующей страницы. Например, при передаче значения iphone в архиве страниц платёжного интерфейса будет осуществляться поиск страниц с названиями iphone_payment_<locale>.html и iphone_error_<locale>.html.

Где:

  • locale – язык страницы в кодировке ISO 639-1. Например, ru для русского или en для английского.

Если параметр отсутствует, либо не соответствует формату, то по умолчанию считается pageView=DESKTOP.

clientId

ANS..255

Нет

Номер (идентификатор) клиента в системе магазина. Используется для реализации функционала связок. Может присутствовать, если магазину разрешено создание связок.

Указание этого параметра при платежах по связке необходимо - в противном случае платёж будет неуспешен.

merchantLogin

AN..255

Нет

Чтобы зарегистрировать заказ от имени дочернего продавца, укажите его логин в этом параметре.

jsonParams

Строка

Нет

Блок для передачи дополнительных параметров продавца. Поля дополнительной информации для последующего хранения, передаются в следующем виде.

{name1:value1,…,nameN:valueN}

Эти поля могут быть переданы в процессинг банка для последующего отображения в реестрах.

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

Если для продавца настроена отправка уведомлений покупателю, адрес электронной почты покупателя должен передаваться в этом блоке в параметре с именем email. При указании «showLoyalty»:«false» взаимодействие с сервисом лояльности осуществляться не будет.

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

  • «email» - если передать адрес электронной почты покупателя, он будет отображён на платёжной странице;
  • «phone» (обязательное поле) - если передать номер сотового телефона покупателя, он будет отображён на платёжной странице. Имеет ограничение по длине: от 7 до 15.

В параметре запрещено передавать зарезервированные имена (в случае их передачи заказ может быть отклонен):

  • sbrf_spasibo:amount_bonus
  • sbrf_sbermiles:amount_bonus
  • loyaltyId
  • overridenClientId

sessionTimeoutSecs

N..9

Нет

Продолжительность жизни заказа в секундах.

В случае если параметр не задан, будет использовано значение, указанное в настройках мерчанта или время по умолчанию (1200 секунд = 20 минут).

Если в запросе присутствует параметр expirationDate, то значение параметра sessionTimeoutSecs не учитывается.

expirationDate

UTC

Нет

Дата и время окончания жизни заказа. Формат: yyyy-MM-ddTHH:mm:ss.

Если этот параметр не передаётся в запросе, то для определения времени окончания жизни заказа используется sessionTimeoutSecs.

bindingId

AN..255

Нет

Идентификатор созданной ранее связки. Может использоваться, только если у продавца есть разрешение на работу со связками. Если этот параметр передаётся в данном запросе, то это означает:
1. Данный заказ может быть оплачен только с помощью связки;
2. Плательщик будет перенаправлен на платёжную страницу, где требуется только ввод CVC.

dummy

N4

Нет

Атрибут для управления скидкой по рассрочке на «заглушке» тестовой среды.
При передаче:

  • dummy=true – на «заглушке» тестовой среды применяется скидка по рассрочке в размере 5%, вне зависимости от выбранного срока;
  • dummy=false – на «заглушке» тестовой среды не применяется скидка по рассрочке.


Важно! В боевой среде по умолчанию скидка по рассрочке всегда применяется на стороне Банка. Если вам необходимо рассчитывать скидку самостоятельно, направьте запрос на корректировку настроек в поддержку через Личный кабинет партнера.

orderBundle

Не актуально

Да

Блок, содержащий корзину товаров заказа. Описание его атрибутов представлено ниже.

(Перейти к описанию.)

taxSystem

N..2

Нет

Система налогообложения, доступны следующие значения:

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

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

autocompletionDate

ANS..19

Нет

Дата и время автозавершения двухстадийного платежа в следующем формате

2017-12-29T13:02:51

Чтобы подключить эту функциональность, обратитесь в службу технической поддержки.

autoReverseDate

ANS..19

Нет

Дата и время автоотмены авторизации (двухстадийного платежа) в следующем формате

2022-06-23T13:02:51

Чтобы подключить эту функциональность, обратитесь в службу технической поддержки.

additionalOfdParams

(Перейти к описанию.)

Нет

Некоторые параметры блока additionalOfdParams дублируют параметры блока cartItems.items.itemAttributes. Блок additionalOfdParams применяется ко всем позициям заказа, тогда как cartItems.items.itemAttributes применяется к индивидуальным позициям. Если в блоках additionalOfdParams и cartItems.items.itemAttributes будут переданы разные значения, то приоритетным значением будет то, которое было передано в cartItems.items.itemAttributes, то есть — для индивидуальной позиции.

Передача этого блока возможна только при использовании следующих ОФД:

  • АТОЛ;
  • Бизнес.Ру;
  • Эвотор.

billingPayerData

См. описание

Нет

Блок c регистрационными данными клиента (адрес, почтовый индекс), необходимыми для прохождения проверки адреса в рамках сервисов AVS/AVV.

Обязателен, если активна соответствующая пермиссия для мерчанта («Разрешено использование AVS/AVV»).

billingPayerData

Параметры блока billingPayerData

Название Тип Обязательно Описание

billingCity

AN..50

Нет

Город, зарегистрированный по конкретной карте у Банка Эмитента

billingCountry

AN..50

Нет

billingAddressLine1

AN..50

Нет

Адрес, зарегистрированный по конкретной карте у Банка Эмитента

Строка 1.

Обязательно, если у Мерчанта активирована пермиссия «Разрешено использование AVS/AVV».

billingAddressLine2

AN..50

Нет

Адрес, зарегистрированный по конкретной карте у Банка Эмитента

Строка 2.

billingAddressLine3

AN..50

Нет

Адрес, зарегистрированный по конкретной карте у Банка Эмитента

Строка 3.

billingPostalCode

AN..50

Нет

Почтовый индекс, зарегистрированный по конкретной карте у Банка Эмитента.

Обязательно, если у Мерчанта активирована пермиссия «Разрешено использование AVS/AVV».

billingState

AN..50

Нет

Штат, зарегистрированный по конкретной карте у Банка Эмитента (ISO 3166-2)

additionalOfdParams

additionalOfdParams состоит из следующих элементов.

Название Тип Обязательно Описание Версия ФФД

agent_info.type

N..2

Обязателен, только если передан объект agent_info.

Тип агента, возможно одно из следующих значений:

  • 1 - банковский платёжный агент;
  • 2 - банковский платёжный субагент;
  • 3 - платёжный агент;
  • 4 - платёжный субагент;
  • 5 - поверенный;
  • 6 - комиссионер;
  • 7 - иной агент.

1.05 и более поздние версии.

agent_info.paying.operation

ANS..24

Нет

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

1.05 и более поздние версии.

agent_info.paying.phones

массив ANS..19

Нет

Массив телефонов платёжного агента в формате +N.

1.05 и более поздние версии.

agent_info.paymentsOperator.phones

Массив ANS..19

Нет

Массив телефонов оператора по приёму платежей в формате +N.

1.05 и более поздние версии.

agent_info.MTOperator.address

ANS..256

Нет

Адрес оператора перевода.

1.05 и более поздние версии.

agent_info.MTOperator.inn

N10..12

Нет

ИНН оператора перевода.

1.05 и более поздние версии.

agent_info.MTOperator.name

ANS..64

Нет

Наименование оператора перевода.

1.05 и более поздние версии.

agent_info.MTOperator.phones

Массив ANS..19

Нет

Массив телефонов оператора перевода в формате +N.

1.05 и более поздние версии.

supplier_info.phones

Maccив ANS..19

Нет

Массив телефонов поставщика в формате +N.

1.05 и более поздние версии.

cashier

A..256

Нет

ФИО кассира.

1.05 и более поздние версии.

additional_check_props

ANS..16

Нет

Дополнительный реквизит чека.

1.05 и более поздние версии.

additional_user_props.name

ANS..24

Нет

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

1.05 и более поздние версии.

additional_user_props.value

ANS..24

Нет

Значение дополнительного реквизита пользователя.

1.05 и более поздние версии.

cashier_inn

N..12

Нет

ИНН кассира

1.2 и более поздние версии.

client.address

ANS..256

Нет

Адрес покупателя (клиента).

1.2 и более поздние версии.

client.birth_date

NS10

Нет

Дата рождения покупателя (клиента) в формате «dd.mm.yyyy»

1.2 и более поздние версии.

client.citizenship

N3

Нет

Числовой код страны, гражданином которой является покупатель (клиент). Код страны указывается в соответствии с Общероссийским классификатором стран мира ОКСМ.

1.2 и более поздние версии.

client.document_code

N2

Нет

Числовой код вида документа, удостоверяющего личность (например, 21 - паспорт гр. РФ).

1.2 и более поздние версии.

client.passport_number

NS11

Нет

Серия и номер паспорта плательщика: 1111 222222

1.2 и более поздние версии.

client.email

ANS..64

Нет

Электронный адрес покупателя. Обязательно должно быть заполнено строго одно из полей: email или phone.

1.2 и более поздние версии.

client.phone

NS..19

Нет

Телефон покупателя. Вместе с кодом страны без пробелов и дополнительных символов, кроме символа «+» (номер «+371 2 1234567» необходимо передать как «+37121234567»). Обязательно должно быть заполнено строго одно из полей: email или phone.

1.2 и более поздние версии.

client.inn

N12

Нет

ИНН покупателя.

1.2 и более поздние версии.

client.name

ANS..256

Нет

Наименование покупателя (клиента).

1.2 и более поздние версии.

operatingCheckProps.name

ANS

Нет

Идентификатор операции Принимает значения «0» до определения значения реквизита ФНС России.

1.2 и более поздние версии.

operatingCheckProps.name

ANS

Нет

Идентификатор операции Принимает значения «0» до определения значения реквизита ФНС России.

1.2 и более поздние версии.

operatingCheckProps.timestamp

NS19

Нет

Дата и время операции в формате: dd.mm.yyyy HH:MM:SS

1.2 и более поздние версии.

operatingCheckProps.value

ANS..64

Нет

Данные операции.

1.2 и более поздние версии.

sectoralCheckProps.date

NS10

Нет

Дата нормативного акта федерального органа исполнительной власти, регламентирующего порядок заполнения реквизита «значение отраслевого реквизита», в формате: dd.mm.yyyy

1.2 и более поздние версии.

sectoralCheckProps.federalId

ANS

Нет

Идентификатор ФОИВ. Должно принимать одно из значений справочника ФОИВ.

1.2 и более поздние версии.

sectoralCheckProps.number

N..32

Нет

Номер нормативного акта федерального органа исполнительной власти, регламентирующего порядок заполнения реквизита «значение отраслевого реквизита»

1.2 и более поздние версии.

sectoralCheckProps.value

ANS..256

Нет

Состав значений, определенных нормативным актом федерального органа исполнительной власти

1.2 и более поздние версии.

orderBundle

orderBundle состоит из следующих элементов.

Название Тип Обязательно Описание

orderCreationDate

ANS..21

Нет

Дата создания заказа в формате YYYY-MM-DDTHH:mm:ss.

customerDetails

Не актуально

Нет

Блок с атрибутами данных о покупателе. Описание его атрибутов представлено ниже.

(Перейти к описанию.)

cartItems

Не актуально

Да

Блок с атрибутами товарных позиции корзины товаров. Описание его атрибутов представлено ниже.

(Перейти к описанию.)

installments

Не акутально

Условно
Обязательно при предоставлении покупателю возможности интернет-кредитования

Блок, в котором указаны параметры типа интернет-кредитования. Описание представлено ниже.

(Перейти к описанию.)

installments

Параметры блока installments.

Название Тип Обязательно Описание

productType

A..11

Да

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

  • CREDIT - кредит;
  • INSTALLMENT - рассрочка.

productID

ANS..12

Да

Для функциональности интернет-кредитования укажите значение 10.

rightTerms

ANS…255

Нет

Желаемый срок кредитования в месяцах. Возможна передача нескольких значений через запятую. Атрибут передается, если выбран productType = INSTALLMENT.

  • Если параметр заполнен, то клиенту будут доступны только указанные в параметре сроки оплаты. Например, если "rightTerms":[3,6,9], то клиенту будут доступны для выбора сроки 3, 6 или 9 месяцев.
  • Если параметр не заполнен, то клиенту будут доступны все ранее утвержденные с банком сроки.

customerDetails

Обязательность параметров указана для использования в рамках блока. Если блок необязательный и в запросе отсутствует, то и входящие в него параметры не должны передаваться.

customerDetails состоит из следующих элементов.

Название Тип Обязательно Описание

email

ANS..40

Нет

Электронная почта покупателя, на которую будут отправлен кассовый чек. В большинстве ОФД отправка чека поддерживается только на один электронный адрес. Некоторые ОФД поддерживают отправку чека на несколько электронных адресов — в этом случае можно указать несколько адресов электронной почты через запятую и без пробелов. О возможности отправки чека на несколько адресов уточняйте у вашего ОФД. Обязательно следует передать один из двух параметров: email или phone.

phone

NS..12

Нет

Номер телефона клиента. Примеры:

  • +79000000000
  • 89000000000
  • 9000000000
  • 79000000000

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

При использовании АТОЛ фискализации параметр phone следует передавать в следующем формате:

Номер телефона необходимо передать вместе с кодом страны без пробелов и дополнительных символов кроме символа «» (номер «371 2 1234567» необходимо передать как »+37121234567«). Если номер телефона относится к России (префикс »+7«), то значение можно передавать без префикса (номер »+79251234567« можно передать как «9251234567»). Максимальная длина строки - 64 символа. В запросе должно быть обязательно заполнено одно из полей: email или phone.

contact

ANS..40

Нет

Способ связи с покупателем.

fullName

ANS..100

Нет

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

passport

ANS..100

Нет

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

inn

N..12

Нет

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

deliveryInfo

Не актуально

Нет

Блок с атрибутами адреса для доставки. Описание его атрибутов представлено ниже.

(Перейти к описанию.)

deliveryInfo

Обязательность параметров указана для использования в рамках блока. Если блок необязательный и в запросе отсутствует, то и входящие в него параметры не должны передаваться.

deliveryInfo состоит из следующих элементов.

Название Тип Обязательно Описание

deliveryType

ANS..20

Нет

Способ доставки.

country

A..2

Да

Двухбуквенный код страны доставки.

city

ANS..40

Да

Город доставки.

postAddress

ANS..255

Да

Адрес доставки.

cartItems

Обязательность параметров указана для использования в рамках блока. Если блок необязательный и в запросе отсутствует, то и входящие в него параметры не должны передаваться.

cartItems состоит из следующих элементов.

Название Тип Обязательно Описание

items

Не актуально

Да

Массив блоков, описывающих товарные позиции в корзине. Информация по каждой товарной позиции Корзины передаётся в отдельном блоке, входящем в состав items.

Не используйте внутри этого блока сочетание символов «‘)», в противном случае это приведёт к ошибке на стороне шлюза.

Действует ограничение: не более 100 товарных позиций.

(Перейти к описанию.)

items

items состоит из следующих элементов.

Название Тип Обязательно Описание

positionId

ANS..12

Да

Уникальный идентификатор товарной позиции внутри корзины заказа.

name

ANS..100

Да

Для функциональности интернет-кредитования необходимо указать описание товарной позиции в соответствии с каталогом Яндекс.Маркет с учетом следующих ограничений:

  • Не допускаются следующие слова и выражения: file, exec, insert, as, select, or, procedure, limit, order, and, or, by, asc, desc, delete, update, distinct, having, truncate, replace, handler, like, regex, tz_offset, to_timestamp_tz, bfilename, union, sql-command, abort, alter, analyze, begin, audit, checkpoint, close, cluster, comment, commit, copy, create, deallocate, declare, delete, drop, end, execute, explain, fetch, grant, insert, lock, move, noaudit, notify, prepare, reindex, rename, reset, revoke, rollback, savepoint, select, set, show, shutdown, start, truncate, unlisten, update, vacuum
  • Не допускаются следующие спецсимволы: % и \
  • Не допускаются символы кроме кириллицы и латиницы в unicode

itemDetails

Не актуально

Нет

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

(Перейти к описанию.)

quantity

N..18

Да

Элемент, описывающий общее количество товарных позиций одного positionId и их меру измерения. Описание его атрибутов представлено ниже.

(Перейти к описанию.)

itemAmount

N..18

Условно
Обязательно при предоставлении покупателю возможности интернет-кредитования

Сумма стоимости всех товарных позиций одного positionId в минимальных единицах валюты. itemAmount обязателен к передаче, только если не был передан параметр itemPrice. В противном случае передача itemAmount не требуется. Если же в запросе передаются оба параметра: itemPrice и itemAmount, то itemAmount должен равняться itemPrice * quantity, в противном случае запрос завершится с ошибкой.

При расчёте параметра itemAmount = itemPrice*quantity результат округляется до второго знака после десятичного разделителя. Например, если результат вычислений равен 100,255, то итоговый результат будет равен 100,26.

Если все позиции в запросе поставляются без оплаты (т. е. вы делаете покупателю подарок), в этом параметре следует указать значение 0.

itemPrice

N..18

Да

Стоимость одной товарной позиции в минимальных единицах валюты. Обязательно для продавцов с фискализацией.

  • itemPrice не может быть меньше 0.
  • itemPrice может передаваться как строкой, так и целочисленным типом.

Если позиция поставляется без оплаты (т. е. вы делаете покупателю подарок), то в этом параметре следует передать значение 0.

itemCurrency

N3

Условно
Обязательно при предоставлении покупателю возможности интернет-кредитования

Код валюты товарной позиции ISO 4217. Если не указан, считается равным валюте заказа.

itemCode

ANS..100

Да

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

Во всех методах передача артикула itemcode/code обязательна.

discount

Не актуально

Нет

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

(Перейти к описанию.)

agentInterest

Не актуально

Нет

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

(Перейти к описанию.)

tax

Не актуально

Да-для фискализации

Дополнительный тег с атрибутами описания налога. Описание вложенных тегов представлено ниже.

itemAttributes

См. описание.

Да

Тэг, предназначенный для передачи набора атрибутов товарной позиции. Атрибуты следует указывать следующим образом.

"itemAttributes":[{"name":"paymentMethod","value":"1"},{"name":"paymentObject","value":"1"}]

itemDetails

Обязательность параметров указана для использования в рамках блока. Если блок необязательный и в запросе отсутствует, то и входящие в него параметры не должны передаваться.

itemDetails состоит из следующих элементов.

Название Тип Обязательно Описание

itemDetailsParams

ANS..255

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

Дополнительная информация по товарной позиции. Представляет собой массив блоков, в каждом из которых передаётся информация об определённой характеристике товарной позиции.

(Перейти к описанию.)

itemDetailsParams

Обязательность параметров указана для использования в рамках блока. Если блок необязательный и в запросе отсутствует, то и входящие в него параметры не должны передаваться.

itemDetailsParams состоит из следующих элементов.

Название Тип Обязательно Описание

value

ANS..255

Условно. Обязательно при наличии параметра itemDetailsParams.

Дополнительная информация по товарной позиции.

name

ANS..255

Условно. Обязательно при наличии параметра itemDetailsParams.

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

discount

Обязательность параметров указана для использования в рамках блока. Если блок необязательный и в запросе отсутствует, то и входящие в него параметры не должны передаваться.

discount состоит из следующих элементов.

Название Тип Обязательно Описание

discountType

ANS..20

Да

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

discountValue

N..20

Да

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

agentInterest

Обязательность параметров указана для использования в рамках блока. Если блок необязательный и в запросе отсутствует, то и входящие в него параметры не должны передаваться.

agentInterest состоит из следующих элементов.

Название Тип Обязательно Описание

interestType

ANS..20

Да

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

interestValue

N..20

Да

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

Ниже представлены параметры блока tax.

Обязательность параметров указана для использования в рамках блока. Если блок необязательный и в запросе отсутствует, то и входящие в него параметры не должны передаваться.

Название Тип Обязательно Описание

taxType

N..2

Да

Ставка НДС, доступны следующие значения:

  • 0 – без НДС;
  • 1 – НДС по ставке 0%;
  • 2 – НДС чека по ставке 10%;
  • 4 – НДС чека по расчетной ставке 10/110;
  • 6 – НДС чека по ставке 20%;
  • 7 – НДС чека по расчётной ставке 20/120;
  • 10 – НДС чека по ставке 5%;
  • 11 – НДС чека по расчетной ставке 5/105;
  • 12 – НДС чека по ставке 7%;
  • 13 – НДС чека по расчетной ставке 7/107.

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

taxSum

N..18

Да

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

Ниже представлены параметры блока itemAttributes (см. пример и таблицу ниже).

«itemAttributes»:[{«name»:«paymentMethod»,«value»:«1»},{«name»:«paymentObject»,«value»:«1»}]

Название Тип Обязательно Описание Версия ФФД

paymentMethod

N..2

Да

Тип оплаты возможны следующие значения:

  • 1 - полная предварительная оплата до момента передачи предмета расчёта;
  • 2 - частичная предварительная оплата до момента передачи предмета расчёта;
  • 3 - аванс;
  • 4 - полная оплата в момент передачи предмета расчёта;
  • 5 - частичная оплата предмета расчёта в момент его передачи с последующей оплатой в кредит;
  • 6 - передача предмета расчёта без его оплаты в момент его передачи с последующей оплатой в кредит;
  • 7 - оплата предмета расчёта после его передачи с оплатой в кредит.

Приоритизация передачи значения происходит по следующему принципу (указано в убывающем порядке приоритета):

  1. Корзина заказа из API-запроса.
  2. Настройки фискализации в личном кабинете.
  3. Значения по умолчанию.

Для paymentMethod значением по умолчанию является 1 (полная предварительная оплата до момента передачи предмета расчета).

1.05 и более поздние версии.

paymentObject

N..2

Да

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

  • 1 - товар;
  • 2 - подакцизный товар;
  • 3 - работа;
  • 4 - услуга;
  • 5 - ставка азартной игры;
  • 6 - выигрыш азартной игры;
  • 7 - лотерейный билет;
  • 8 - выигрыш лотереи;
  • 9 - предоставление РИД;
  • 10 - платёж;
  • 11 - агентское вознаграждение;
  • 12 - составной предмет расчёта;
  • 13 - иной предмет расчёта;
  • 14 - имущественное право;
  • 15 - внереализационный доход;
  • 16 - страховые взносы: о суммах расходов, уменьшающих сумму налога (авансовых платежей) в соответствии с пунктом 3.1 статьи 346.21 Налогового кодекса Российской Федерации;
  • 17 - торговый сбор: о суммах уплаченного торгового сбора;
  • 18 - курортный сбор;

Указанные выше значения доступны для ФФД 1.05.

Для ФФД 1.2 список доступных значений пополняется также следующими значениями:

  • 30 - реализуемый подакцизный товар, подлежащий маркировке средством идентификации, не имеющем кода маркировки;
  • 31 - реализуемый подакцизный товар, подлежащий маркировке средством идентификации, имеющем кода маркировки;
  • 32 - реализуемый товар, подлежащий маркировке средством идентификации, не имеющим код маркировки, за исключением подакцизного товара;
  • 33 - реализуемый товар, подлежащий маркировке средством идентификации, имеющим код маркировки, за исключением подакцизного товара.

Приоритизация передачи значения происходит по следующему принципу (указано в убывающем порядке приоритета):

  1. Корзина заказа из API-запроса.
  2. Настройки фискализации в личном кабинете.
  3. Значения по умолчанию.

Для paymentObject значением по умолчанию является 1 (товар).

1.05 и более поздние версии.

nomenclature

ANS

да (если передан markQuantity)

Код товарной позиции.

Принимаются только первые 256 байт.

Возможные форматы для передачи:

  1. В шестнадцатеричном представлении - HEX кодировке с пробелами. Здесь необходимо cоответствие с маской 1 байт - пробел - 1 байт (два символа в шестнадцатеричном виде). Также необходимо указать код товара в соответствии с требованиями Честного Знака (максимальная длина - 95 символов).
  2. В виде строки, если передача идет не в HEX кодировке.

1.05 и более поздние версии.

markQuantity

(Перейти к описанию.)

Нет

Дробное количество маркированного товара.

1.2 и более поздние версии.

userData

ANS..64

Нет

Значение реквизита пользователя. Можно передавать только после согласования с ФНС.

1.05 и более поздние версии.

agent_info.type

N..2

Обязателен, только если передан объект agent_info.

Тип агента, возможно одно из следующих значений:

  • 1 - банковский платёжный агент;
  • 2 - банковский платёжный субагент;
  • 3 - платёжный агент;
  • 4 - платёжный субагент;
  • 5 - поверенный;
  • 6 - комиссионер;
  • 7 - иной агент.

1.05 и более поздние версии.

agent_info.paying.operation

ANS..24

Нет

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

1.05 и более поздние версии.

agent_info.paying.phones

массив ANS..19

Нет

Массив телефонов платёжного агента в формате +N.

1.05 и более поздние версии.

agent_info.paymentsOperator.phones

Массив ANS..19

Нет

Массив телефонов оператора по приёму платежей в формате +N.

1.05 и более поздние версии.

agent_info.MTOperator.phones

Массив ANS..19

Нет

Массив телефонов оператора перевода в формате +N.

1.05 и более поздние версии.

agent_info.MTOperator.name

ANS..64

Нет

Наименование оператора перевода.

1.05 и более поздние версии.

agent_info.MTOperator.address

ANS..256

Нет

Адрес оператора перевода.

1.05 и более поздние версии.

agent_info.MTOperator.inn

N10..12

Нет

ИНН оператора перевода.

1.05 и более поздние версии.

supplier_info.phones

Maccив ANS..19

Нет

Массив телефонов поставщика в формате +N.

1.05 и более поздние версии.

supplier_info.name

ANS..256

Нет

Наименование поставщика.

1.05 и более поздние версии.

supplier_info.inn

N10..12

Нет

ИНН поставщика.

1.05 и более поздние версии.

quantity

quantity состоит из следующих элементов.

Обязательность параметров указана для использования в рамках блока. Если блок необязательный и отсутствует, то и параметры в него входящие не должны передаваться.

Название Тип Обязательно Описание Версия ФФД

value

N..18

Да

Количество товарных позиций данного positionId. Для указания дробных чисел используйте десятичную точку.

Действует ограничение: не более 999 единиц.

Все версии.

measure

ANS..20

Да

Мера измерения количества товарной позиции.

Все версии.

Если ФФД версии 1.2 и более поздней, то здесь передаются параметры:

Название Тип Обязательно Описание Версия ФФД

value

N1

Да

Количество товарных позиций данного positionId. Для версии ФФД 1.2+ значение всегда 1.

1.2 и более поздние версии.

measure

N..3

Да

Единица измерения количества предмета расчета. При ФФД версии 1.2+ , если переданы параметры nomenclature и markQuantity, значение всегда 0. В остальных случаях принимает значения

1.2 и более поздние версии.

Возможные значения measure

Значение Описание
0 Применяется для предметов расчета, которые могут быть реализованы поштучно или единицами (а также в случае, если предметом расчета является товар, подлежащий обязательной маркировке средством идентификации (передан mark_code))
10 Грамм
11 Килограмм
12 Тонна
20 Сантиметр
21 Дециметр
22 Метр
30 Квадратный сантиметр
31 Квадратный дециметр
32 Квадратный метр
40 Миллилитр
41 Литр
42 Кубический метр
50 Киловатт час
51 Гигакалория
70 Сутки (день)
71 Час
72 Минута
73 Секунда
80 Килобайт
81 Мегабайт
82 Гигабайт
83 Терабайт
255 Применяется при использовании иных мер измерения

markQuantity

Параметры тэга markQuantity:

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

Название Тип Обязательно Описание

numerator

N..12

да

Числитель дробной части предмета расчета.

denominator

N..12

да

Знаменатель дробной части предмета расчета.

Параметры ответа

Параметры ответа представлены в таблице ниже.

Название Тип Обязательно Описание

orderId

ANS36

Нет

Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует если регистрация заказа не удалась по причине ошибки, детализированной в ErrorCode.

formUrl

AN..512

Нет

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

Чтобы получить возможность принимать оплату этим способом, у вас должны быть соответствующие полномочия в системе. В случае сомнений оставить обращение и получить быстрое решение можно в личном кабинете в разделе «Поддержка».

errorCode

N..2

Нет

Код ошибки. Может отсутствовать, если результат не привёл к ошибке.

errorMessage

AN..512

Нет

Описание ошибки на языке, переданном в параметре language в запросе.

Примеры

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

amount=3200000&currency=643&returnUrl=https://ya.ru&description=test_order&orderBundle={"cartItems":{"items":[{"agentInterest":{"interestType":"3","interestValue":"2"},"discount":{"discountType":"percent","discountValue":"5"},"itemAmount":"3000000","itemCode":"123","itemCurrency":"643","itemDetails":{},"itemPrice":"3000000","name":"position_1","positionId":"1","quantity":{"measure":"kg","value":1}},{"agentInterest":{"interestType":"3","interestValue":"2"},"discount":{"discountType":"percent","discountValue":"5"},"itemAmount":"100000","itemCode":"456","itemCurrency":"643","itemDetails":{},"itemPrice":"50000","name":"position_2","positionId":"2","quantity":{"measure":"шт.","value":2}},{"agentInterest":{"interestType":"3","interestValue":"2"},"discount":{"discountType":"percent","discountValue":"5"},"itemAmount":"100000","itemCode":"789","itemCurrency":"643","itemDetails":{},"itemPrice":"100000","name":"position_3","positionId":"3","quantity":{"measure":"шт.","value":1}}]},"customerDetails":{"contact":"Ivan","deliveryInfo":{"city":"Moscow","country":"RU","deliveryType":"courier","postAddress":"Адрес доставки"},"email":"test@mail.com","phone":"79032177777"},"installments":{"productID":"10","productType":"CREDIT"},"orderCreationDate":"2021-07-22T13:51:00"}&failUrl=https://aboba.com&userName=testuser-api&password=test_password

Пример ответа

{"operations":null,"errorCode":0,"errorMessage":null,"formUrl":"https://secure-payment-gateway.ru/sbercredit/rbs-common.html?mdOrder=b0d3767d-d67c-764d-a493-5cd404b41105&language=ru&dummy=true","orderId":"b0d3767d-d67c-764d-a493-5cd404b41105"}

Коды ошибок

Значение Описание
1 Заказ с таким номером уже обработан
1 Неверный номер заказа
3 Неизвестная валюта
4 Номер заказа не может быть пуст
4 Имя мерчанта не может быть пустым
4 Отсутствует сумма
4 URL возврата не может быть пуст
4 Пароль не может быть пуст
5 Неверно указано значение одного из параметров
5 Доступ запрещён
5 Пользователь отключён
7 Системная ошибка
8 Отсутствие обязательного параметра Корзины
8 Валюта в Корзине не совпадает с валютой заказа
8 Сумма товарных позиций в Корзине не совпадает с общей суммой заказа
8 Неверный формат Корзины
8 Слишком большое либо слишком маленькое значение quantity