Публичный ресурс

Формат данных веб-сервиса по управлению статусами и балансами подарочных карт из ERP в SetRetail10

Для чтения визуальной составляющей схемы XSD, а также типами обязательных данных, ознакомьтесь с правилами использования.

  • Возможны только варианты импорта по подарочным картам ниже.
  • Импорт начисления баланса подарочных карт или её экземпляра в виде xml-сообщений не предусмотрен.

Методы веб-сервиса для импорта операций по подарочным картам

Активация подарочной карты

МетодactivatePresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийАктивация подарочных карт, в качестве входных параметров принимает фильтр, по которому и будут отобраны карты для активации.

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumber

String

Номер карты

Да
purchaseUidCollectionНабор полей чекаНет

cashNumLongНомер кассыНет
checkNumLongНомер чека к которому будет привязана активация подарочной картыНет
createDatedateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Нет
shiftNumLongНомер сменыНет
shopNumLongНомер магазинаНет
amountLongНоминалНет
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

amount

Long

Номинал


balanceLongОстаток на карте
cardNumberStringНомер карты
expirationDatedateTimeДата окончания действия карты
statusstring

Статус:

  • Activate - активирована
  • Blocked - заблокирована
  • Changed - заменена
  • Create - создана
  • EXTEND - продлен срок действия
  • Inactive - неактивирована
  • PARTIAL_USE - частичное списана 
  • UNDO_USE - отмена использования (возврат из гашения)
  • Used - использована

Описание формата данных

Пример запроса на активацию подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:activatePresentCard>
         <!--Optional:-->
         <cardNumber>10000002233</cardNumber>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>2</cashNum>
            <!--Optional:-->
            <checkNum>4</checkNum>
            <!--Optional:-->
            <createDate>2019-05-13</createDate>
            <!--Optional:-->
            <shiftNum>8</shiftNum>
            <!--Optional:-->
            <shopNum>3382</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <amount>50000</amount>
         <!--Optional:-->
         <userName>manager</userName>
         <!--Optional:-->
         <userTabNumber>1</userTabNumber>
      </ser:activatePresentCard>
   </soapenv:Body>
</soapenv:Envelope>
Пример ответа на запроса активации подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:activatePresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/">
         <return>
            <activationDate>2023-10-05T14:37:57.367+03:00</activationDate>
            <amount>40000</amount>
            <balance>40000</balance>
            <cardNumber>10000002233</cardNumber>
            <maxAmount>0</maxAmount>
            <multiplicity>0</multiplicity>
            <status>Active</status>
         </return>
      </ns2:activatePresentCardResponse>
   </soap:Body>
</soap:Envelope>

Замена подарочной карты

МетодcardReplacement
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийЗамена подарочной карты. Указываются номер двух карт, старой (которую требуется заменить), и новую (которая будет выдана вместо старой).

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberOld

String

Номер старой подарочной карты, которая будет деактивирована

Да
cardNumberNewStringНомер новой подарочной карты, которая будет активированаДа
purchaseUidCollectionНабор полей чекаНет

cashNumLongНомер кассыНет
checkNumLongНомер чека к которому будет привязана активация подарочной картыНет
createDatedateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Нет
shiftNumLongНомер сменыНет
shopNumLongНомер магазинаНет
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

cardReplacementResponse
Отображение наименования ответа cardReplacementResponse в случае успешной обработки пакета

Описание формата данных

Пример запроса на замену подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:cardReplacement>
         <!--Optional:-->
         <cardNumberOld>10000002233</cardNumberOld>
         <!--Optional:-->
         <cardNumberNew>10000002235</cardNumberNew>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>23</cashNum>
            <!--Optional:-->
            <checkNum>2</checkNum>
            <!--Optional:-->
            <createDate>2023-05-10</createDate>
            <!--Optional:-->
            <shiftNum>2</shiftNum>
            <!--Optional:-->
            <shopNum>779</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <userName>manager</userName>
         <!--Optional:-->
         <userTabNumber>34</userTabNumber>
      </ser:cardReplacement>
   </soapenv:Body>
</soapenv:Envelope>
Пример ответа на запрос по замене подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:cardReplacementResponse xmlns:ns2="http://services.processing.cards.crystals.ru/">
         <return/>
      </ns2:cardReplacementResponse>
   </soap:Body>
</soap:Envelope>

-

Деактивация подарочной карты

МетодdeActivatePresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийГашение подарочной карты, полное списание. После вызова метода с номером карты, её статус будет "использована/погашена".

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНовый номер карты из существующих диапазоновДа
purchaseUidCollectionНабор полей чекаНет

cashNumLongНомер кассыНет
checkNumLongНомер чека к которому будет привязана активация подарочной картыНет
createDatedateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Нет
shiftNumLongНомер сменыНет
shopNumLongНомер магазинаНет
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

amountLongНоминал
balanceLongОстаток на карте
cardNumberStringНомер карты
expirationDatedateTimeДата окончания действия карты
statusString

Статус:

  • Activate - активирована
  • Blocked - заблокирована
  • Changed - заменена
  • Create - создана
  • EXTEND - продлен срок действия
  • Inactive - неактивирована
  • PARTIAL_USE - частичное списана 
  • UNDO_USE - отмена использования (возврат из гашения)
  • Used - использована

Описание формата данных

Пример запроса на деактивацию подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:deActivatePresentCard>
         <!--Optional:-->
         <cardNumber>10000002233</cardNumber>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>3</cashNum>
            <!--Optional:-->
            <checkNum>23</checkNum>
            <!--Optional:-->
            <createDate>2023-10-04</createDate>
            <!--Optional:-->
            <shiftNum>3</shiftNum>
            <!--Optional:-->
            <shopNum>779</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <userName>manager</userName>
         <!--Optional:-->
         <userTabNumber>3</userTabNumber>
      </ser:deActivatePresentCard>
   </soapenv:Body>
</soapenv:Envelope>
Пример ответа на запрос по деактивации подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:deActivatePresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/">
         <return>
            <amount>40000</amount>
            <balance>40000</balance>
            <cardNumber>10000002233</cardNumber>
            <maxAmount>0</maxAmount>
            <multiplicity>0</multiplicity>
            <status>Create</status>
         </return>
      </ns2:deActivatePresentCardResponse>
   </soap:Body>
</soap:Envelope>

Получить информацию по подарочной карте

МетодgetPresentCardInfo
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийПолучить информацию по подарочной карте

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНовый номер карты из существующих диапазоновДа
msrCardNumberStringНомер карты из магнитной дорожки (полосы)Нет
shopNumberLongНабор полей чекаНет

Возвращаемые параметры

activationDatedateTimeДата активации
amountLongНоминал
balanceLongОстаток на карте
cardNumberStringНомер карты
maxAmountStringМаксимальный номинал
multiplicityStringКратность
statusString

Статус

  • Activate - активирована
  • Blocked - заблокирована
  • Changed - заменена
  • Create - создана
  • EXTEND - продлен срок действия
  • Inactive - неактивирована
  • PARTIAL_USE - частичное списана 
  • UNDO_USE - отмена использования (возврат из гашения)
  • Used - использована

Описание формата данных

Пример запроса на получение информации по подарочной карте
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:getPresentCardInfo>
         <!--Optional:-->
         <request>
            <!--Optional:-->
            <cardNumber>10000002233</cardNumber>
            <!--Optional:-->
            <msrCardNumber>100000022339098213</msrCardNumber>
            <!--Optional:-->
            <shopNumber>779</shopNumber>
         </request>
      </ser:getPresentCardInfo>
   </soapenv:Body>
</soapenv:Envelope>
Пример ответа на запрос по получение информации о подарочной карте
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getPresentCardInfoResponse xmlns:ns2="http://services.processing.cards.crystals.ru/">
         <return>
            <activationDate>2023-10-05T12:41:10.658+03:00</activationDate>
            <amount>40000</amount>
            <balance>40000</balance>
            <cardNumber>10000002233</cardNumber>
            <maxAmount>0</maxAmount>
            <multiplicity>0</multiplicity>
            <status>Active</status>
         </return>
      </ns2:getPresentCardInfoResponse>
   </soap:Body>
</soap:Envelope>

Получить информацию по подарочной карте только по номеру

МетодgetPresentCardInformation
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийПолучить информацию по подарочной карте

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНовый номер карты из существующих диапазоновДа

Возвращаемые параметры

activationDatedateTimeДата активации
amountLongНоминал
balanceLongОстаток на карте
cardNumberStringНомер карты
maxAmountStringМаксимальный номинал
multiplicityStringКратность
statusString

Статус

  • Activate - активирована
  • Blocked - заблокирована
  • Changed - заменена
  • Create - создана
  • EXTEND - продлен срок действия
  • Inactive - неактивирована
  • PARTIAL_USE - частичное списана 
  • UNDO_USE - отмена использования (возврат из гашения)
  • Used - использована

Описание формата данных

Пример запроса на получение информации по подарочной карте
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:getPresentCardInformation>
         <!--Optional:-->
         <cardNumber>10000002234</cardNumber>
      </ser:getPresentCardInformation>
   </soapenv:Body>
</soapenv:Envelope>
Пример ответа на запрос получение информации о подарочной карте по номеру
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getPresentCardInformationResponse xmlns:ns2="http://services.processing.cards.crystals.ru/">
         <return>
            <activationDate>2023-10-05T12:43:34.256+03:00</activationDate>
            <amount>40000</amount>
            <balance>0</balance>
            <cardNumber>10000002234</cardNumber>
            <maxAmount>0</maxAmount>
            <multiplicity>0</multiplicity>
            <status>Used</status>
         </return>
      </ns2:getPresentCardInformationResponse>
   </soap:Body>
</soap:Envelope>

Получить информацию по подарочной карте по номеру магнитной дорожки

МетодgetPresentCardInformationByMSRNumber
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийПолучить информацию по подарочной карте по номеру магнитной полосы (дорожки)

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

msrCardNumberStringНомер карты из магнитной дорожки (полосы)Да

Возвращаемые параметры

activationDatedateTimeДата активации
amountLongНоминал
balanceLongОстаток на карте
cardNumberStringНомер карты
maxAmountStringМаксимальный номинал
multiplicityStringКратность
statusString

Статус

  • Activate - активирована
  • Blocked - заблокирована
  • Changed - заменена
  • Create - создана
  • EXTEND - продлен срок действия
  • Inactive - неактивирована
  • PARTIAL_USE - частичное списана 
  • UNDO_USE - отмена использования (возврат из гашения)
  • Used - использована

Описание формата данных

Пример запроса на получение информации о подарочной карте по номеру магнитной полосы
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:getPresentCardInformationByMSRNumber>
         <!--Optional:-->
         <msrNumber>10000002235</msrNumber>
      </ser:getPresentCardInformationByMSRNumber>
   </soapenv:Body>
</soapenv:Envelope>
Пример ответа на запрос по получению информации о подарочной карте по номеру магнитной полосы
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getPresentCardInformationByMSRNumberResponse xmlns:ns2="http://services.processing.cards.crystals.ru/">
         <return>
            <amount>40000</amount>
            <balance>40000</balance>
            <cardNumber>10000002235</cardNumber>
            <maxAmount>0</maxAmount>
            <multiplicity>0</multiplicity>
            <status>Create</status>
         </return>
      </ns2:getPresentCardInformationByMSRNumberResponse>
   </soap:Body>
</soap:Envelope>

Получить подробную информацию по подарочной карте, используя фильтры выборки поиска 

МетодgetPresentCardsInfoByFilter
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
Комментарий

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

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНомер картыНет
endDateFromdateTime

Дата окончания срока действия от

Формат: YYYY-MM-DD

Нет
endDateTodateTime

Дата окончания срока действия до

Формат: YYYY-MM-DD

Нет
operationDateFromdateTime

Дата начала действия по карте от

Формат: YYYY-MM-DD

Нет
operationDateTodateTime

Дата начала действия по карте до

Формат: YYYY-MM-DD

Нет
paymentDatedateTime

Дата гашения

Формат: YYYY-MM-DD

Нет
saleDatedateTime

Дата продажи 

Формат: YYYY-MM-DD

Нет
startDateFromdateTime

Дата начала срока действия от

Формат: YYYY-MM-DD

Нет
startDateTodateTime

Дата окончания срока действия до

Формат: YYYY-MM-DD

Нет
statusКоллекция статусов

Статус

  • Activate - активирована
  • Blocked - заблокирована
  • Changed - заменена
  • Create - создана
  • EXTEND - продлен срок действия
  • Inactive - неактивирована
  • PARTIAL_USE - частичное списана 
  • UNDO_USE - отмена использования (возврат из гашения)
  • Used - использовна
Нет

Возвращаемые параметры

getPresentCardsInfoByFilterResponseBase64

Информация по подарочной карте в формате Base64

Пример ответа в base64.


  • cardNumber
LongНомер карты
  • amount
LongНоминал
  • status
String

Статус

  • Activate - активирована
  • Blocked - заблокирована
  • Changed - заменена
  • Create - создана
  • EXTEND - продлен срок действия
  • Inactive - неактивирована
  • PARTIAL_USE - частичное списана 
  • UNDO_USE - изъятия из использования
  • Used - использовна

  • startDate
StringДата начала действия
  • endDate
StringДата окончания
  • replacedCardNumber
StringНомер новой карты в замен этой, если есть
  • actions
Комплексный

Действия с картой:

  • type - тип
    • Activate - активирована
    • Blocked - заблокирована
    • Changed - заменена
    • Create - создана
    • EXTEND - продлен срок действия
    • Inactive - неактивирована
    • PARTIAL_USE - частичное списана 
    • UNDO_USE - отмена использования (возврат из гашения)
    • Used - использована
  • source - источник/пользователь
    • SERVER - по умолчанию

  • blockingCause
КомплексныйПричина блокировки
  • prolongationCause
КомплексныйПричина продления

Описание формата данных

Пример запроса на получение информации по подарочной карте, используя фильтры выборки поиска 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:getPresentCardsInfoByFilter>
         <!--Optional:-->
         <filter>
            <!--Optional:-->
            <cardNumber>10000002234</cardNumber>
            <!--Optional:-->
            <endDateFrom>2023-10-05</endDateFrom>
            <!--Optional:-->
            <endDateTo>2024-10-05</endDateTo>
            <!--Optional:-->
            <operationDateFrom>2023-10-02</operationDateFrom>
            <!--Optional:-->
            <operationDateTo>2024-10-05</operationDateTo>
            <!--Optional:-->
            <paymentDate>2023-10-05</paymentDate>
            <!--Optional:-->
            <saleDate>2023-10-05</saleDate>
            <!--Optional:-->
            <startDateFrom>2023-10-05</startDateFrom>
            <!--Optional:-->
            <startDateTo>2023-10-05</startDateTo>
            <!--Optional:-->
            <status>Active</status>
         </filter>
      </ser:getPresentCardsInfoByFilter>
   </soapenv:Body>
</soapenv:Envelope>
Пример расшифрованного из BASE64 ответа на запрос по получению информации по подарочной карте, используя фильтры выборки поиска 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<presentCards xmlns="http://crystals.ru/cards/presentcards/report">
	<presentCard>
		<cardNumber>10000002234</cardNumber>
		<amount>40000</amount>
		<balance>40000</balance>
		<status>Active</status>
		<startDate>2023-10-05T12:43:34.256+03:00</startDate>
		<endDate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
		<replacedCardNumber/>
		<actions>
			<action type="Create" date="2023-10-05T12:43:34.256+03:00" source="SERVER"/>
			<action type="Activate" date="2023-10-05T12:43:34.257+03:00" source="SERVER"/>
		</actions>
		<blockingCause xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
		<prolongationCause xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
	</presentCard>
</presentCards>

Погасить подарочную карту (перевести в статус "использована/погашена")

МетодpaymentPresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийГашение подарочной карты, полное списание. После вызова метода с номером карты, её статус будет "использована/погашена".

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНовый номер карты из существующих диапазоновДа
purchaseUidCollectionНабор полей чекаНет

cashNumLongНомер кассыНет
checkNumLongНомер чека к которому будет привязана активация подарочной картыНет
createDatedateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Нет
shiftNumLongНомер сменыНет
shopNumLongНомер магазинаНет
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

paymentPresentCardResponse
Отображение наименования ответа paymentPresentCardResponse в случае успешной обработки пакета

Описание формата данных

Пример запроса на гашение подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:paymentPresentCard>
         <!--Optional:-->
         <cardNumber>654987</cardNumber>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>2</cashNum>
            <!--Optional:-->
            <checkNum>4</checkNum>
            <!--Optional:-->
            <createDate>2019-05-15</createDate>
            <!--Optional:-->
            <shiftNum>8</shiftNum>
            <!--Optional:-->
            <shopNum>3382</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <userName>manager</userName>
         <!--Optional:-->
         <userTabNumber>1</userTabNumber>
      </ser:paymentPresentCard>
   </soapenv:Body>
</soapenv:Envelope>
Пример ответа на запрос Пример запроса гашения подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:paymentPresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"/>
   </soap:Body>
</soap:Envelope>

Списать сумму с подарочной карты

МетодredeemPresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийСписать частично указанную сумму с подарочной карты. Используется только при возможности частичного гашения/списания подарочной карты.

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНовый номер карты из существующих диапазоновДа
amountLong

Сумма списания в размере номинала подарочной карты.

Нельзя списать сумму превышающую номинал подарочной карты.

Да
purchaseUidCollectionНабор полей чекаДа

cashNumLongНомер кассыДа
checkNumLongНомер чека к которому будет привязана активация подарочной картыДа
createDatedateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Да
shiftNumLongНомер сменыДа
shopNumLongНомер магазинаДа
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

redeemPresentCardResponse
Отображение наименования ответа redeemPresentCardResponse в случае успешной обработки пакета

Описание формата данных

Пример запроса на списание суммы в размере 26руб.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:redeemPresentCard>
         <!--Optional:-->
         <cardNumber>111333</cardNumber>
         <!--Optional:-->
         <amount>2600</amount>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>2</cashNum>
            <!--Optional:-->
            <checkNum>4</checkNum>
            <!--Optional:-->
            <createDate>2019-05-15</createDate>
            <!--Optional:-->
            <shiftNum>8</shiftNum>
            <!--Optional:-->
            <shopNum>3382</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <userName>manager</userName>
         <!--Optional:-->
         <userTabNumber>1</userTabNumber>
      </ser:redeemPresentCard>
   </soapenv:Body>
</soapenv:Envelope>
Пример ответ на запроса по списанию суммы с подарочной карты.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:redeemPresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"/>
   </soap:Body>
</soap:Envelope>

Переотправить подарочные карты в SetESB/Kafka по фильтру

МетодresendPresentCardsToKafkaByFilter
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
Комментарий

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

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНомер картыНет
endDateFromdateTime

Дата окончания срока действия от

Формат: YYYY-MM-DD

Нет
endDateTodateTime

Дата окончания срока действия до

Формат: YYYY-MM-DD

Нет
operationDateFromdateTime

Дата начала действия по карте от

Формат: YYYY-MM-DD

Нет
operationDateTodateTime

Дата начала действия по карте до

Формат: YYYY-MM-DD

Нет
paymentDatedateTime

Дата гашения

Формат: YYYY-MM-DD

Нет
saleDatedateTime

Дата продажи 

Формат: YYYY-MM-DD

Нет
startDateFromdateTime

Дата начала срока действия от

Формат: YYYY-MM-DD

Нет
startDateTodateTime

Дата окончания срока действия до

Формат: YYYY-MM-DD

Нет
statusКоллекция статусов

Статус

  • Activate - активирована
  • Blocked - заблокирована
  • Changed - заменена
  • Create - создана
  • EXTEND - продлен срок действия
  • Inactive - неактивирована
  • PARTIAL_USE - частичное списана 
  • UNDO_USE - отмена использования (возврат из гашения)
  • Used - использовна
Нет

Возвращаемые параметры

resendPresentCardsToKafkaByFilterBase64Отображение наименования ответа resendPresentCardsToKafkaByFilter в случае успешной обработки пакета

Описание формата данных

Пример запроса на переотправку подарочные карты в SetESB/Kafka по фильтру
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:resendPresentCardsToKafkaByFilter>
         <!--Optional:-->
         <filter>
            <!--Optional:-->
            <cardNumber>10000002234</cardNumber>
            <!--Optional:-->
            <endDateFrom>2023-10-05</endDateFrom>
            <!--Optional:-->
            <endDateTo>2024-10-05</endDateTo>
            <!--Optional:-->
            <operationDateFrom>2023-10-02</operationDateFrom>
            <!--Optional:-->
            <operationDateTo>2024-10-05</operationDateTo>
            <!--Optional:-->
            <paymentDate>2023-10-05</paymentDate>
            <!--Optional:-->
            <saleDate>2023-10-05</saleDate>
            <!--Optional:-->
            <startDateFrom>2023-10-05</startDateFrom>
            <!--Optional:-->
            <startDateTo>2023-10-05</startDateTo>
            <!--Optional:-->
            <status>Active</status>
         </filter>
      </ser:resendPresentCardsToKafkaByFilter>
   </soapenv:Body>
</soapenv:Envelope>
Пример ответа на запрос на переотправку подарочные карты в SetESB/Kafka по фильтру
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:resendPresentCardsToKafkaByFilterResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"/>
   </soap:Body>
</soap:Envelope>

Отмена использования подарочной карты (возврат из статуса погашенной)

МетодundoUsePresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийОтменить использование подарочной карты

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНовый номер карты из существующих диапазоновДа
purchaseUidCollectionНабор полей чекаНет

cashNumLongНомер кассыНет
checkNumLongНомер чека к которому будет привязана активация подарочной картыНет
createDatedateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Нет
shiftNumLongНомер сменыНет
shopNumLongНомер магазинаНет
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

activationDatedateTimeДата активации
amountLongНоминал
balanceLongОстаток на карте
cardNumberStringНомер карты
maxAmountStringМаксимальный номинал
multiplicityStringКратность
statusString

Статус

  • Activate - активирована
  • Blocked - заблокирована
  • Changed - заменена
  • Create - создана
  • EXTEND - продлен срок действия
  • Inactive - неактивирована
  • PARTIAL_USE - частичное списана 
  • UNDO_USE - отмена использования (возврат из гашения)
  • Used - использована

Описание формата данных

Пример запроса на отмену использования подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:undoUsePresentCard>
         <!--Optional:-->
         <cardNumber>10000002234</cardNumber>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>3</cashNum>
            <!--Optional:-->
            <checkNum>2</checkNum>
            <!--Optional:-->
            <createDate>2023-10-05</createDate>
            <!--Optional:-->
            <shiftNum>34</shiftNum>
            <!--Optional:-->
            <shopNum>57</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <userName>manager</userName>
         <!--Optional:-->
         <userTabNumber>344</userTabNumber>
      </ser:undoUsePresentCard>
   </soapenv:Body>
</soapenv:Envelope>
Пример ответа на запрос отмены использования подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:undoUsePresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/">
         <return>
            <activationDate>2023-10-05T12:43:34.256+03:00</activationDate>
            <amount>40000</amount>
            <balance>40000</balance>
            <cardNumber>10000002234</cardNumber>
            <maxAmount>0</maxAmount>
            <multiplicity>0</multiplicity>
            <status>Active</status>
         </return>
      </ns2:undoUsePresentCardResponse>
   </soap:Body>
</soap:Envelope>

  

Разблокировка подарочной карты (возврат из статуса заблокированной)

МетодunblockPresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийРазблокировать подарочную карту.

SR-7050 - Получение подробных данных проблемы… СТАТУС

CR-9726 - Получение подробных данных проблемы… СТАТУС

10.4.1.0

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumberStringНомер картыДа
purchaseUidCollectionНабор полей чекаНет

cashNumLongНомер кассыНет
checkNumLongНомер чека, к которому будет привязана разблокировка подарочной картыНет
createDatedateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Нет
shiftNumLongНомер сменыНет
shopNumLongНомер магазинаНет
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет
commentStringКомментарийНет

Возвращаемые параметры

unblockPresentCardResponse

Отображение наименования ответа unblockPresentCardResponse в случае успешной обработки пакета


Описание формата данных

Пример запроса на разблокировку подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:unblockPresentCard>
         <!--Optional:-->
         <cardNumber>2000</cardNumber>
         <!--Optional:-->
         <purchaseUid>
            <!--Optional:-->
            <cashNum>60</cashNum>
            <!--Optional:-->
            <checkNum>3</checkNum>
            <!--Optional:-->
            <createDate>2024-03-07T17:20:00</createDate>
            <!--Optional:-->
            <shiftNum>3</shiftNum>
            <!--Optional:-->
            <shopNum>188</shopNum>
         </purchaseUid>
         <!--Optional:-->
         <userName>Ext_user</userName>
         <!--Optional:-->
         <userTabNumber>3</userTabNumber>
         <!--Optional:-->
         <comment>Unblock card from external system</comment>
      </ser:unblockPresentCard>
   </soapenv:Body>
</soapenv:Envelope>
Пример успешного ответа на запрос разблокировки подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:unblockPresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"/>
   </soap:Body>
</soap:Envelope>
Пример ответа с ошибкой на запрос разблокировки подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <soap:Fault>
         <faultcode>soap:Server</faultcode>
         <faultstring>Некорректное состояние карты</faultstring>
         <detail>
            <ns1:PresentCardException xmlns:ns1="http://services.processing.cards.crystals.ru/"/>
         </detail>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

Продление срока действия подарочной карты

МетодprolongPresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийПродление срока действия подарочной карты.

SR-7558 - Получение подробных данных проблемы… СТАТУС

CR-12275 - Получение подробных данных проблемы… СТАТУС

10.4.8.0

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumber

String

Номер карты

Да
dateDateTime

Дата окончания действия подарочной карты

Если дата передана без указания времени, то срок действия карты будет продлён до 23:59 указанной даты.

Да
prolongationCauseStringПричина продленияНет
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

activationDateDateTimeДата активации




amount

Long

Номинал

balanceLongОстаток на карте
cardNumberStringНомер карты
expirationDateDateTimeДата окончания действия карты
maxAmountLongМаксимальный номинал
multiplicityLongКратность
statusString

Статус

  • Activate - активирована
  • Blocked - заблокирована
  • Create - создана
  • Inactive - неактивирована
  • Used - использована

Описание формата данных

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
	<soapenv:Header/>
	<soapenv:Body>
		<ser:prolongPresentCard>
			<cardNumber>5999321</cardNumber>
			<date>2024-11-29T12:41:12.191+03:00</date>
			<prolongationCause>test</prolongationCause>
			<userName>Oleg</userName>
			<userTabNumber>23</userTabNumber>
		</ser:prolongPresentCard>
	</soapenv:Body>
</soapenv:Envelope>
Пример ответа
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:prolongPresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/">
			<return>
				<activationDate>2024-11-21T12:41:12.191+03:00</activationDate>
				<amount>0</amount>
				<balance>0</balance>
				<cardNumber>5999321</cardNumber>
				<expirationDate>2024-11-29T12:41:12.191+03:00</expirationDate>
				<maxAmount>1500000</maxAmount>
				<multiplicity>10000</multiplicity>
				<status>Create</status>
			</return>
		</ns2:prolongPresentCardResponse>
	</soap:Body>
</soap:Envelope>

Возврат денежных средств на подарочную карту

МетодrefundPresentCard
URLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager
WSDLhttp://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl
КомментарийВозврат денежных средств на подарочную карту.

SR-7558 - Получение подробных данных проблемы… СТАТУС

CR-12275 - Получение подробных данных проблемы… СТАТУС

10.4.8.0

Поле

Тип данных

Описание

Обязательное

Принимаемые параметры

cardNumber

String

Номер карты

Да
amountLongСумма к возвратуДа
purchaseUidCollectionНабор полей чекаНет

cashNumLongНомер кассыНет
checkNumLongНомер чекаНет
createDateDateTime

Дата регистрации чека

Формат: YYYY-MM-DD

Нет
shiftNumLongНомер сменыНет
shopNumLongНомер магазинаНет
userNameStringИмя пользователяНет
userTabNumberStringID серверного пользователяНет

Возвращаемые параметры

activationDateDateTimeДата активации




amount

Long

Номинал

balanceLongОстаток на карте
cardNumberStringНомер карты
expirationDateDateTimeДата окончания действия карты
maxAmountLongМаксимальный номинал
multiplicityLongКратность
statusString

Статус

  • Activate - активирована
  • Blocked - заблокирована
  • Create - создана
  • Inactive - неактивирована
  • Used - использована

Описание формата данных

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/">
	<soapenv:Header/>
	<soapenv:Body>
		<ser:refundPresentCardResponse>
			<cardNumber>5999321</cardNumber>
			<amount>500</amount>
			<purchaseUid>
				<cashNum>1</cashNum>
				<checkNum>1</checkNum>
				<createDate>2024-11-21</createDate>
				<shiftNum>1</shiftNum>
				<shopNum>9969</shopNum>
			</purchaseUid>
			<userName>Oleg</userName>
			<userTabNumber>1</userTabNumber>
		</ser:refundPresentCardResponse>
	</soapenv:Body>
</soapenv:Envelope>
Пример ответа
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:refundPresentCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/">
			<return>
				<activationDate>2024-11-21T00:00:00+03:00</activationDate>
				<amount>300000</amount>
				<balance>500</balance>
				<cardNumber>1000</cardNumber>
				<maxAmount>0</maxAmount>
				<multiplicity>0</multiplicity>
				<status>Active</status>
			</return>
		</ns2:refundPresentCardResponse>
	</soap:Body>
</soap:Envelope>

Формат данных

presentCards/presentCard

Наименование атрибута

Тип данных

Обязательное

Описание

cardNumber

StringДаНомер карты
amountLongДаНоминал
balanceLongНетОстаток на карте
statusStringДа

Статус:

  • Activate
  • Blocked
  • Changed
  • Create
  • EXTEND
  • Inactive
  • PARTIAL_USE
  • UNDO_USE
  • Used
startDateDateДа

Дата начала действия карты

Формат: yyyy-MM-dd hh:mm:ss.mmm

endDateDateНет

Дата окончания действия карты

Формат: yyyy-MM-dd hh:mm:ss.mmm

replacedCardNumberStringНетНомер карты замены
actionsCollectionДаНабор действий с картой

typeStringДаНазвание действия
dateDateДаДата совершения действия
loginStringНетФИО или логин совершившего действие
sourceStringДа

Инициатор действия:

  • CASH
  • ERP
  • SERVER
  • UNKNOWN
cashStringНетНомер кассы
shopStringДаНомер магазина

© 1994-2024, ООО "Кристалл Сервис Интеграция".
Все права защищены.

Политика обработки персональных данных