Получение статуса

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

Запрос Status используется для получения актуального статуса чека и информации о чеке.

Запрос

Параметр	Описание	Формат
Key	Наименование Терминала Предоставляется с параметрами тестового/рабочего доступа	String Mandatory
Password	Пароль для выполнения запросов apiecheque Предоставляется с параметрами тестового/рабочего доступа	String Mandatory
Id	Идентификатор чека, переданный в запросе или полученный из нотификации	String [1..64] Optional*
OrderId	Идентификатор платежа в системе Продавца Может использоваться, если чек был передан с платежом Рекомендуемый формат: GUID/UUID или Alphanumeric. Другие форматы могут вызвать сбои в работе банковских сервисов.	String [1..50] Optional*

Пример тела запроса JSON:

{ 
  "Key":"Merchant",
  "Password":"1234",
  "Id":"6363737176995117182",
  "OrderId":""
}

*Должен быть задан хотя бы один из опциональных параметров. Если задан Id, поиск будет выполняться по этому параметру.

Ответ

Параметр	Описание	Формат
Success	Признак успешности выполнения операции в платежном шлюзе. Принимает значения: `true` — операция успешна `false` — операция неуспешна	Boolean Mandatory
ErrCode	Код ошибки платежного шлюза	String Mandatory
Cheques	Список чеков по данному запросу Передается, если «Success=True» Описание элемента Cheques см. ниже	Array of objects Optional

Пример ответа [JSON]:

{
  "Success":true,
  "ErrCode":null,
  "Cheques":[
    {
      "Sended":false,
      "Cheque":{
        "Content":{
          ...
        },
        "Id":"1568707129",
        "DeviceSN":"0578050005001542",
        "DeviceRN":"0000000400054952",
        "FSNumber":"9999078900001341",
        "OFDName":"ООО \"Ярус\" (\"ОФД-Я\")",
        "OFDWebsite":"www.ofd-ya.ru",
        "OFDINN":"7728699517",
        "FNSWebsite":"www.nalog.ru",
        "CompanyINN":"7710140677",
        "CompanyName":"ООО «Ромашка»",
        "DocumentNumber":8750,
        "ShiftNumber":3420,
        "DocumentIndex":945,
        "ProcessedAt":"2019-09-17T10:58:00",
        "Change":0.0,
        "FP":"671302447"
      },
      "ErrCode":null,
      "Link":"https://sandbox3.payture.com/c/?i=brBv&h=t9FlDSndYcqI0sU8+NnyaA",
      "Status":"Created"
    }
  ]
}

Состав элемента массива Cheques

Параметр	Описание	Формат
Sended	Признак отправки чека Отправка не всегда означает доставку чека Покупателю	Boolean Mandatory
Status	Статус чека. См. статусы чеков	String Mandatory
Cheque	Фискальные данные чека Передается, если «Status=Created» Описание структуры Cheque см. ниже	Object Optional
Link	Ссылка на чек Передается, если «Status=Created»	String Optional
ErrCode	Передается, если возникла внутренняя ошибка при добавлении данных текущего чека в ответ этого запроса	String Optional

Состав Cheques.Cheque

Параметр	Описание	Формат
Content	Данные чека. Соответствует параметру Content в запросах на создание чека. Различается в зависимости от типа чека: для обычного чека — параметр Cheque.Content из запроса Create для чека коррекции — параметр Body.Content из запроса CreateCorrection	Object Mandatory
Id	Идентификатор чека Соответствует переданному в запросе	String [1..64] Mandatory
DeviceSN	Серийный номер устройства, пробившего чек	String [1..20] Mandatory
DeviceRN	Регистрационный номер устройства, пробившего чек	String [1..20] Mandatory
FSNumber	Номер фискального накопителя	String [1..16] Mandatory
OFDName	Наименование ОФД	String [1..256] Mandatory
OFDWebsite	Веб-сайт ОФД	String [1..58] Mandatory
OFDINN	ИНН ОФД	String [1..12] Mandatory
FNSWebsite	Веб-сайт ФНС	String [1..256] Mandatory
CompanyINN	ИНН компании	String [1..12] Mandatory
CompanyName	Название компании	String [1..256] Mandatory
DocumentNumber	Номер фискального документа	Integer Mandatory
ShiftNumber	Номер смены	Integer Mandatory
DocumentIndex	Номер чека	Integer Mandatory
ProcessedAt	Время регистрации фискального документа в ФН Строка в формате ISO8601	String Mandatory
Change	Сдача в рублях Десятичное число с точностью до 2 цифр после точки	Float Mandatory
FP	Фискальный признак	String [1..10] Mandatory

Получение статуса

Запрос

Ответ

Состав элемента массива Cheques

Состав Cheques.Cheque

Содержание