Перейти к содержанию

Структуры данных


Основные

Базовая структура ответа

Параметр Свойства Описание
OperationState OBJECT REQUIRED Статус выполнения запроса.
OperationId GUID OPTIONAL Номер операции запроса.
EshopId INT OPTIONAL Номер магазина.
Можно найти в личном кабинете, в разделе магазины.
Result OBJECT REQUIRED Результат выполнения запроса.
Объект результата зависит от метода API.

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

Параметр Свойства Описание
Code INT REQUIRED Код статуса.
Допустимые значения:
  1. 0 - успешно обработан.
  2. 1 - в процессе выполнения.
  3. 2 - ошибка.
Desc STRING REQUIRED Описание.

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

Параметр Свойства Описание
Code INT REQUIRED Код статуса.
Допустимые значения:
  1. 0 - успешно обработан.
  2. 1 - обработан с предупреждениями.
  3. 2 - аутентификация не пройдена.
  4. 3 - ошибка вызова.
Desc STRING REQUIRED Описание.
ErrorSourceParam STRING OPTIONAL Исходный параметр с ошибкой.

Статус выполнения операции по платежу

Параметр Свойства Описание
Code INT REQUIRED Код статуса выполнения.
Допустимые значения:
  1. 0 - успешно обработан.
  2. 1 - обработан с предупреждениями.
  3. 2 - особый вид ошибок.

  4. 10 - ошибка сервера.
  5. 11 - незащищенное соединение. Отправляйте запрос по HTTPS.

  6. 101 - в настройках магазина не выбран протокол обмена.
  7. 150 - неверно передан параметр EshopId.
  8. 151 - неверно передан параметр InvoiceId.
  9. 152 - обязательно должен быть передан либо EshopId, либо InvoiceId.
  10. 153 - неверно передан параметр InputType.
  11. 154 - не передан обязательный параметр Hash или передан неверно.
  12. 155 - не передан обязательный параметр Amount или передан неверно.
  13. 156 - неверно передан параметр Preferences.
  14. 157 - не передан обязательный параметр RecipientAmount или передан неверно.
  15. 158 - не передан обязательный параметр RecipientCurrency или передан неверно.
  16. 159 - не передан обязательный параметр Email или передан неверно.
  17. 160 - неверно передан параметр ServiceName.
  18. 161 - не передан обязательный параметр UserName или передан неверно.
  19. 162 - неверно передан параметр SuccessUrl.
  20. 163 - неверно передан параметр FailUrl.
  21. 164 - неверно передан параметр BackUrl.
  22. 165 - неверно передан параметр ResultUrl.
  23. 166 - неверно передан параметр ReturnUrl.
  24. 167 - неверно передан параметр ExpireDate.
  25. 168 - неверно передан параметр HoldMode.
  26. 169 - параметр(ы) UserFields передан(ы) неверно.
  27. 170 - не передан обязательный параметр OrderId или передан неверно.
  28. 171 - тестовый счет можно оплатить только способом "Со счёта IntellectMoney".
  29. 172 - неверно передан параметр SecretKey.
  30. 173 - неверно передан параметр Action.
  31. 174 - неверно передан параметр OperationAmount.
  32. 175 - обязательно должен быть передан InvoiceId, либо OrderId.
  33. 176 - не передан обязательный параметр IpAddress или передан неверно.
  34. 178 - счет уже был оплачен ранее.
  35. 179 - неверно передан параметр Language.
  36. 180 - неверно передан параметр OnlinePaymentCryptogram.
  37. 181 - неверно передан параметр AdditionalParams.
  38. 182 - неверно передан параметр Value.
  39. 183 - неверно передан параметр EventName.
  40. 184 - неверно передан параметр InitPaymentId.

  41. 200 - не передан обязательный параметр PinCode или передан неверно.
  42. 201 - не передан обязательный параметр UserToken или передан неверно.
  43. 202 - данный счет не принадлежит владельцу кошелька IntellectMoney.
  44. 203 - в кошельке IntellectMoney нет подходящего счета с нужной валютой.
  45. 204 - для проведения оплаты необходимо пройти идентификацию в личном кабинете IntellectMoney.
  46. 205 - превышен лимит на оплату для кошелька IntellectMoney.
  47. 206 - пополнение неперсонифицированных кошельков с предоплаченных карт запрещено.
  48. 250 - не передан обязательный параметр Pan или передан неверно.
  49. 251 - не передан обязательный параметр Cvv или передан неверно.
  50. 252 - не передан обязательный параметр CardHolder или передан неверно.
  51. 253 - не передан обязательный параметр ExpiredYear или передан неверно.
  52. 254 - не передан обязательный параметр ExpiredMonth или передан неверно.
  53. 255 - не передан обязательный параметр ActivationAmount или передан неверно.
  54. 256 - Карта плательщика заблокирована.
  55. 257 - счет в неверном статусе. оплата невозможна.
  56. 258 - есть незавершенные платежи. Дождитесь обработки.
  57. 259 - платеж запрещен.
  58. 260 - предположительно, Вы указали номер карты в поле, которое будет храниться в нешифрованном виде!

  59. 300 - неверно передан параметр Pparameter.
  60. 301 - неверно передан параметр Inn.
  61. 302 - неверно передан параметр Residentofrussia.
  62. 303 - неверно передан параметр Series.
  63. 304 - неверно передан параметр Number.
  64. 350 - неверно переданы новые позиции по чеку.
  65. 351 - форма оплаты удалена. Невозможно выставить счет на удаленную форму. Обратитесь в администрацию магазина.
  66. 352 - форма оплаты удалена. Невозможно оплатить счет на удаленную форму. Обратитесь в администрацию магазина.
  67. 353 - сумма платежа была изменена или передана неверно.
  68. 354 - оплата сплитованного счета сабмерчанта запрещена. Оплата счета произойдет автоматически после оплаты счета мастер мерчанта.
  69. 355 - не передан обязательный параметр Phone или передан неверно.
  70. 356 - не передан обязательный параметр Sms или передан неверно.
  71. 357 - найдено несколько записей с указанным OrderId. Для точного поиска необходимо передать InvoiceId.
Desc STRING REQUIRED Описание.
ErrorSourceParam STRING OPTIONAL Исходный параметр с ошибкой.

Данные токена-пользователя (UserTokenData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
UserToken STRING OPTIONAL Токен-пользователя.

Денежная сумма

Параметр Свойства Описание
Amount DECIMAL REQUIRED Сумма.
Формат: десятичное число с двумя знаками после точки.
Currency STRING REQUIRED Валюта.
Допустимые значения:
  1. RUB и RUR - для платежей в рублях.
  2. TST - для тестовых платежей.
  3. USD - для платежей в американских долларах.
  4. EUR - для платежей в евро.

Платежи

Данные о создании СКО (CreateInvoiceData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
InvoiceId LONG OPTIONAL Номер СКО.
PaymentWays OBJECT OPTIONAL Список способов оплаты.

Способ оплаты

Параметр Свойства Описание
Id INT REQUIRED Номер способа оплаты.
Amount OBJECT REQUIRED Денежная сумма.
InputType STRING REQUIRED Тип оплаты.
Допустимые значения:
  1. InnerPayment - внутренний перевод.
  2. Acquiring - оплата с банковской карты.
  3. BNPL - оплата в рассрочку.
  4. Sbp - оплата через СБП.
  5. MirPay - оплата через Мир Пэй.
  6. SberPay - оплата через Сбер Пэй.
  7. GazpromPay - оплата через Газпром Пэй.
Preference STRING REQUIRED Способ оплаты.
Определяет варианты оплаты, которые доступны для СКО.
Допустимые значения:
  1. BankCard - банковская карта.
  2. BNPL - рассрочка.
  3. Sbp - СБП.
  4. MirPay - Мир Пэй.
  5. SberPay - Сбер Пэй.
  6. GazpromPay - Газпром Пэй.
PreferenceTypes OBJECT REQUIRED Список групп способов оплаты.
Допустимые значения:
  1. All - все.
  2. Popular - популярные.
  3. Online - онлайн.
  4. NonComission - без комиссии.
  5. Flash - мгновенные.
ServiceTimeOfEnrollmentType STRING REQUIRED Сроки зачисления.
Допустимые значения:
  1. None - до 30 рабочих дней.
  2. Flash - мгновенно.
  3. FiveDays - до 5 рабочих дней.
  4. ThreeDays - до 3 рабочих дней.
Commission DECIMAL REQUIRED Сумма комиссии.
Формат: десятичное число с двумя знаками после точки.
IsVisible BOOLEAN REQUIRED Статус отображения.
IsActive BOOLEAN REQUIRED Статус работы.
Position INT REQUIRED Приоритет.

Данные о платеже (BankCardPaymentStateData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
PaymentStep STRING OPTIONAL Статус платежа.
Допустимые значения:
  1. Ok - успешно завершен (Счет оплачен).
  2. Created - создан.
  3. InProcess - в обработке.
  4. SendTo3DS - отправлен на 3DS.
  5. ActivationPayment - отправлен на активационный платеж.
  6. Error - ошибка платежа.
Message STRING OPTIONAL Текстовое представление последнего статуса операции в банке (RC).
Form3DS STRING OPTIONAL Обычно это HTML, выданный эмитентом для прохождения процедуры прохождения 3DS.

Данные о действиях по покупке (PurchaseActionData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
Data STRING OPTIONAL Данные о статусе операции.
InvoiceRefundId INT OPTIONAL Номер возврата по СКО.

Данные о оплате (BankCardPaymentData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.

Данные по Mir Pay для оплаты по ссылке (GetLinkData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
UniversalLink STRING OPTIONAL Универсальная ссылка (HTTPS): открывает Mir Pay при наличии приложения, иначе — веб-страницу.
DeepLink STRING OPTIONAL Глубокая ссылка (URI-схема): прямой вызов приложения Mir Pay.

Рекуррентные платежи

Данные о выполнении операции по расписанию (ScheduleOperationData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
ScheduledOperation OBJECT OPTIONAL Данные операции по расписанию.

Данные о выполнении операций по расписанию (ScheduleOperationListData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
ScheduledOperationList OBJECT OPTIONAL Список операций по расписанию.

Данные операции по расписанию

Параметр Свойства Описание
CronOperationId GUID REQUIRED Номер операции по расписанию.
ObjectId LONG REQUIRED Номер исходного СКО.
CronOperationType STRING REQUIRED Тип операции по расписанию.
Всегда единица (Recurring (1)).
Params STRING REQUIRED Параметры СКО.
Параметры необходимые операции по расписанию для создания СКО:
{ "Amount": 1.00, "OrderId": "Покупка", "ServiceName": "Подписка", MerchantReceipt": null }, где:
  • Amount - сумма платежа, которую необходимо получить от покупателя. Минимальное значение 1.00. Формат: десятичное число с двумя знаками после точки, не использовать запятые и пробелы.
  • OrderId - номер покупки. Если OrderId должен отличаться от исходного СКО, необходимо передать этот параметр, иначе OrderId будет сгенерирован автоматически.
  • ServiceName - назначение платежа. Служит для описания товара или услуги.
  • MerchantReceipt - чек для онлайн-кассы. Подробнее о правилах формирования чека.
CreationDate STRING REQUIRED yyyy-MM-dd HH:mm:ss Дата создания операции.
ChangeDate STRING REQUIRED yyyy-MM-dd HH:mm:ss Дата изменения операции.
EndExecDate STRING OPTIONAL yyyy-MM-dd HH:mm:ss Дата окончания выполнения операции.
LastExecDate STRING OPTIONAL yyyy-MM-dd HH:mm:ss Дата последнего выполнения операции.
NextExecDate STRING OPTIONAL yyyy-MM-dd HH:mm:ss Дата следующего выполнения операции.
RepeatPlan STRING OPTIONAL План выполнения.
Задается в одном из двух форматов:
  1. Cron-выражение позволяет задавать сложные периоды выполнения операции.
    Пример запуска операции каждый день в 12:00 часов: 0 0 12 1/1 * ? *
    Для создания можно использовать онлайн-инструмент CronMaker.
  2. JSON поддерживает указание даты начала и периодов выполнения операции в удобочитаемом формате.
    Пример первого списания в 18:50 22 ноября 2023 года, последующие списания раз в 30 дней: { "StartAt": "2023-11-22T18:50:00+03:00", "PeriodLength": 30, "PeriodType": "Day" }
    Допустимые значения: Day, Week, Month.
RetryOnFailPlan STRING OPTIONAL План выполнения при ошибке.
Определяет, с какой частотой система будет автоматически повторять операцию в случае её неудачного выполнения.
Например, если указать значение 5 минут, система будет пытаться повторить операцию каждые 5 минут до тех пор, пока она не завершится успешно или не достигнет лимита параметра RetryOnFailCount.
Форматы:
  • Cron-выражение: 0 0/5 * 1/1 * ? *
  • JSON: { "PeriodLength": 5, "PeriodType": "Minute" }
    Допустимые значения: Minute, Hour, Day, Week, Month.
RetryOnFailCount STRING OPTIONAL Количество повторов выполнения при ошибке.
IsSingle BOOLEAN OPTIONAL Флаг, указывающий возможность параллельного выполнения операции.
Допустимые значения:
  • 0 - новая запланированная операция не будет запущена, пока не закончена предыдущая.
  • 1 - запланированная операция запускается независимо от статуса предыдущей.
FireOnSkip BOOLEAN OPTIONAL Флаг, указывающий необходимость создания всех запланированных операций, в случае непредвиденного пропуска операции.
Допустимые значения:
  • 0 - не создавать пропущенные, ранее запланированные операции.
  • 1 - создать пропущенные, ранее запланированные операции.
CronOperationState STRING REQUIRED Флаг, указывающий статус работы операции.
Допустимые значения:
  1. Active - работает.
  2. Disable - выключен.

Массовые выплаты

Данные по операции выплаты (PayoutOperationData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
PayoutOperationId GUID OPTIONAL Номер операции выплаты.
PayoutOperationState STRING OPTIONAL Статус операции выплаты.
Допустимые значения:
  1. Created - добавлена.
  2. SentToBank - создана заявка в банке.
  3. InProcess - заявка исполняется.
  4. Completed - успешно обработана.
  5. Failed - ошибка обработки.
  6. NotEnoughMoney - недостаточно средств.
  7. Deleted - удалена.
ErrorMessage STRING OPTIONAL Сообщение о причине ошибки.

Фискализация

Данные о создании чека (CashboxReceiptCreateData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
DocumentId STRING OPTIONAL Номер документа.
Для получения использовать методы: CreateReceipt, CreateReceiptCorrection.
CashBoxReceiptResponseData OBJECT OPTIONAL Данные по документу.

Данные по документу (CashboxReceiptResponseData)

Параметр Свойства Описание
ReceiptId INT OPTIONAL Номер документ в системе IntellectMoney.
Response STRING OPTIONAL Ответ от провайдера онлайн-кассы.
Id STRING OPTIONAL Номер документа.
Для получения использовать методы: CreateReceipt, CreateReceiptCorrection.
ResponseState STRING REQUIRED Статус документ.
Допустимые значения:
  1. None - статус отсутствует.
  2. Created - чек создан и добавлен в очередь на обработку. Пустое тело ответа.
  3. Ok - чек обработан. Есть тело ответа.
  4. BadRequest - переданные данные содержат ошибки валидации, либо подпись не прошла проверку.
  5. Conflict - чек с данным идентификатором уже был создан в системе. Пустое тело ответа.
  6. Accepted - чек создан и добавлен в очередь на обработку, но еще не обработан. Пустое тело ответа.
  7. NotFound - чек с указанным идентификатором не найден в системе. Пустое тело ответа.
  8. Unauthorized - клиентский сертификат не прошел проверку.
  9. ServerErrorRetryLater - сервер недоступен или внутренняя ошибка сервера.
  10. ServiceUnavailable - очередь документов переполнена.
  11. UnsupportedResponseFormat - ответ сервера не удалось распознать.
  12. HttpRequestError - ошибка отправки HTTP запроса (возможно разрыв соединения).
  13. GroupCodeAndTokenDontMatch - передана неверная группа устройств.
  14. CallbackWait - чек создан и добавлен в очередь на обработку и ожидает ответа от онлайн кассы (webhook).
  15. DocumentExpired - истекло время на обработку чека. Повторная отправка чека может нарушить налоговый период.
DeviceSN STRING OPTIONAL Заводской номер устройства пробившего чек.
DeviceRN STRING OPTIONAL Регистрационный номер устройства пробившего чек.
FSNumber STRING OPTIONAL Номер фискального накопителя.
OFDName STRING OPTIONAL Наименование ОФД.
OFDWebsite STRING OPTIONAL Web-сайт ОФД.
OFDInn STRING OPTIONAL ИНН ОФД.
FNSWebsite STRING OPTIONAL Web-сайт ФНС.
CompanyINN STRING OPTIONAL ИНН пользователя.
CompanyName STRING OPTIONAL Наименование пользователя.
DocumentNumber STRING OPTIONAL Номер ФД.
ShiftNumber INT OPTIONAL Номер смены.
DocumentIndex INT OPTIONAL Номер чека за смену.
ProcessedAt STRING OPTIONAL yyyy-MM-dd HH:mm:ss Время регистрации фискального документа в ФН.
Content OBJECT OPTIONAL Содержимое документа.
Change DECIMAL OPTIONAL Сдача.
Формат: десятичное число с двумя знаками после точки.
FP STRING OPTIONAL Фискальный признак.
Errors OBJECT OPTIONAL Список ошибок.

Содержимое документа

Параметр Свойства Описание
FFDVersion INT OPTIONAL Номер версии ФФД.
Type INT REQUIRED Признак расчета, тег 1054.
Допустимые значения:
  1. 1 - приход.
  2. 2 - возврат прихода.
  3. 3 - расход.
  4. 4 - возврат расхода.
CustomerContact STRING REQUIRED Телефон или электронный адрес покупателя, тег 1008.
Формат: +{Ц} или {С}@{C}.
Positions OBJECT REQUIRED Список предметов расчёта, тег 1059.
CheckClose OBJECT OPTIONAL Параметры закрытия документа.
AgentType INT OPTIONAL Признак агента, тег 1057.
Используется в ФФД 1.05.
Допустимые значения:
  1. 1 - банковский платежный агент.
  2. 2 - банковский платежный субагент.
  3. 4 - платежный агент.
  4. 8 - платежный субагент.
  5. 16 - поверенный.
  6. 32 - комиссионер.
  7. 64 - иной агент.

Предмет расчёта

Параметр Свойства Описание
Quantity STRING REQUIRED max 13 Количество предмета расчёта, тег 1023.
Минимальное значение 1.00.
Формат: десятичное число с точностью до 6 знаков после точки, не использовать запятые и пробелы.
Price STRING REQUIRED max 11 Цена за единицу предмета расчёта с учётом скидок и наценок, тег 1079.
Минимальное значение 1.00.
Формат: десятичное число с двумя знаками после точки, не использовать запятые и пробелы.
Tax INT REQUIRED 1-10 Ставка НДС, тег 1199.
Допустимые значения:
  1. 1 - ставка НДС 20%.
  2. 2 - ставка НДС 10%.
  3. 3 - ставка НДС расч. 20/120.
  4. 4 - ставка НДС расч. 10/110.
  5. 5 - ставка НДС 0%.
  6. 6 - НДС не облагается.
  7. 7 - ставка НДС 5%.
  8. 8 - ставка НДС 7%.
  9. 9 - ставка НДС расч. 5/105.
  10. 10 - ставка НДС расч. 7/107.
Text STRING REQUIRED max 128 Наименование предмета расчёта, тег 1030.
PaymentMethodType INT OPTIONAL 1-7 Признак способа расчёта, тег 1214.
Используется в ФФД 1.05, 1.2.
Допустимые значения:
  1. 1 - предоплата 100%.
  2. 2 - частичная предоплата.
  3. 3 - аванс.
  4. 4 - полный расчет (по умолчанию).
  5. 5 - частичный расчет и кредит.
  6. 6 - передача в кредит.
  7. 7 - оплата кредита.
PaymentSubjectType INT OPTIONAL const Признак предмета расчета, тег 1212.
Допустимые значения, которые используется в ФФД 1.05, 1.2:
  1. 1 - Товар (по умолчанию).
  2. 2 - Подакцизный товар.
  3. 3 - Работа.
  4. 4 - Услуга.
  5. 5 - Ставка азартной игры.
  6. 6 - Выигрыш азартной игры.
  7. 7 - Лотерейный билет.
  8. 8 - Выигрыш лотереи.
  9. 9 - Предоставление РИД.
  10. 10 - Платеж.
  11. 11 - Агентское вознаграждение.
  12. 12 - Выплата.
  13. 13 - Иной предмет расчета.
  14. 14 - Имущественное право.
  15. 15 - Внереализационный доход.
  16. 16 - Иные платежи и взносы.
  17. 17 - Торговый сбор.
  18. 18 - Туристический налог.
  19. 19 - Залог.
  20. 20 - Расход.
  21. 21 - Взносы на обязательное пенсионное страхование ИП.
  22. 22 - Взносы на обязательное пенсионное страхование.
  23. 23 - Взносы на обязательное медицинское страхование ИП.
  24. 24 - Взносы на обязательное медицинское страхование.
  25. 25 - Взносы на обязательное социальное страхование.
  26. 26 - Платеж казино.
  27. 27 - Выдача денежных средств.

Допустимые значения, которые используется в ФФД 1.2:
  1. 30 - АТНМ.
  2. 31 - АТМ.
  3. 32 - ТНМ.
  4. 33 - ТМ.
SupplierInfo OBJECT OPTIONAL Данные поставщика, тег 1224.
SupplierINN STRING OPTIONAL max 12 ИНН поставщика, тег 1226.
Используется в ФФД 1.05, 1.2.
Условия:
  • При передачи признака агента, тег 1222 - передается обязательно.
  • Передается по усмотрению в остальных случаях.
AgentType INT OPTIONAL 1-127 Признак агента, тег 1222.
Используется в ФФД 1.05, 1.2.
Допустимые значения:
  1. 1 - банковский платежный агент.
  2. 2 - банковский платежный субагент.
  3. 4 - платежный агент.
  4. 8 - платежный субагент.
  5. 16 - поверенный.
  6. 32 - комиссионер.
  7. 64 - иной агент.
MarkCode OBJECT OPTIONAL Данные о маркировки.
Используется в ФФД 1.2.

Данные поставщика

Параметр Свойства Описание
PhoneNumbers STRING OPTIONAL Телефон поставщика, тег 1171.
Используется в ФФД 1.05, 1.2.
Формат: массив строк длиной от 1 до 19 символов, +{Ц}.
Пример: ["+78000000000", "+78000000001"].
Name STRING OPTIONAL max 256 Наименование поставщика, тег 1225.
Используется в ФФД 1.05, 1.2.

Данные о маркировки

Параметр Свойства Описание
Code STRING REQUIRED max 223 Код маркировки, теги: 1305, 1306, 1163, 1300, 2000.
  1. Orande Data - код маркировки, как он был прочитан сканером.
    После проверки будет добавлен в тег 1163 как один из тэгов КТ GS1.М (тег 1305), или КТ КМК (тег 1306), или нераспознанный код товара (тег 1300).
PlannedStatus INT REQUIRED 1-6 Планируемый статус, тег 2003.
Допустимые значения:
  1. 1 - штучный товар, подлежащий обязательной маркировке средством идентификации, реализован.
  2. 2 - мерный товар, подлежащий обязательной маркировке средством идентификации, в стадии реализации.
  3. 3 - штучный товар, подлежащий обязательной маркировке средством идентификации, возвращен.
  4. 4 - часть товара, подлежащего обязательной маркировке средством идентификации, возвращена.
  5. 5 - штучный товар, подлежащий обязательной маркировке средством идентификации, в стадии реализации.
  6. 6 - мерный товар, подлежащий обязательной маркировке средством идентификации, реализован.
  7. 255 - статус товара, подлежащего бязательной маркировке средством идентификации, не изменился.

Параметры закрытия документа

Параметр Свойства Описание
Payments OBJECT REQUIRED Список оплат.
TaxationSystem INT REQUIRED const Система налогообложения, тег 1055.
Допустимые значения:
  1. 0 - общая (ОСН).
  2. 1 - упрощенная доход (УСН доход).
  3. 2 - упрощенная доход минус расход (УСН доход - расход).
  4. 4 - единый сельскохозяйственный налог (ЕСН).
  5. 5 - патентная система налогообложения (Патент).

Оплата

Параметр Свойства Описание
Type INT REQUIRED const Тип оплаты.
Допустимые значения:
  1. 1 - сумма по чеку наличными, тег 1031.
  2. 2 - сумма по чеку безналичными, тег 1081.
  3. 14 - сумма по чеку предоплатой (зачетом аванса и (или) предыдущих платежей), тег 1215.
  4. 15 - сумма по чеку постоплатой (в кредит), тег 1216.
  5. 16 - сумма по чеку (БСО) встречным предоставлением, тег 1217.
Amount STRING REQUIRED max 10 Сумма оплаты.
Минимальное значение 1.00.
Формат: десятичное число с двумя знаками после точки, не использовать запятые и пробелы.

Информация по счёту

Список СКО (InvoicesHistoryList)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
InvoicesHistoryList OBJECT OPTIONAL Список данных СКО.

История операции (PaymentsHistoryList)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
InvoicesHistoryList OBJECT OPTIONAL История операций.

Данные СКО

Параметр Свойства Описание
Id LONG REQUIRED Номер СКО.
State OBJECT REQUIRED Статус СКО.
Допустимые значения:
  • Created (0) - создан.
  • PartPaid (1) - частично оплачен.
  • Paid (2) - оплачен.
  • ToPaid (3) - в процессе обработки.
  • Refund (4) - возвращен.
  • Held (6) - захолдирован.
HoldModeFlag BOOLEAN REQUIRED Режим холдирования.
Временная блокировка денежных средств на банковской карте после оплаты. Сумма замораживается до подтверждения платежа или автоматически возвращается при отмене.
Допустимые значения:
  1. True (1) - холдирование включено.
  2. False (0) - холдирование выключено.
CreationDate STRING REQUIRED yyyy-MM-dd HH:mm:ss Дата создания СКО.
ChangeDate STRING REQUIRED yyyy-MM-dd HH:mm:ss Дата последнего изменения СКО.
ExpirationDate STRING REQUIRED yyyy-MM-dd HH:mm:ss Срок действия СКО.
Дата и время, до наступления которых счет доступен для оплаты. Если платеж не проведен в этот период, СКО автоматически отменяется, и дальнейшие попытки оплаты будут отклонены.
Amount OBJECT REQUIRED Сумма СКО.
CurrentAmount OBJECT REQUIRED Текущая сумма СКО.
  • Положительное значение при статусах PartPaid (1) и ToPaid (3).
  • Равно 0 при статусах Paid (2) и Held (6).
SurchargeAmount OBJECT REQUIRED Сумма СКО, которую осталось оплатить.
  • Положительное значение при статусе PartPaid (1).
  • Равно 0 при статусах Paid (2) и Held (6).
OriginalAmount OBJECT REQUIRED Первоначальная сумма СКО.
Comment STRING OPTIONAL Комментарий.
AdditionalInfo STRING OPTIONAL Дополнительная информация.
HistoryList OBJECT OPTIONAL История операций.
OwnerEmail STRING OPTIONAL Электронная почта покупателя.
OwnerFIO STRING OPTIONAL Имя покупателя.
PurchaseOrderId STRING OPTIONAL Номер покупки.
Внутренний номер покупки из вашей системы (интернет-магазина).
По умолчанию в расширенных настройках магазина на вкладке "Подключение магазина" включена опция "Принимать только уникальный номер покупки", что позволяет легко идентифицировать СКО.
EshopId INT REQUIRED Номер магазина.
Можно найти в личном кабинете, в разделе магазины.
HttpRequestErrorCount INT OPTIONAL Количество ошибок при отправки уведомлений на ResultUrl.
HttpRequests OBJECT OPTIONAL Список уведомлений отправленных на ResultUrl.
Rrn STRING OPTIONAL Уникальный номер банковской транзакции.
PurchaseData OBJECT OPTIONAL Данные о покупке.
InvoiceChangeAmountHistoryData OBJECT OPTIONAL История изменения суммы СКО.
FormType STRING OPTIONAL Тип формы оплаты.
  1. None - не установлен.
  2. IMAccount - в личный кабинет.
  3. PeerToPeer - на карту.
  4. Dynamic - динамический.
OrganizationName STRING REQUIRED Наименование организации.
Можно найти в личном кабинете на главной странице.
MerchantReceipt OBJECT OPTIONAL Чек для онлайн-кассы.
Подробнее о правилах формирования чека.
IsHaveCashboxReceipts BOOLEAN OPTIONAL Существуют ли кассовые чеки.
  1. False - нет.
  2. True - да.
ReceiptVatRate OBJECT OPTIONAL Словарь ставок НДС.
IsRecurrent BOOLEAN OPTIONAL Является ли СКО рекарринговым.
  1. False - нет.
  2. True - да.

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

Параметр Свойства Описание
Id LONG REQUIRED Идентификатор.
PaymentNumber LONG REQUIRED Номер транзакции.
State STRING REQUIRED Статус транзакции.
Допустимые значения:
  1. Created - создана.
  2. Confirm - подтверждена.
  3. Canceled - отменена.
  4. Refunded - возврат.
  5. Delayed - проверяется.
  6. AfterDelayed - проверяется.
CreationDate STRING REQUIRED yyyy-MM-dd HH:mm:ss Дата создания транзакции.
PaymentAmount OBJECT REQUIRED Сумма списания.
Формат: десятичное число с двумя знаками после точки.
RecipientAmount OBJECT REQUIRED Сумма зачисления.
Формат: десятичное число с двумя знаками после точки.
PaymentAccount LONG REQUIRED Счёт списания.
RecipientAccount LONG REQUIRED Счёт зачисления.
Comment STRING OPTIONAL Комментарий.
Description STRING OPTIONAL Описание.
Direction STRING OPTIONAL Направление средств.
Допустимые значения:
  1. Deposit - на депозит.
  2. Withdraw - с депозита.
PurchaseOrderId STRING OPTIONAL Номер покупки.
Внутренний номер покупки из вашей системы (интернет-магазина).
По умолчанию в расширенных настройках магазина на вкладке "Подключение магазина" включена опция "Принимать только уникальный номер покупки", что позволяет легко идентифицировать СКО.
AdditionalInfo STRING OPTIONAL Дополнительная информация.
InvoicePaymentType STRING OPTIONAL Тип транзакции.
Допустимые значения:
  1. None - не установлен.
  2. Entry - входящая.
  3. Purchase - финальная.
  4. Refund - возврат.
  5. FinEntry - финансовая.
InvoiceId STRING OPTIONAL Номер СКО.
RcCode STRING OPTIONAL Код ответа банка, принимающего платеж.
RcCodeUserDescription STRING OPTIONAL Описание ответа банка, принимающего платеж.
InputType STRING OPTIONAL Тип оплаты.
Допустимые значения:
  1. InnerPayment - внутренний перевод.
  2. Acquiring - оплата с банковской карты.
  3. BNPL - оплата в рассрочку.
  4. Sbp - оплата через СБП.
  5. MirPay - оплата через Мир Пэй.
  6. SberPay - оплата через Сбер Пэй.
  7. GazpromPay - оплата через Газпром Пэй.
ShortPan STRING OPTIONAL Короткий номер банковской карты (первые шесть и последние четыре цифры банковской карты).
Передача параметра в форме, предоставляется по запросу через менеджера.
Country STRING OPTIONAL Страна, в которой была выпущена банковская карта.
Формат: ISO 3166-1 alpha-3.
Передача параметра в форме, предоставляется по запросу через менеджера.
Bank STRING OPTIONAL Банк-эмитент.
Банк, выпустивший пластиковую карту.
Передача параметра в форме, предоставляется по запросу через менеджера.
IPAdress STRING OPTIONAL IPv4-адрес сайта, с которого выставляется платеж.
UserEmail STRING OPTIONAL Электронная почта покупателя.
CardHolder STRING OPTIONAL Имя и фамилия плательщика.
Comission DECIMAL OPTIONAL Комиссия.
Формат: десятичное число с двумя знаками после точки.
EshopName STRING OPTIONAL Наименование магазина.
Можно найти в личном кабинете, в разделе магазины.

Ставка НДС

Параметр Свойства Описание
Key STRING REQUIRED Ключ ставки НДС.
Допустимые значения:
  1. 1 - ставка НДС 20%.
  2. 2 - ставка НДС 10%.
  3. 3 - ставка НДС расч. 20/120.
  4. 4 - ставка НДС расч. 10/110.
  5. 5 - ставка НДС 0%.
  6. 6 - НДС не облагается.
  7. 7 - ставка НДС 5%.
  8. 8 - ставка НДС 7%.
  9. 9 - ставка НДС расч. 5/105.
  10. 10 - ставка НДС расч. 7/107.
Value STRING REQUIRED Значение ставки НДС.

Информация по СКО (InvoiceInfoData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
Eshop OBJECT OPTIONAL Информация по магазину.
Organization OBJECT OPTIONAL Информация по организации.
ListNotificationParams OBJECT OPTIONAL Данные уведомления.
InvoiceId LONG OPTIONAL Номер СКО.

Информация по магазину

Параметр Свойства Описание
EshopId INT REQUIRED Номер магазина.
Можно найти в личном кабинете, в разделе магазины.
EshopName STRING REQUIRED Наименование магазина.
Можно найти в личном кабинете, в разделе магазины.
Protocol STRING REQUIRED Протокол интеграции с IntellectMoney.
Допустимые значения:
  1. None - не установлен.
  2. IMProtocol - IntellectMoney.
  3. WMProtocol - WebMoney.
SecretKey STRING OPTIONAL Секретный ключ магазина.
Указан в настройках магазина на вкладке "Подключение магазина".
По умолчанию секретный ключ отсутствует — его необходимо указать самостоятельно.
ResultUrl STRING OPTIONAL Адрес уведомления.
URL-адрес, на который происходит отправка уведомления с параметром PaymentStatus, где значение определяется событием по СКО:
  1. 3 - создан, отправляется при создании СКО.
  2. 4 - отменен, отправляется по истечении срока действия СКО или отмене СКО через личный кабинет, либо API.
  3. 5 - оплачен, отправляется при полной оплате СКО.
  4. 6 - захолдирован, отправляется при временной блокировке денежных средств на банковской карте покупателя по СКО.
  5. 7 - частично оплачен, отправляется при частичной оплате СКО.
  6. 8 - возврат, отправляется при возврате денежных средств по СКО.

При передаче параметра, значение переопределяет настройки магазина на вкладке "Подключение магазина" в поле "Result URL" для текущего СКО.
Подробнее о уведомлении по СКО.

Информация по организации

Параметр Свойства Описание
OrganizationId INT REQUIRED Номер организации.
Можно найти в личном кабинете на главной странице.
OrganizationName STRING REQUIRED Наименование организации.
Можно найти в личном кабинете на главной странице.
Email STRING REQUIRED Электронная почта организации.
OrganizationLogin STRING REQUIRED Логин организации.

Данные уведомления

Параметр Свойства Описание
CreationDate STRING REQUIRED Дата создания уведомления.
NotificationParams STRING REQUIRED Данные отправляемые в уведомлении.

Информация по счёту (AccountInfoData)

Параметр Свойства Описание
State OBJECT REQUIRED Статус выполнения операции.
AccountId LONG REQUIRED Номер счета.
Balance DECIMAL REQUIRED Баланс счёта.
Формат: десятичное число с двумя знаками после точки.
Currency STRING REQUIRED Валюта счёта.
Допустимые значения:
  1. RUB - рубль.
  2. TST - тестовая валюта.
  3. USD - американский доллар.
  4. EUR - евро.