POST api/sertcard/RedeemedPos

Списание или возврат средств на подарочный сертификат в точке продаж

Request Information

URI Parameters

None.

Body Parameters

RedeemedPosRequest
NameDescriptionTypeAdditional information
Partner

Идентификатор партнера

integer

None.

PosCode

Код торговой точки

string

None.

SertCard

Номер сертификата

integer

None.

SecretCode

Пинкод сертификата

string

None.

Refund

Признак, что это чек возврата

boolean

None.

Amount

Сумма чека покупки или чека возврата, если refund = 1

decimal number

None.

SertCardAmount

Сумма списания или начисления (при refund=1 будет начисление) средств на сертификат

decimal number

None.

ChequeTime

Дата и время текущей операции

date

None.

ChequeNumber

Номер покупки/заказа, в рамках которого списываются средства с сертификата

string

None.

PurchaseNumber

Номер покупки/заказа, по которому идёт возврат (обязательно если refund = 1)

string

None.

PurchaseDate

Дата покупки/заказа, по которому идёт возврат (обязательно если refund = 1)

date

None.

Cashier

ФИО кассира/продавца/пользователя кассы, который списывает средства с сертификата

string

None.

Operator

Идентификатор оператора программы лояльности

integer

None.

Token

Токен пользователя, который инициирует данный запрос

integer

None.

SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Partner": 1,
  "PosCode": "sample string 1",
  "SertCard": 1,
  "SecretCode": "sample string 2",
  "Refund": true,
  "Amount": 1.0,
  "SertCardAmount": 1.0,
  "ChequeTime": "2022-08-19T23:00:02.9015892+03:00",
  "ChequeNumber": "sample string 3",
  "PurchaseNumber": "sample string 4",
  "PurchaseDate": "2022-08-19T23:00:02.9015892+03:00",
  "Cashier": "sample string 5",
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 6"
}

application/xml, text/xml

Sample:
<RedeemedPosRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.SertCardRequest">
  <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 6</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Amount>1</Amount>
  <Cashier>sample string 5</Cashier>
  <ChequeNumber>sample string 3</ChequeNumber>
  <ChequeTime>2022-08-19T23:00:02.9015892+03:00</ChequeTime>
  <Partner>1</Partner>
  <PosCode>sample string 1</PosCode>
  <PurchaseDate>2022-08-19T23:00:02.9015892+03:00</PurchaseDate>
  <PurchaseNumber>sample string 4</PurchaseNumber>
  <Refund>true</Refund>
  <SecretCode>sample string 2</SecretCode>
  <SertCard>1</SertCard>
  <SertCardAmount>1</SertCardAmount>
</RedeemedPosRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

RedeemedPosResponse
NameDescriptionTypeAdditional information
SertCardBalance

Баланс сертификата после проведения операции

decimal number

None.

ErrorCode

Код ошибки

integer

None.

Message

Сообщение об ошибке

string

None.

Response Formats

application/json, text/json

Sample:
{
  "SertCardBalance": 1.0,
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<RedeemedPosResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.SertCardResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
  <SertCardBalance>1</SertCardBalance>
</RedeemedPosResponse>