/
Веб-сервис по управлению статусами и балансами подарочных карт

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

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

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

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

Метод

activatePresentCard

URL

http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager

WSDL

http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl

Комментарий

Активация подарочных карт, в качестве входных параметров принимает фильтр, по которому и будут отобраны карты для активации.

Поле

Тип данных

Описание

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

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

cardNumber

String

Номер карты

Да

purchaseUid

Collection

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

Нет

 

cashNum

Long

Номер кассы

Нет

checkNum

Long

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

Нет

createDate

dateTime

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

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

Нет

shiftNum

Long

Номер смены

Нет

shopNum

Long

Номер магазина

Нет

amount

Long

Номинал

Нет

userName

String

Имя пользователя

Нет

userTabNumber

String

ID серверного пользователя

Нет

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

amount

Long

Номинал

 

balance

Long

Остаток на карте

 

cardNumber

String

Номер карты

 

expirationDate

dateTime

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

 

pinCode

String

Пин-код

https://crystals.atlassian.net/browse/SR-7883

https://crystals.atlassian.net/browse/CR-11474

10.4.13.0

 

status

String

Статус:

  • 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> <pinCode>12345</pinCode> <status>Active</status> </return> </ns2:activatePresentCardResponse> </soap:Body> </soap:Envelope>

Активация свободной подарочной карты из указанной категории

Метод

activateAvailableCard

URL

http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager

WSDL

http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl

Комментарий

Активация свободной подарочной карты из доступного диапазона указанной категории карт.

Действует только для цифровых номеров карт.

https://crystals.atlassian.net/browse/SR-8208

https://crystals.atlassian.net/browse/CR-13886

10.4.15.0

Поле

Тип данных

Описание

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

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

cardTypeId

String

ID категории подарочных карт

Да

purchaseUid

Collection

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

Нет

 

cashNum

Long

Номер кассы

Нет

checkNum

Long

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

Нет

createDate

DateTime

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

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

Нет

shiftNum

Long

Номер смены

Нет

shopNum

Long

Номер магазина

Нет

amount

Long

Номинал.

Обязательно указывается для карт с нефиксированным номиналом

Нет

userName

String

Имя пользователя

Нет

userTabNumber

String

ID серверного пользователя

Нет

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

activationDate

dateTime

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

 

amount

Long

Номинал

 

balance

Long

Остаток на карте

 

cardNumber

String

Номер карты

 

maxAmount

String

Максимальный номинал

 

multiplicity

String

Кратность

 

pinCode

String

Пин-код

 

status

String

Статус

  • 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:activateAvailableCard> <cardTypeId>136</cardTypeId> </ser:activateAvailableCard> </soapenv:Body> </soapenv:Envelope>
Пример ответа на запрос активации свободной подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:activateAvailableCardResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"> <return> <activationDate>2025-04-22T12:50:00.036+03:00</activationDate> <amount>300000</amount> <balance>300000</balance> <cardNumber>100000032234</cardNumber> <maxAmount>0</maxAmount> <multiplicity>0</multiplicity> <pinCode>12345</pinCode> <status>Active</status> </return> </ns2:activateAvailableCardResponse> </soap:Body> </soap:Envelope>

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

Метод

cardReplacement

URL

http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager

WSDL

http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl

Комментарий

Замена подарочной карты. Указываются номер двух карт, старой (которую требуется заменить), и новую (которая будет выдана вместо старой).

Поле

Тип данных

Описание

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

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

cardNumberOld

String

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

Да

cardNumberNew

String

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

Да

purchaseUid

Collection

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

Нет

 

cashNum

Long

Номер кассы

Нет

checkNum

Long

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

Нет

createDate

dateTime

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

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

Нет

shiftNum

Long

Номер смены

Нет

shopNum

Long

Номер магазина

Нет

userName

String

Имя пользователя

Нет

userTabNumber

String

ID серверного пользователя

Нет

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

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

URL

http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager

WSDL

http://IP-адрес_сервера:8090/SET-Cards-PresentCards/SET/Cards/PresentCards/ProcessingManager?wsdl

Комментарий

Гашение подарочной карты, полное списание. После вызова метода с номером карты, её статус будет "использована/погашена".

Поле

Тип данных

Описание

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

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

cardNumber

String

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

Да

purchaseUid

Collection

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

Нет

 

cashNum

Long

Номер кассы

Нет

checkNum

Long

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

Нет

createDate

dateTime

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

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

Нет

shiftNum

Long

Номер смены