Create

https://{Environment}.payture.com/apicheque/Create

Запрос Create используется для создания чека без платежа.

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

Запрос

Пример тела запроса (максимальный набор параметров)(ФФД 1.2) [JSON]:

{
  "Key":"Merchant",
  "Password":"123",
  "Message":"Чек Payture",
  "TemplateTag":"Default",
  "TemplateLang":"Default",
  "AdditionalMessages":[
    {
      "Key":"Name",
      "Value":"Value"
    }
  ],
  "Cheque":{
    "Id":"{{$timestamp}}",
    "INN":"7701870710",
    "Group":"main",
    "Content":{
      "Type":2,
      "Positions":[
        {
          "Quantity":1,
          "Price":11,
          "Tax":1,
          "Text":"Пирожок",
          "AdditionalAttribute":"Дополнительный реквизит предмета расчета",
          "AgentType":2,
          "CustomsDeclarationNumber":"1271",
          "Excise":1.00,
          "ManufacturerCountryCode":"643",
          "PaymentMethodType":7,
          "PaymentSubjectType":1,         "ItemCode":"010460406000600021N4N57RSCBUZTQ\u001d2403004002910161218\u001d1724010191ffd0\u001d92tIAF/YVoU4roQS3M/m4z78yFq0fc/WsSmLeX5QkF/YVWwy8IMYAeiQ91Xa2z/fFSJcOkb2N+uUUmfr4n0mOX0Q==",
          "SupplierINN":"7701870710",
          "SupplierInfo":{
            "Name":"Наименование поставщика",
            "PhoneNumbers":["+79990000009"]
          },
          "QuantityMeasurementUnit": 10
        }
      ],
      "CheckClose":{
        "Payments":[
          {
            "Type":1,
            "Amount":11
          }
        ],
     "TaxationSystem":1
      },
      "CustomerContact":"roman@test.com",
      "AdditionalAttribute":"Доп.реквиз.чека",
      "AdditionalUserAttribute":{
        "Name":"Наименование дополнительного реквизита пользователя",
        "Value":"Значение дополнительного реквизита пользователя"
      },
      "AutomatNumber":"1258",
      "Customer":"Иванов Иван Иванович",
      "CustomerINN":"142702309610",
      "PaymentAgentOperation":"Операция плат. агента",
      "PaymentAgentPhoneNumbers":["+79260000003"],
      "PaymentOperatorName":"ООО \"Ромашка\"",
      "PaymentOperatorAddress":"Москва, Дурова 10",
      "PaymentOperatorINN":"9715225506",
      "PaymentOperatorPhoneNumbers":["+79260000002"],
      "PaymentTransferOperatorPhoneNumbers":["+79260000001"],
      "SettlementAddress":"Москва, Золотая 72",
      "SettlementPlace":"https://site.ru/",
      "SupplierPhoneNumbers":["+74957870004"]
    }
  }
}

Параметр	Описание	Формат	Orange Data	АТОЛ	Бухта
Key	Наименование Терминала Предоставляется с параметрами тестового/рабочего доступа	String Mandatory	+	+	+
Password	Пароль для выполнения запросов apiecheque Предоставляется с параметрами тестового/рабочего доступа	String Mandatory	+	+	+
Cheque	Параметры чека Описание структуры Cheque см. ниже	Object Mandatory	+	+	+
Message	Тема письма или строка в сообщении СМС	String [1..50] Optional	+	+	+
TemplateTag	Название используемого шаблона чека Необходимо передавать, если Продавец применяет несколько шаблонов. Если параметр не передан, используется шаблон с названием «Default» В общем случае можно задать значение по умолчанию через службу поддержки Payture и не передавать	String Optional	+	+	+
TemplateLang	Язык шаблона чека Необходимо передавать, если Продавец применяет несколько шаблонов. Если параметр не передан, используется язык «Default» В общем случае можно задать значение по умолчанию через службу поддержки Payture и не передавать	String Optional	+	+	+
AdditionalMessages	Позволяет добавить любые параметры на шаблон чека в плейсхолдер с названием из Key Описание элемента AdditionalMessages см. ниже. Общая длина максимум 1000 символов	Array of objects Optional	+	+	+

Пример тела запроса (минимальный набор параметров) [JSON]:

{
  "Key":"Merchant",
  "Password":"1234",
  "Cheque":{
    "Id":"6363901578517681941",
    "INN":"7702684259",
    "Content":{
      "Type":1,
      "Positions":[
        {
          "Quantity":1,
          "Price":27.25,
          "Tax":1,
          "Text":"Пирожок"
        }
      ],
      "CheckClose":{
        "Payments":[
          {
            "Type":2,
            "Amount":27.25
          }
        ]
      },
      "CustomerContact":"user@mail.com"
    }
  }
}

Состав элемента массива Cheque.AdditionalMessages

Параметр	Описание	Формат	Orange Data	АТОЛ	Бухта
Key	Название параметра	String Mandatory	+	+	+
Value	Значение параметра	String Mandatory	+	+	+

Состав Cheque

Параметр	Описание	Формат	Orange Data	АТОЛ	Бухта
Id	Уникальный идентификатор чека	String [1..64] Mandatory	+	+	+
INN	ИНН организации, для которой формируется чек	String [10..12] Mandatory	+	+	+
Content	Данные чека Описание структуры Content см. ниже	Object Mandatory	+	+	+
Group	Группа устройств, с помощью которых будет сформирован чек По умолчанию «main»	String [1..32] Optional	+	+	+
CallbackUrl	URL для отправки результатов обработки чека POST запросом	String Optional	+	+	-
OriginalChequeId	ID оригинального чека прихода для операции возврата (для Type=2)	String Optional	-	-	+

Состав Cheque.Content

Параметр	Описание (тег)	Формат	Orange Data	АТОЛ	Бухта
Type	Тип документа (1054): значения Orange Data/Атол: 1Приход 2Возврат прихода 3Расход 4Возврат расхода Бухта: 1Приход 2Возврат прихода	1	Приход	2	Возврат прихода
1	Приход
2	Возврат прихода
3	Расход
4	Возврат расхода
1	Приход
2	Возврат прихода
Positions	Список позиций чека (1059) Описание элемента Positions см. ниже	Array of objects Mandatory	+	+	+
CheckClose	Контейнер с информацией о системе налогообложения и параметрах закрытия чека Описание структуры CheckClose см. ниже Object Mandatory + + +	Object Mandatory	+	+	+
CustomerContact	Email Покупателя для отправки чека или телефон в формате 79995554444 или +79995554444 (1008)	String [1..32] Mandatory	+	+	+
AgentType	Признак агента (1057). Используется только для ФФД 1.05: значения Число от 1 до 127 (битовое поле), где номер бита обозначает, что Продавец: Бит Описание 0Банковский платежный агент 1Банковский платежный субагент 2Платежный агент 3Платежный субагент 4Поверенный 5Комиссионер 6Иной агент	Бит	Описание	0	Банковский платежный агент
Бит	Описание
0	Банковский платежный агент
1	Банковский платежный субагент
2	Платежный агент
3	Платежный субагент
4	Поверенный
5	Комиссионер
6	Иной агент
AdditionalUserAttribute	Дополнительный реквизит пользователя (1084) Описание структуры AdditionalUserAttribute см. ниже	Object Optional	+	-	-
AdditionalAttribute	Дополнительный реквизит чека (1192)	String [1..16] Optional	+	-	-
AutomatNumber	Номер автомата (1036)	String [1..20] Optional	+	-	-
Customer	Покупатель (клиент) (1227)	String [1..243] Optional	+	-	-
CustomerINN	ИНН покупателя (клиента) (1228)	String [10..12] Optional	+	-	-
PaymentAgentOperation	Операция платежного агента (1044)	String [1..24] Optional	+	+	-
PaymentAgentPhoneNumbers	Телефоны платежного агента в формате +79995554444 (1073)	Array of strings [1..19] Optional	+	+	-
PaymentOperatorName	Наименование оператора перевода (1026)	String [1..64] Optional	+	+	-
PaymentOperatorAddress	Адрес оператора перевода (1005)	String [1..243] Optional	+	+	-
PaymentOperatorINN	ИНН оператора перевода (1016)	String [10..12] Optional	+	+	-
PaymentOperatorPhoneNumber	Телефоны оператора по приему платежей в формате +79995554444 (1074)	Array of strings [1..19] Optional	+	+	-
PaymentTransferOperatorPhoneNumbers	Телефоны оператора перевода в формате +79995554444 (1075)	Array of strings [1..19] Optional	+	+	-
SettlementAddress	Адрес расчетов (1009)	String [1..243] Optional	+	-	-
SettlementPlace	Место расчетов (1187) Параметр может использоваться для указания сайта, на котором формируется чек	String [1..243] Optional	+	-	-
SupplierPhoneNumbers	Телефоны поставщика в формате +79995554444 (1171)	Array of strings [1..19] Optional	+	-	-

Состав Cheque.Content.AdditionalUserAttribute

Параметр	Описание (тег)	Формат	Orange Data	АТОЛ	Бухта
Name	Наименование дополнительного реквизита пользователя (1085)	String [1..64] Mandatory	+	-	-
Value	Значение дополнительного реквизита пользователя (1086)	String [1..175] Mandatory	+	+	-

Состав элемента массива Cheque.Content.Positions

Параметр	Описание (тег)	Формат	Orange Data	АТОЛ	Бухта
Quantity	Количество предмета расчета (товара, услуги и т.д.) (1023) Десятичное число с точностью до 3 цифр после точки	Float Mandatory	+	+	+
Price	Цена в рублях за единицу предмета расчета с учетом скидок и наценок (1079) Десятичное число с точностью до 2 цифр после точки	Float Mandatory	+	+	+
Tax	Ставка НДС (1199): значения Orange Data/Атол: 1Ставка НДС 22% 2Ставка НДС 10% 3Ставка НДС расч. 22/122 4Ставка НДС расч. 10/110 5Ставка НДС 0% 6 НДС не облагается 7ставка НДС 5% 8ставка НДС 7% 9ставка НДС расч. 5/105 10ставка НДС расч. 7/107 11Ставка НДС 20% 12Ставка НДС расч. 20/120 Бухта: 1Ставка НДС 20% 2Ставка НДС 10% 6Без НДС 1000Ставка НДС 12%	1	Ставка НДС 22%	2	Ставка НДС 10%
1	Ставка НДС 22%
2	Ставка НДС 10%
3	Ставка НДС расч. 22/122
4	Ставка НДС расч. 10/110
5	Ставка НДС 0%
6	НДС не облагается
7	ставка НДС 5%
8	ставка НДС 7%
9	ставка НДС расч. 5/105
10	ставка НДС расч. 7/107
11	Ставка НДС 20%
12	Ставка НДС расч. 20/120
1	Ставка НДС 20%
2	Ставка НДС 10%
6	Без НДС
1000	Ставка НДС 12%
Text	Наименование предмета расчета (название товара, услуги и т.д.) (1030)	String [1..128] Mandatory	+	+	+
AdditionalAttribute	Дополнительный реквизит предмета расчета (1191)	String [1..64] Optional	+	+	-
AgentType	Признак агента по предмету расчета (1222): значения Число от 1 до 127 (битовое поле), где номер бита обозначает, что оказывающий услугу Покупателю (клиенту) пользователь является: Бит Описание 0Банковский платежный агент 1Банковский платежный субагент 2Платежный агент 3Платежный субагент 4Поверенный 5Комиссионер 6Иной агент	Бит	Описание	0	Банковский платежный агент
Бит	Описание
0	Банковский платежный агент
1	Банковский платежный субагент
2	Платежный агент
3	Платежный субагент
4	Поверенный
5	Комиссионер
6	Иной агент
AgentInfo	Данные агента (1223) Описание структуры AgentInfo см. ниже	Object Optional	+	-	-
CustomsDeclarationNumber	Номер таможенной декларации (1231)	String [1..32] Optional	+	-	-
Excise	Акциз (1229) Десятичное число с точностью до 2 цифр после точки	Float Optional	+	-	-
ManufacturerCountryCode	Код страны происхождения товара (1230)	String [1..3] Optional	+	+	+
PaymentMethodType	Способ расчета (1214): значения Число от 1 до 7: 1Предоплата 100% 2Частичная предоплата 3Предварительная оплата (Аванс) 4Полный расчет 5Частичный расчет и кредит 6Передача в кредит 7Оплата кредита	1	Предоплата 100%	2	Частичная предоплата
1	Предоплата 100%
2	Частичная предоплата
3	Предварительная оплата (Аванс)
4	Полный расчет
5	Частичный расчет и кредит
6	Передача в кредит
7	Оплата кредита
PaymentSubjectType	Предмет расчета (1212): значения Число от 1 до 33: 1Товар 2Подакцизный товар 3Работа 4Услуга 5Ставка азартной игры 6Выигрыш азартной игры 7Лотерейный билет 8Выигрыш лотереи 9Предоставление РИД 10Платеж 11Агентское вознаграждение 12Составной предмет расчета 13Иной предмет расчета 14Имущественное право 15Внереализационный доход 16Иные платежи и взносы 17Торговый сбор 18Курортный сбор 19Залог 20Расход 21Взносы на обязательное пенсионное страхование ИП 22Взносы на обязательное пенсионное страхование 23Взносы на обязательное медицинское страхование ИП 24Взносы на обязательное медицинское страхование 25Взносы на обязательное социальное страхование 26Платеж казино 27Выдача денежных средств 30АТНМ (не имеющем кода маркировки) 31АТМ (имеющем код маркировки) 32ТНМ 33ТМ	1	Товар	2	Подакцизный товар
1	Товар
2	Подакцизный товар
3	Работа
4	Услуга
5	Ставка азартной игры
6	Выигрыш азартной игры
7	Лотерейный билет
8	Выигрыш лотереи
9	Предоставление РИД
10	Платеж
11	Агентское вознаграждение
12	Составной предмет расчета
13	Иной предмет расчета
14	Имущественное право
15	Внереализационный доход
16	Иные платежи и взносы
17	Торговый сбор
18	Курортный сбор
19	Залог
20	Расход
21	Взносы на обязательное пенсионное страхование ИП
22	Взносы на обязательное пенсионное страхование
23	Взносы на обязательное медицинское страхование ИП
24	Взносы на обязательное медицинское страхование
25	Взносы на обязательное социальное страхование
26	Платеж казино
27	Выдача денежных средств
30	АТНМ (не имеющем кода маркировки)
31	АТМ (имеющем код маркировки)
32	ТНМ
33	ТМ
NomenclatureCode	Код товарной номенклатуры (1162) (base64 кодированный массив от 1 до 32 байт). Используется только для ФФД 1.05	String Optional	+	+	+
ItemCode	Код маркировки (2000) (значение, считанное сканером). Используется только для ФФД 1.2	String Optional	+	+	-
SupplierINN	ИНН поставщика (1226)	String [10..12] Optional	+	+	-
SupplierInfo	Данные поставщика (1224) Описание структуры SupplierInfo см. ниже	Object Optional	+	+	-
UnitOfMeasurement	Единица измерения предмета расчета (1197). Используется только для ФФД 1.05	String [1..16] Optional	+	-	-
QuantityMeasurementUnit	Единица измерения предмета расчета (2108) (число от 0 до 255, 0 если не передано). Используется только для ФФД 1.2	Integer Optional	+	+	-

Состав Cheque.Content.Positions.AgentInfo

Параметр	Описание (тег)	Формат	Orange Data	АТОЛ	Бухта
PaymentAgentOperation	Операция платежного агента (1044) В общем случае можно задать значение по умолчанию через службу поддержки Payture и не передавать	String [1..24] Optional	+	-	-
PaymentAgentPhoneNumbers	Телефоны платежного агента в формате +79995554444 (1073) В общем случае можно задать значение по умолчанию через службу поддержки Payture и не передавать	Array of strings [1..19] Optional	+	-	-
PaymentOperatorName	Наименование оператора перевода (1026) В общем случае можно задать значение по умолчанию через службу поддержки Payture и не передавать	String [1..64] Optional	+	-	-
PaymentOperatorAddress	Адрес оператора перевода (1005) В общем случае можно задать значение по умолчанию через службу поддержки Payture и не передавать	String [1..243] Optional	+	-	-
PaymentOperatorINN	ИНН оператора перевода (1016) В общем случае можно задать значение по умолчанию через службу поддержки Payture и не передавать	String [10..12] Optional	+	-	-
PaymentOperatorPhoneNumber	Телефоны оператора по приему платежей в формате +79995554444 (1074) В общем случае можно задать значение по умолчанию через службу поддержки Payture и не передавать	Array of strings [1..19] Optional	+	-	-
PaymentTransferOperatorPhoneNumbers	Телефоны оператора перевода в формате +79995554444 (1075) В общем случае можно задать значение по умолчанию через службу поддержки Payture и не передавать	Array of strings [1..19] Optional	+	-	-

Состав Cheque.Content.Positions.SupplierInfo

Параметр	Описание (тег)	Формат	Orange Data	АТОЛ	Бухта
Name	Наименование поставщика (1225) Строка длиной до (239 – N) символов, где N — это количество символов в телефонных номерах поля PhoneNumbers + 4 символа на каждый номер	String Mandatory	+	+	-
PhoneNumbers	Телефоны поставщика в формате +79995554444 (1171)	Array of strings [1..19] Optional	+	+	-

Состав Cheque.Content.CheckClose

Параметр	Описание (тег)	Формат	Orange Data	АТОЛ	Бухта
Payments	Оплаты Описание элемента Payments см. ниже	Array of objects Mandatory	+	+	+
TaxationSystem	Номер системы налогообложения (1055): значения Число от 0 до 5: 0Общая, ОСН 1Упрощенная доход, УСН доход 2Упрощенная доход минус расход, УСН 3Единый налог на вмененный доход, ЕНВД 4Единый сельскохозяйственный налог, ЕСН 5Патентная система налогообложения	0	Общая, ОСН	1	Упрощенная доход, УСН доход
TaxationSystem	Номер системы налогообложения (1055): значения Число от 0 до 5: 0Общая, ОСН 1Упрощенная доход, УСН доход 2Упрощенная доход минус расход, УСН 3Единый налог на вмененный доход, ЕНВД 4Единый сельскохозяйственный налог, ЕСН 5Патентная система налогообложения	0	Общая, ОСН	1	Упрощенная доход, УСН доход
0	Общая, ОСН
1	Упрощенная доход, УСН доход
2	Упрощенная доход минус расход, УСН
3	Единый налог на вмененный доход, ЕНВД
4	Единый сельскохозяйственный налог, ЕСН
5	Патентная система налогообложения

Состав элемента массива Cheque.Content.CheckClose.Payments

Внимание!

Сумма по всем типам оплат должна совпадать с итоговой стоимостью всех позиций чека.

Параметр	Описание (тег)	Формат	Orange Data	АТОЛ	Бухта
Type	Тип оплаты: значения Число от 1 до 16: 1Наличными (1031) 2Безналичными (1081) 14Предварительная оплата (аванс) (1215) 15Последующая оплата (в кредит) (1216) 16Встречное предоставление (1217)	1	Наличными (1031)	2	Безналичными (1081)
1	Наличными (1031)
2	Безналичными (1081)
14	Предварительная оплата (аванс) (1215)
15	Последующая оплата (в кредит) (1216)
16	Встречное предоставление (1217)
Amount	Сумма оплаты в рублях Десятичное число с точностью до 2 цифр после точки	Float Mandatory	+	+	+

Ответ

Параметр	Описание	Формат
Success	Признак успешности выполнения операции в платежном шлюзе. Принимает значения: `true` — операция успешна `false` — операция неуспешна	Boolean Mandatory
ErrCode	Код ошибки платежного шлюза	String Mandatory
Status	Статус чека. См. статусы чеков	String Mandatory
ErrMessages	Сообщения об ошибках, полученные от сервиса онлайн-касс Передаются, если получены от сервиса онлайн-касс	Array of strings Optional

Пример успешного ответа [JSON]:

{ 
  "Success":true,
  "ErrCode":"NONE",
  "ErrMessages":null,
  "Status":"Accepted"
}

Пример ответа при получении ошибки от сервиса онлайн-касс [JSON]:

{
  "Success":true,
  "ErrCode":"NONE",
  "ErrMessages":[
    "Неизвестная группа"
  ],
  "Status":"BadRequest"
}

Create

Содержание