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

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

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

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

  • Возможны только варианты импорта по подарочным картам ниже.

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

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

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

Метод

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

Номер смены

Нет

shopNum

Long

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

Нет

userName

String

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

Нет

userTabNumber

String

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

Нет

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

amount

Long

Номинал

 

balance

Long

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

 

cardNumber

String

Номер карты

 

expirationDate

dateTime

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

 

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: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

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

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

Да

msrCardNumber

String

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

Нет

shopNumber

Long

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

Нет

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

activationDate

dateTime

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

 

amount

Long

Номинал

 

balance

Long

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

 

cardNumber

String

Номер карты

 

maxAmount

String

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

 

multiplicity

String

Кратность

 

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

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

Метод

getPresentCardInformation

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

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

Да

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

activationDate

dateTime

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

 

amount

Long

Номинал

 

balance

Long

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

 

cardNumber

String

Номер карты

 

maxAmount

String

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

 

multiplicity

String

Кратность

 

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: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> <pinCode>12345</pinCode> <status>Used</status> </return> </ns2:getPresentCardInformationResponse> </soap:Body> </soap:Envelope>

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

Метод

getPresentCardInformationByMSRNumber

URL

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

WSDL

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

Комментарий

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

Поле

Тип данных

Описание

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

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

msrCardNumber

String

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

Да

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

activationDate

dateTime

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

 

amount

Long

Номинал

 

balance

Long

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

 

cardNumber

String

Номер карты

 

maxAmount

String

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

 

multiplicity

String

Кратность

 

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: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> <pinCode>12345</pinCode> <status>Create</status> </return> </ns2:getPresentCardInformationByMSRNumberResponse> </soap:Body> </soap:Envelope>

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

Метод

getPresentCardsInfoByFilter

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

Номер карты

Нет

endDateFrom

dateTime

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

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

Нет

endDateTo

dateTime

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

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

Нет

operationDateFrom

dateTime

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

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

Нет

operationDateTo

dateTime

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

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

Нет

paymentDate

dateTime

Дата гашения

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

Нет

saleDate

dateTime

Дата продажи 

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

Нет

startDateFrom

dateTime

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

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

Нет

startDateTo

dateTime

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

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

Нет

status

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

Статус

  • Activate - активирована

  • Blocked - заблокирована

  • Changed - заменена

  • Create - создана

  • EXTEND - продлен срок действия

  • Inactive - неактивирована

  • PARTIAL_USE - частичное списана 

  • UNDO_USE - отмена использования (возврат из гашения)

  • Used - использовна

Нет

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

getPresentCardsInfoByFilterResponse

Base64

Информация по подарочной карте в формате 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

Комплексный

Причина продления

 

  • pinCode

String

Пин-код

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

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

10.4.13.0

 

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

Пример запроса на получение информации по подарочной карте, используя фильтры выборки поиска 
<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"/> <pinCode>12345</pinCode> </presentCard> </presentCards>

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

Метод

paymentPresentCard

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

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

Нет

userName

String

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

Нет

userTabNumber

String

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

Нет

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

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

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

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

Да

amount

Long

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

Да

purchaseUid

Collection

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

Да

 

cashNum

Long

Номер кассы

Да

checkNum

Long

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

Да

createDate

dateTime

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

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

Да

shiftNum

Long

Номер смены

Да

shopNum

Long

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

Да

userName

String

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

Нет

userTabNumber

String

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

Нет

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

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>

Списать средства с подарочной карты, защищенной пин-кодом

Метод

usePresentCard

URL

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

WSDL

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

Комментарий

Cписать заданную сумму с баланса подарочной карты или погасить карту полностью. Поддерживается возможность списания с указанием пин-кода карты.

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

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

10.4.13.0

Поле

Тип данных

Описание

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

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

request

Object

Запрос

Да






cardNumber

String

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

Да

pinCode

String

Пин-код

Нет

amount

Long

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

Если параметр amount не указан, то карта будет погашена полностью.

Нет

purchaseUid

Collection

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

Да

 

cashNum

Long

Номер кассы

Да

checkNum

Long

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

Да

createDate

dateTime

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

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

Да

shiftNum

Long

Номер смены

Да

shopNum

Long

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

Да

userName

String

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

Нет

userTabNumber

String

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

Нет

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

usePresentCardResponse

 

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

 

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

Пример запроса на списание суммы в размере 26 руб.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <ser:usePresentCard> <request> <!--Optional:--> <cardNumber>111333</cardNumber> <!--Optional:--> <pinCode>1236</pinCode> <!--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> </request> </ser:usePresentCard> </soapenv:Body> </soapenv:Envelope>
Пример успешного ответа на запроса по списанию суммы с подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:usePresentCardResponse 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>Введен неверный ПИН-код. Осталось попыток: 1</faultstring> <detail> <ns1:PresentCardException xmlns:ns1="http://services.processing.cards.crystals.ru/"/> </detail> </soap:Fault> </soap:Body> </soap:Envelope>

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

Метод

resendPresentCardsToKafkaByFilter

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

Номер карты

Нет

endDateFrom

dateTime

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

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

Нет

endDateTo

dateTime

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

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

Нет

operationDateFrom

dateTime

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

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

Нет

operationDateTo

dateTime

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

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

Нет

paymentDate

dateTime

Дата гашения

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

Нет

saleDate

dateTime

Дата продажи 

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

Нет

startDateFrom

dateTime

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

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

Нет

startDateTo

dateTime

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

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

Нет

status

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

Статус

  • Activate - активирована

  • Blocked - заблокирована

  • Changed - заменена

  • Create - создана

  • EXTEND - продлен срок действия

  • Inactive - неактивирована

  • PARTIAL_USE - частичное списана 

  • UNDO_USE - отмена использования (возврат из гашения)

  • Used - использовна

Нет

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

resendPresentCardsToKafkaByFilter

Base64

Отображение наименования ответа 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

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

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

Нет

userName

String

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

Нет

userTabNumber

String

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

Нет

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

activationDate

dateTime

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

 

amount

Long

Номинал

 

balance

Long

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

 

cardNumber

String

Номер карты

 

maxAmount

String

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

 

multiplicity

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: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>

Блокировка подарочной карты

Метод

blockPresentCard

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-7769

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

10.4.13.0

Поле

Тип данных

Описание

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

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

cardNumber

String

Номер карты

Да

purchaseUid

Collection

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

Нет

 

cashNum

Long

Номер кассы

Нет

checkNum

Long

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

Нет

createDate

dateTime

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

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

Нет

shiftNum

Long

Номер смены

Нет

shopNum

Long

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

Нет

userName

String

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

Нет

userTabNumber

String

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

Нет

comment

String

Комментарий / причина блокировки

Нет

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

unblockPresentCardResponse

 

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

 

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

Пример запроса на блокировку подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <ser:blockPresentCard> <!--Optional:--> <cardNumber>2000</cardNumber> <!--Optional:--> <purchaseUid> <!--Optional:--> <cashNum>60</cashNum> <!--Optional:--> <checkNum>3</checkNum> <!--Optional:--> <createDate>2024-03-07</createDate> <!--Optional:--> <shiftNum>3</shiftNum> <!--Optional:--> <shopNum>188</shopNum> </purchaseUid> <!--Optional:--> <userName>Ext_user</userName> <!--Optional:--> <userTabNumber>3</userTabNumber> <!--Optional:--> <comment>block card from external system</comment> </ser:blockPresentCard> </soapenv:Body> </soapenv:Envelope>
Пример успешного ответа на запрос блокировки подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:blockPresentCardResponse 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>

  

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

Метод

unblockPresentCard

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-7050

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

10.4.1.0

Поле

Тип данных

Описание

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

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

cardNumber

String

Номер карты

Да

purchaseUid

Collection

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

Нет

 

cashNum

Long

Номер кассы

Нет

checkNum

Long

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

Нет

createDate

dateTime

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

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

Нет

shiftNum

Long

Номер смены

Нет

shopNum

Long

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

Нет

userName

String

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

Нет

userTabNumber

String

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

Нет

comment

String

Комментарий

Нет

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

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

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-7558

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

10.4.8.0

Поле

Тип данных

Описание

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

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

cardNumber

String

Номер карты

Да

date

DateTime

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

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

Да

prolongationCause

String

Причина продления

Нет

userName

String

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

Нет

userTabNumber

String

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

Нет

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

activationDate

DateTime

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






amount

Long

Номинал

balance

Long

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

cardNumber

String

Номер карты

expirationDate

DateTime

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

maxAmount

Long

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

multiplicity

Long

Кратность

status

String

Статус

  • 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

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-7558

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

10.4.8.0

Поле

Тип данных

Описание

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

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

cardNumber

String

Номер карты

Да

amount

Long

Сумма к возврату

Да

purchaseUid

Collection

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

Нет

 

cashNum

Long

Номер кассы

Нет

checkNum

Long

Номер чека

Нет

createDate

DateTime

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

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

Нет

shiftNum

Long

Номер смены

Нет

shopNum

Long

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

Нет

userName

String

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

Нет

userTabNumber

String

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

Нет

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

activationDate

DateTime

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






amount

Long

Номинал

balance

Long

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

cardNumber

String

Номер карты

expirationDate

DateTime

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

maxAmount

Long

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

multiplicity

Long

Кратность

status

String

Статус

  • 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>

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

Метод

restorePresentCardPinCode

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-7883

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

10.4.13.0

Поле

Тип данных

Описание

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

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

request

Object

Запрос

Да

 

cardNumber

String

Номер кассы

Да

userName

String

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

Нет

userTabNumber

String

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

Нет

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

return

String

Новый пин-код

 

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

Пример запроса на восстановление пин-кода подарочной карты
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <ser:restorePresentCardPinCode> <!--Optional:--> <request> <cardNumber>111333</cardNumber> <!--Optional:--> <userName>manager</userName> <!--Optional:--> <userTabNumber>1</userTabNumber> </request> </ser:restorePresentCardPinCode> </soapenv:Body> </soapenv:Envelope>
Пример ответа на запрос восстановления пин-кода подарочной карты
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:restorePresentCardPinCodeResponse xmlns:ns2="http://services.processing.cards.crystals.ru/"> <return>58579</return> </ns2:restorePresentCardPinCodeResponse> </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>

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

presentCards/presentCard

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

Тип данных

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

Описание

cardNumber

String

Да

Номер карты

amount

Long

Да

Номинал

balance

Long

Нет

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

status

String

Да

Статус:

  • Activate

  • Blocked

  • Changed

  • CODE_RESTORED

  • Create

  • EXPIRED

  • EXTEND

  • Inactive

  • INCORRECT_CODE

  • PARTIAL_USE

  • REFUND

  • UNDO_USE

  • UNLOCKING

  • Used

startDate

Date

Да

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

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

endDate

Date

Нет

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

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

replacedCardNumber

String

Нет

Номер карты замены

actions

Collection

Да

Набор действий с картой

 

type

String

Да

Название действия

date

Date

Да

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

login

String

Нет

ФИО или логин совершившего действие

source

String

Да

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

  • CASH

  • ERP

  • SERVER

  • UNKNOWN

cash

String

Нет

Номер кассы

shop

String

Да

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

blockingCause

String

Нет

Причина блокировки карты или замены, если карта была возвращена

prolongationCause

String

Нет

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

pinCode

String

Нет

Пин-код карты

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

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