Центр финансовых технологий (стр. 1 )

Дополнение № 1.1. Приложения № 1 к конкурсной документации

«Описание XML интерфейса ПЦ “ЦФТ–Лояльность”

Центр Финансовых Технологий

Описание XML интерфейса ПЦ “ЦФТ–Лояльность”

Версия 2.8.2

Идентификационный лист документа

Проект:
Документ:	Описание XML интерфейса ПЦ “ЦФТ–Лояльность”
Имя файла:	CFTLoyaltyPCPoints.2.8.x. doc
Идентификатор	GBD. PC.011
Дата создания:	25.09.11
Версия документа:	2.8.2
Статус:	Для служебного пользования
Разработчик:	Центр Финансовых Технологий Группа процессинговых технологий
© Центр Финансовых Технологий, 1999

Терминология

Point of sale (POS)	Точка обслуживания (касса). Имеет уникальный идентификатор.
ПЦ “ЦФТ–Лояльность” (ПЦ)	Процессинговый Центр, который обеспечивает ведение клиентских счетов лояльности, авторизацию операций и начисление бонусов.
Участник	Торгово-сервисное предприятие (торговая сеть), реализующая программу(ы) Лояльности.
Автоматизированная Система Участника (АС)	Автоматизированная система, которая обеспечивает: управление POS’ами (опционально); подключение POS’ов к ПЦ в режиме Online для авторизации операций.
Балл	Условная единица, начисляемая клиенту за совершение покупки в соответствии с программой Лояльности
Бонусы	Синоним «баллы»
Оnline, онлайн, режим online	Взаимодействие “касса – ПЦ” (АС-ПЦ) производится  синхронно в режиме реального времени.
Offline, оффлайн, режим offline	Взаимодействие “касса – ПЦ” (АС-ПЦ) производится  асинхронно. Касса отправляет запрос в ПЦ, ПЦ формирует ответ о том, что запрос принят. Запрос обрабатывается позже.
Батч	Пакет операций, передаваемый в ПЦ одним запросом. Один пакет может содержать одну или несколько операций.
Купон	Зарегистрированное право клиента на получение каких-то специальных преференций. Свойства купона задаются купонным предложением, в рамках которого он выдается.
Купонное предложение	Зарегистрированное в ПЦ описание свойств набора купонов.

Цели документа

Данный документ содержит техническое описание интерфейса ПЦ, предоставляемого для подключения касс Участника для реализации БОНУСНЫХ и ПОДАРОЧНЫХ программ лояльности.

Архитектура

Возможны три варианта подключения POS’ов Участника к ПЦ Лояльности:

POS’ы Участника подключены к АС Участника, АС Участника подключен к ПЦ Лояльности. Все взаимодействие (Online и передача батчей) между POS'ом и ПЦ Лояльности проводится через АС Участника. POS’ы Участника подключены напрямую к ПЦ Лояльности. Online-запросы и батчи направляются напрямую в ПЦ Лояльности. POS’ы Участника напрямую взаимодействуют с Процессинговым Центром при Online взаимодействии. Батчи передаются в Процессинговый Центр через АС Участника. Техническая спецификация интерфейса Аннотация

Аббревиатура	Описание
u	Буквенный, цифровой, специальный символ в UTF-8.
a	Буквенный символ, латиница (ASCII).
n	Цифровой символ
s	Специальный символ, включая запятую и ‘/’.
an	Цифровой или буквенный символ
ns	Цифровой или специальный символ
ans	Цифровой, буквенный или специальный символ
YYYY	Год (например, 2006)
MM	Месяц
DD	День
hh	Час (0-24)
mm	Минуты
ss	Секунды
3	Фиксированная длина – 3 позиции
..17	Переменная длина до 17 позиций
M	Поле обязательно (Mandatory)
O	Поле необязательно, опционально (Optional)
С	Поле условно обязательно (Conditional). Может быть обязательным при определенных условиях.

Интерфейс

Интерфейс включает в себя 16 методов.

Метод getInfo

Метод используется для реализации сценариев запроса информации по картам (бонусной и подарочной).

Параметры

Структура TransactionData. Структура предназначена для передачи ключевой информации об операции.

Возвращаемое значение

Структура AuthResponseData. Структура предназначена для передачи ответа на запрос операции.

Порядок обработки сообщений

Заметки

При неполучении ответа от ПЦ или при получении ошибки 996, касса НЕ посылает откат в ПЦ.

Метод authPoints

Метод используется для реализации следующих сценариев: оплата баллами, начисление баллов в режиме Online, оплата баллами с авторизацией по токену (для Интернет-платежей).

Параметры

Структура AuthRequestData. Структура предназначена для передачи запроса операции.

Возвращаемое значение

Структура AuthResponseData. Структура предназначена для передачи ответа на запрос операции.

Порядок обработки сообщений

Метод authPoints для оплаты баллами

Для реализации сценария “оплата баллами” необходимо в структуре для передачи платежных инструментов передать платежный инструмент ‘P’ (Points) и только его. Сумма операции равна рублевой сумме, которая оплачивается баллами и совпадает с суммой по платежному инструменту 'P' (Points).

Оплата баллами. Успех

Оплата баллами. Нет ответа от ПЦ или ошибка 996

Метод authPoints для начисления баллов

Для реализации сценария “начисление баллов” необходимо в структуре для передачи платежных инструментов передавать платежные инструменты кроме ‘P’. Сумма операции равна сумме покупки, оплаченной клиентом, сумма покупки должна равняться сумме по всем платежным инструментам. Если часть покупки была оплачена баллами, то эти баллы указываются как платежный инструмент ‘N’.

Операция начисления баллов всегда передается в батче, вне зависимости от результата Online запроса.

Начисление баллов. Успех

Начисление баллов. Нет ответа от ПЦ или ошибка 996.

Метод batchLoad

Пакетная загрузка допустима для следующих операций:

Операция Начисление баллов (дополнительный сценарий). Операция Возврат на операцию начисления баллов (дополнительный сценарий), Возврат на операцию оплаты баллами (дополнительный сценарий)

Операции списания баллов в пакетном режиме передавать в ПЦ НЕЛЬЗЯ. Если в пакете будут содержаться операции списания баллов, то пакет будет принят ПЦ, но такие операции обработаны не будут.

ПЦ подтверждает получение или неполучение ВСЕГО пакета. Положительное подтверждение ПЦ в получении пакета не означает, что все транзакции в пакете будут успешно обработаны. Обработка транзакций, полученных в пакете, выполняется асинхронно, некоторые операции могут быть обработаны с ошибками. Транзакции, которые обработаны с ошибкой, уходят на ручной разбор.

Параметры

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

Возвращаемое значение

Структура ResponseStatus. Результат выполнения операции в ПЦ.

Порядок обработки сообщений

Посылка батча. Успех

Повторная посылка батча

Если ПЦ не подтвердил получение пакета (нет ответа, нет связи, ошибка 996), операции из очереди НЕ удаляются и должны быть переданы в ПЦ еще раз.

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

Передача пакета осуществляется до тех пор, пока не будет получено подтверждение от ПЦ.

Метод reverse

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

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

запрос был послан в ПЦ, но ответа в определенное время получено не было (нет ответа от ПЦ); в ответ за запрос ПЦ прислал ответ с кодом INTERNAL_ERROR (внутренняя ошибка ПЦ); после получения ответа от ПЦ касса не смогла корректно завершить операцию.

В случае возникновения указанных выше проблем, транзакция должна быть сохранена в специальной очереди на откат. Касса должна периодически проверять данную очередь на предмет наличия в ней транзакций и, при наличии таких транзакций, откатывать их в ПЦ.