POST api/yookassa/Cheque

Создание чека прихода или возврата в онлайн-кассе через Ю-кассу

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SessionId	Идентфикатор сессии, в рамках которой отправляется запрос	string	None.
Refund	Признак, что это возврат чека прихода	boolean	None.
SertCheque	Идентификатор чека в таблице	integer	None.
ApiParams	Параметры вызова внутреннего Api	YooKassaApiParams	None.
Operator	Идентификатор оператора программы лояльности	integer	None.
Token	Токен пользователя, который инициирует данный запрос	integer	None.
SiteCode	Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SessionId": "sample string 1",
  "Refund": true,
  "SertCheque": 1,
  "ApiParams": {
    "Url": "sample string 1",
    "Login": "sample string 2",
    "Password": "sample string 3",
    "IdempotenceKey": "sample string 4"
  },
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:

<ChequeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.YooKassaRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ApiParams>
    <IdempotenceKey>sample string 4</IdempotenceKey>
    <Login>sample string 2</Login>
    <Password>sample string 3</Password>
    <Url>sample string 1</Url>
  </ApiParams>
  <Refund>true</Refund>
  <SertCheque>1</SertCheque>
  <SessionId>sample string 1</SessionId>
</ChequeRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ChequeResponse

Name	Description	Type	Additional information
Id	Идентификатор чека прихода или возврата	string	None.
Status	Статус чека прихода или возврата	string	None.
IdempotenceKey	Ключ идемпотентности	string	None.
ErrorCode	Код ошибки	integer	None.
Message	Сообщение об ошибке	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "Status": "sample string 2",
  "IdempotenceKey": "sample string 3",
  "ErrorCode": 4,
  "Message": "sample string 5"
}

application/xml, text/xml

Sample:

<ChequeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.YooKassaResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">4</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 5</Message>
  <Id>sample string 1</Id>
  <IdempotenceKey>sample string 3</IdempotenceKey>
  <Status>sample string 2</Status>
</ChequeResponse>