Структуры данных
Основные
Базовая структура ответа
| Параметр |
Свойства |
Описание |
OperationState |
OBJECT REQUIRED |
Статус выполнения запроса. |
OperationId |
GUID OPTIONAL |
Номер операции запроса. |
EshopId |
INT OPTIONAL |
Номер магазина. Можно найти в личном кабинете, в разделе магазины. |
Result |
OBJECT REQUIRED |
Результат выполнения запроса. Объект результата зависит от метода API. |
Статус выполнения запроса
| Параметр |
Свойства |
Описание |
Code |
INT REQUIRED |
Код статуса. Допустимые значения:0 - успешно обработан.1 - в процессе выполнения.2 - ошибка.
|
Desc |
STRING REQUIRED |
Описание. |
Статус выполнения операции
| Параметр |
Свойства |
Описание |
Code |
INT REQUIRED |
Код статуса. Допустимые значения:0 - успешно обработан.1 - обработан с предупреждениями.2 - аутентификация не пройдена.3 - ошибка вызова.
|
Desc |
STRING REQUIRED |
Описание. |
ErrorSourceParam |
STRING OPTIONAL |
Исходный параметр с ошибкой. |
Статус выполнения операции по платежу
| Параметр |
Свойства |
Описание |
Code |
INT REQUIRED |
Код статуса выполнения. Допустимые значения:0 - успешно обработан.1 - обработан с предупреждениями.2 - особый вид ошибок.
10 - ошибка сервера.11 - незащищенное соединение. Отправляйте запрос по HTTPS.
101 - в настройках магазина не выбран протокол обмена.150 - неверно передан параметр EshopId.151 - неверно передан параметр InvoiceId.152 - обязательно должен быть передан либо EshopId, либо InvoiceId.153 - неверно передан параметр InputType.154 - не передан обязательный параметр Hash или передан неверно.155 - не передан обязательный параметр Amount или передан неверно.156 - неверно передан параметр Preferences.157 - не передан обязательный параметр RecipientAmount или передан неверно.158 - не передан обязательный параметр RecipientCurrency или передан неверно.159 - не передан обязательный параметр Email или передан неверно.160 - неверно передан параметр ServiceName.161 - не передан обязательный параметр UserName или передан неверно.162 - неверно передан параметр SuccessUrl.163 - неверно передан параметр FailUrl.164 - неверно передан параметр BackUrl.165 - неверно передан параметр ResultUrl.166 - неверно передан параметр ReturnUrl.167 - неверно передан параметр ExpireDate.168 - неверно передан параметр HoldMode.169 - параметр(ы) UserFields передан(ы) неверно.170 - не передан обязательный параметр OrderId или передан неверно.171 - тестовый счет можно оплатить только способом "Со счёта IntellectMoney".172 - неверно передан параметр SecretKey.173 - неверно передан параметр Action.174 - неверно передан параметр OperationAmount.175 - обязательно должен быть передан InvoiceId, либо OrderId.176 - не передан обязательный параметр IpAddress или передан неверно.178 - счет уже был оплачен ранее.179 - неверно передан параметр Language.180 - неверно передан параметр OnlinePaymentCryptogram.181 - неверно передан параметр AdditionalParams.182 - неверно передан параметр Value.183 - неверно передан параметр EventName.184 - неверно передан параметр InitPaymentId.
200 - не передан обязательный параметр PinCode или передан неверно.201 - не передан обязательный параметр UserToken или передан неверно.202 - данный счет не принадлежит владельцу кошелька IntellectMoney.203 - в кошельке IntellectMoney нет подходящего счета с нужной валютой.204 - для проведения оплаты необходимо пройти идентификацию в личном кабинете IntellectMoney.205 - превышен лимит на оплату для кошелька IntellectMoney.206 - пополнение неперсонифицированных кошельков с предоплаченных карт запрещено.250 - не передан обязательный параметр Pan или передан неверно.251 - не передан обязательный параметр Cvv или передан неверно.252 - не передан обязательный параметр CardHolder или передан неверно.253 - не передан обязательный параметр ExpiredYear или передан неверно.254 - не передан обязательный параметр ExpiredMonth или передан неверно.255 - не передан обязательный параметр ActivationAmount или передан неверно.256 - Карта плательщика заблокирована.257 - счет в неверном статусе. оплата невозможна.258 - есть незавершенные платежи. Дождитесь обработки.259 - платеж запрещен.260 - предположительно, Вы указали номер карты в поле, которое будет храниться в нешифрованном виде!
300 - неверно передан параметр Pparameter.301 - неверно передан параметр Inn.302 - неверно передан параметр Residentofrussia.303 - неверно передан параметр Series.304 - неверно передан параметр Number.350 - неверно переданы новые позиции по чеку.351 - форма оплаты удалена. Невозможно выставить счет на удаленную форму. Обратитесь в администрацию магазина.352 - форма оплаты удалена. Невозможно оплатить счет на удаленную форму. Обратитесь в администрацию магазина.353 - сумма платежа была изменена или передана неверно.354 - оплата сплитованного счета сабмерчанта запрещена. Оплата счета произойдет автоматически после оплаты счета мастер мерчанта.355 - не передан обязательный параметр Phone или передан неверно.356 - не передан обязательный параметр Sms или передан неверно.357 - найдено несколько записей с указанным OrderId. Для точного поиска необходимо передать InvoiceId.
|
Desc |
STRING REQUIRED |
Описание. |
ErrorSourceParam |
STRING OPTIONAL |
Исходный параметр с ошибкой. |
Данные токена-пользователя (UserTokenData)
Денежная сумма
| Параметр |
Свойства |
Описание |
Amount |
DECIMAL REQUIRED |
Сумма. Формат: десятичное число с двумя знаками после точки. |
Currency |
STRING REQUIRED |
Валюта. Допустимые значения:
RUB и RUR - для платежей в рублях.TST - для тестовых платежей.USD - для платежей в американских долларах.EUR - для платежей в евро.
|
Платежи
Данные о создании СКО (CreateInvoiceData)
Способ оплаты
| Параметр |
Свойства |
Описание |
Id |
INT REQUIRED |
Номер способа оплаты. |
Amount |
OBJECT REQUIRED |
Денежная сумма. |
InputType |
STRING REQUIRED |
Тип оплаты. Допустимые значения:InnerPayment - внутренний перевод.Acquiring - оплата с банковской карты.BNPL - оплата в рассрочку.Sbp - оплата через СБП.MirPay - оплата через Мир Пэй.SberPay - оплата через Сбер Пэй.GazpromPay - оплата через Газпром Пэй.
|
Preference |
STRING REQUIRED |
Способ оплаты. Определяет варианты оплаты, которые доступны для СКО. Допустимые значения:BankCard - банковская карта.BNPL - рассрочка.Sbp - СБП.MirPay - Мир Пэй.SberPay - Сбер Пэй.GazpromPay - Газпром Пэй.
|
PreferenceTypes |
OBJECT REQUIRED |
Список групп способов оплаты. Допустимые значения:All - все.Popular - популярные.Online - онлайн.NonComission - без комиссии.Flash - мгновенные.
|
ServiceTimeOfEnrollmentType |
STRING REQUIRED |
Сроки зачисления. Допустимые значения:None - до 30 рабочих дней.Flash - мгновенно.FiveDays - до 5 рабочих дней.ThreeDays - до 3 рабочих дней.
|
Commission |
DECIMAL REQUIRED |
Сумма комиссии. Формат: десятичное число с двумя знаками после точки. |
IsVisible |
BOOLEAN REQUIRED |
Статус отображения. |
IsActive |
BOOLEAN REQUIRED |
Статус работы. |
Position |
INT REQUIRED |
Приоритет. |
Данные о счёте (BankCardPaymentStateData)
| Параметр |
Свойства |
Описание |
State |
OBJECT REQUIRED |
Статус выполнения операции. |
PaymentStep |
STRING OPTIONAL |
Статус платежа. Допустимые значения:Ok - успешно завершен (Счет оплачен).Created - создан.InProcess - в обработке.SendTo3DS - отправлен на 3DS.ActivationPayment - отправлен на активационный платеж.Error - ошибка платежа.
|
Message |
STRING OPTIONAL |
Текстовое представление последнего статуса операции в банке (RC). |
Form3DS |
STRING OPTIONAL |
Обычно это HTML, выданный эмитентом для прохождения процедуры прохождения 3DS. |
Rrn |
STRING OPTIONAL |
Уникальный номер банковской транзакции. |
Информация о счёте (PurchaseInfoData)
| Параметр |
Свойства |
Описание |
Invoice |
OBJECT REQUIRED |
Данные о СКО. |
Eshop |
OBJECT REQUIRED |
Данные о магазине. |
SuccessUrl |
STRING REQUIRED |
Адрес успешного платежа. URL-адрес, на который происходит перенаправление плательщика с платежной страницы после успешной оплаты. |
BackUrl |
STRING REQUIRED |
Адрес возврата в магазин. URL-адрес кнопки «Вернуться в магазин» на платёжной странице. |
UserPaymentFormInfo |
OBJECT REQUIRED |
Платежная форма. |
Данные о СКО (InvoiceData)
| Параметр |
Свойства |
Описание |
InvoiceId |
LONG REQUIRED |
Номер СКО. |
LeftToPayAmount |
OBJECT REQUIRED |
Денежная сумма. |
TotalAmount |
OBJECT REQUIRED |
Денежная сумма с комиссией. |
InvoicePayerAmount |
OBJECT REQUIRED |
Сумма заказа в валюте. |
OrderId |
STRING REQUIRED |
Номер покупки. Внутренний номер покупки из вашей системы (интернет-магазина). По умолчанию в ра |