Объекты API v0.9.0
Кошелёк Pay API
Документация перемещена
Информация на этой странице не обновляется и может быть устаревшей. Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:
1. Объект CheckoutInvoice
Объект содержит данные о пречеке.
Поле | Тип | Обязательно | Значение | Обязательно |
---|---|---|---|---|
| String | Да | Номер пречека (идентификатор покупки в системе ТСП). До 36 символов. | |
| Number | Да | Сумма к оплате (итоговая сумма) с учетом скидки в копейках. Неотрицательное целое число, не более 10 цифр. Недопустимые символы: пробел. | |
| Number | Нет | Сумма скидки в копейках. Неотрицательное целое число, не более 10 цифр. Недопустимые символы: пробел. | |
| Number | Нет | Полная сумма без учета скидки в копейках (включая НДС). Неотрицательное целое число, не более 10 цифр. Недопустимые символы: пробел. | |
| Array of Item | Да | Массив товаров, включенных в покупку (каждый товар — объект Item). |
2. Объект Item
Объект описывает отдельное товарное наименование, оплаченное с помощью Кошелёк Pay.
Поле | Тип | Обязательно | Значение |
---|---|---|---|
| String | Да | Наименование товара. |
| String | Да | Артикул. |
| Number | Да | Цена за единицу товара в копейках. |
| Number | Да | Количество. |
| Number | Да | Сумма к оплате (итоговая) в копейках. Недопустимые символы: пробел. |
| Number | Нет | Сумма скидки в копейках. Недопустимые символы: пробел. |
| Number | Нет | Полная сумма без учета скидки в копейках. Недопустимые символы: пробел. |
| Enum | Да | Ставка налога:
|
3. Объект User
Объект содержит данные о пользователе (клиенте, совершающем покупку).
Поле | Тип | Обязательно | Значение | Обязательно |
---|---|---|---|---|
| String | Да | Идентификатор клиента в программе лояльности (ключ карты лояльности). До 36 символов. |
4. Объект PaymentTypeAvailabilityInfo
Объект содержит сведения о провайдере платежей.
Поле | Тип | Обязательно | Значение | Обязательно |
---|---|---|---|---|
| String | Да | Наименование провайдера платежей (до 36 символов). | |
| Boolean | Да | Доступность провайдера платежей:
| |
| String | Нет | Дополнительная информация о провайдере. |
5. Объект Slip
Объект содержит данные о проведенной банковской операции.
Поле | Тип | Обязательно | Значение |
---|---|---|---|
| String | Да | Внутренний идентификатор объекта Slip в системе Кошелька. |
| Enum | Да | |
| String | Да | Идентификатор торговой точки (см. Подключение к API). |
| String | Да | Идентификатор кассы. |
| String | Да | Номер пречека (идентификатор покупки в системе ТСП). |
| String | Да | Идентификатор транзакции (покупки в системе Кошелька). |
| String | Нет | Идентификатор транзакции возврата. |
| String | Да (для | Идентификатор ТСП, выданный банком-получателем. Обязателен для оплаты через СБП. |
| Date | Да | Дата транзакции в формате:
|
| String | Нет | Идентификатор транзакции, присвоенный системой банка. |
| String | Да (для | Идентификатор транзакции, зарегистрированный в СБП. Обязателен для оплаты через СБП. |
| Number | Да | Оплаченная сумма (в копейках). Недопустимые символы: пробел. |
6. Объект PaymentMethod
Объект описывает используемый способ оплаты.
Поле | Тип | Обязательно | Значение |
---|---|---|---|
| Enum | Да | |
| Object | Нет | Объект, содержащий дополнительные поля, например: скидки, бонусы и т.д. (набор пар "ключ-значение"). |
7. Объект Invoice
Объект содержит сведения о фискальном чеке.
Поле | Тип | Обязательно | Значение |
---|---|---|---|
| String | Да | Номер пречека (до 36 символов). |
| String | Да | Номер чека (до 36 символов). |
| String | Да | Полное наименование ТСП (до 999 символов). |
| String | Да | Адрес ТСП (до 999 символов) |
| String | Да | ИНН ТСП (ровно 12 цифр; для ЮЛ - 2 первых нуля).. |
| Datetime | Да | Формат даты: YYYY-MM-DDTHH24:MI:SS+GMT |
| String | Да | Смена (до 32 символов). |
| String | Да | ФИО или номер кассира (до 256 символв). |
| Enum | Нет | Система налогообложения. Перечисление с возможными значениями:
|
| String | Нет | Регистрационный номер ККТ (до 64 символов). |
| String | Нет | Номер фискального накопителя (до 64 символов). |
| String | Нет | Фискальный признак документа (до 64 символов). |
| String | Нет | Номер фискального документа (до 64 символов). |
| String | Нет | Сайт для проверки данных чека (например, nalog.ru), (до 64 символов). |
| Enum | Да | Признак расчета. Перечисление с возможными значениями:
|
| Number | Да | Сумма к оплате (итоговая сумма) в копейках, неотрицательное целое число, до 10 цифр. Недопустимые символы: пробел. |
| Number | Нет | Сумма скидки в копейках, неотрицательное целое число, до 10 цифр. Недопустимые символы: пробел. |
| Number | Нет | Полная сумма без учета скидки в копейках, неотрицательное целое число, до 10 цифр. Недопустимые символы: пробел. |
| Number | Да | Сумма налога в копейках, неотрицательное целое число, до 10 цифр. Недопустимые символы: пробел. |
| String | Нет | QR-код для загрузки электронной версии чека (до 999 символов). |
| Array of Item | Да | Массив товаров, включенных в покупку (каждый товар - объект Item). |
Last updated