/
Веб-сервис экспорта информации по подарочным картам (на стороне SetRetail10)

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

Веб-сервис экспорта информации по подарочным картам (на стороне SetRetail10)

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

10.2.59.0

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

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

Метод

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

Номер карты

Да

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

return

XML

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

 

activationDate

DateTime

Дата активации карты

 

amount

Long

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

 

balance

Long

Остаток суммы подарочной карты

 

cardNumber

String

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

 

expirationDate

DateTime

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

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

 

maxAmount

Long

Максимальная сумма произвольного номинала

 

multiplicity

Long

Кратность для суммы произвольного номинала

 

pinCode

String

Пин-код 

 

status

CardStatus

Статус подарочной карты:

В этом методе может быть статус карты Active, но, при этом у карты может быть просрочена дата окончания действия.

Проверяйте дату окончания отдельно.

  • Create

  • Active

  • Blocked

  • Inactive

  • Used

  • PreActive

  • PreUsed

  • PreDeactive

  • NeedReturn

  • NeedTakeAway

 

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

Пример запроса
<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>7810001</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-11-30T12:42:52.064+03:00</activationDate> <amount>400000</amount> <balance>400000</balance> <cardNumber>7810001</cardNumber> <maxAmount>500000</maxAmount> <multiplicity>100</multiplicity> <status>Active</status> </return> </ns2:getPresentCardInformationResponse> </soap:Body> </soap:Envelope>

По номеру магнитной полосы MSR подарочной карты

Метод

getPresentCardInformationByMSRNumber

URL

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

WSDL

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

Поле

Тип данных

Описание

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

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

msrNumber

String

Номер карты с магнитной дорожки

Да

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

return

XML

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

 

activationDate

DateTime

Дата активации карты

 

amount

Long

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

 

balance

Long

Остаток суммы подарочной карты

 

cardNumber

String

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

 

expirationDate

DateTime

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

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

 

maxAmount

Long

Максимальная сумма произвольного номинала

 

multiplicity

Long

Кратность для суммы произвольного номинала

 

pinCode

String

Пин-код 

 

status

CardStatus

Статус подарочной карты:

В этом методе может быть статус карты Active, но, при этом у карты может быть просрочена дата окончания действия.

Проверяйте дату окончания отдельно.

  • Create

  • Active

  • Blocked

  • Inactive

  • Used

  • PreActive

  • PreUsed

  • PreDeactive

  • NeedReturn

  • NeedTakeAway

 

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

Пример запроса
<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>7810001</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> <activationDate>2023-11-30T12:42:52.064+03:00</activationDate> <amount>400000</amount> <balance>400000</balance> <cardNumber>7810001</cardNumber> <maxAmount>500000</maxAmount> <multiplicity>100</multiplicity> <status>Active</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

cardStatus

Статус подарочной карты:

  • Create

  • Active

  • Blocked

  • Inactive

  • Used

  • PreActive

  • PreUsed

  • PreDeactive

  • NeedReturn

  • NeedTakeAway

Нет

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

result

base64Binary

Информация по подарочным картам в формате XML, закодированного в Base64.

 

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

Пример запроса
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.processing.cards.crystals.ru/"> <soapenv:Header/> <soapenv:Body> <ser:getPresentCardsInfoByFilter> <filter> <startDateFrom>2025-10-10</startDateFrom> <startDateTo>2025-10-18</startDateTo> <status>Blocked</status> </filter> </ser:getPresentCardsInfoByFilter> </soapenv:Body> </soapenv:Envelope>

Результатом метода является закодированный XML-документ, содержащий массив карт. Все карты соответствуют заданному в запросе фильтру.

Если какой-либо элемент не заполнен, то в теге присутствуют атрибуты: xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"

Пример XML, декодированного из Base64
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <presentCards xmlns="http://crystals.ru/cards/presentcards/report"> <presentCard> <cardNumber>50005121001</cardNumber> <amount>500000</amount> <balance>500000</balance> <status>Blocked</status> <startDate>2025-10-17T18:43:07.348+03:00</startDate> <endDate>2026-10-17T23:59:59.999+03:00</endDate> <replacedCardNumber/> <actions> <action type="Create" date="2025-10-17T18:43:07.348+03:00" login="manager" source="SERVER"/> <action type="Blocked" date="2025-10-17T18:43:07.349+03:00" login="manager" source="SERVER"/> </actions> <blockingCause>Данная карта была заблокирована по причине утраты ее владельцем</blockingCause> <prolongationCause xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/> </presentCard> <presentCard> <cardNumber>50005121002</cardNumber> <amount>500000</amount> <balance>500000</balance> <status>Blocked</status> <startDate>2025-10-17T18:43:07.354+03:00</startDate> <endDate>2026-10-17T23:59:59.999+03:00</endDate> <replacedCardNumber/> <actions> <action type="Create" date="2025-10-17T18:43:07.355+03:00" login="manager" source="SERVER"/> <action type="Blocked" date="2025-10-17T18:43:07.355+03:00" login="manager" source="SERVER"/> </actions> <blockingCause>Данная карта была заблокирована по причине утраты ее владельцем</blockingCause> <prolongationCause xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/> </presentCard> </presentCards>