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

Структура CardInfoItem

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

Атрибут	Обяз.	Тип	Комментарии
name	M	string (an..30)	Имя элемента счета.
value	M	string (an..100)	Значение состояния или изменения элемента счета Реально тип данных этого параметра зависит от имени элемента счета:
type	M	string (a1)	S (state)        - Состояние счета после выполнения операции. Реальное состояние указывается для всех активных элементов счета. C (change) - Изменение счета в результате выполнения операции. Изменения указываются только для тех элементов счета, которые реально изменились в ходе выполнения операции.
relation	M	string (a1)	T - Данные по Участнику коалиции. N - Данные по коалиции.

Допустимые имена элементов счетов:

Тип	Формат значения	Описание
BNS	long (n..18)	Сумма доступных баллов.
CASH	long (n..18)	Сумма покупок.
PREPAY	long (n..18)	Сумма предоплаты (подарочная и предоплаченная карта)
A_DATE	Дата-время в формате YYYYMMDDhhmmss (n14)	Дата активации карты во временной зоне ПЦ.
A_ID	long (n..18)	Участник коалиции (его partnerId), активировавший карту.
E_DATE	Дата-время в формате YYYYMMDDhhmmss (n14)	Срок действия карты во временной зоне ПЦ.
NL	string u..18	Фамилия (name, last). Язык: русский, кодировка: UTF-8.
NF	string u..18	Имя (name, first). Язык: русский, кодировка: UTF-8.
NP	string u..18	Отчество (name, patronymic). Язык: русский, кодировка: UTF-8.
CS	string (a1)	Состояние карты (если она не заблокирована). Допустимые значения: ‘R’ – Ограничена (restricted) ‘A’ – Активна (active)
BNS_DELAY	long (n..18)	Сумма отложенных баллов.
AB	long (n..18)	Сумма, доступная к оплате в валюте (пересчёт доступных баллов в валюту по курсу списания в ПЦ)
EAN13	string (n..13)	Штрих-код карты лояльности
BD	Дата в формате yyyymmdd	Дата рождения (из анкеты)
ID_DATA	string (an..100)	Некоторый идентификатор карты. Значение, передаваемое в поле, согласовывается с клиентом. Присутствует по согласованию с клиентом.

Структура FmtCardInfoItem

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

Атрибут	Обяз.	Тип	Комментарии
name	M	string (u..100)	Форматированное название элемента счета. Язык: русский, кодировка: UTF-8.
value	M	string (u..100)	Форматированное значение состояния или изменения элемента счета. Язык: русский, кодировка: UTF-8.

Структура CardholderInfoItem

Структура предназначена для передачи информации о держателе карты.

Атрибут	Обяз.	Тип	Комментарии
name	M	string (ans..30)	Название элемента. В текущей версии протокола поддерживаются следующие элементы: email - адрес электронной почты; mobile-phone – «номер мобильного телефона»; loyalty-agreement – «флаг» согласия на участие в программе лояльности; может принимать следующие значения: 0 (нет согласия) или 1 (есть согласие). N. B. Значение данного поля является регистро-независимым (ПЦ хранит значение в верхнем регистре).
value	M	string (u..2000)	Значение элемента. Текстовые значения выгружаются в кодировке UTF-8. Значение типа «номер мобильного телефона» выгружается в формате XXXYYYYYYY, где XXX - код оператора, YYYYYYY - номер телефона); Значения типа "флаг" выгружаются в виде 0 (значение не установлено) или 1 (значение установлено).

Структура OperSummaryItem

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

Атрибут	Обяз.	Тип	Комментарии
name	M	string (an..30)	Имя элемента счета. BNS – сумма накопленных бонусов. BNS_DELAY – сумма отложенных баллов. CASH – сумма покупок.
relation	M	string (a1)	T - Данные по Участнику коалиции. N - Данные по коалиции.
before	M	long (n..18)	Сумма на элементе счёта до движения по операции (в минимальных единицах).
amount	M	long (n..18)	Изменение суммы на элементе счёта в ходе операции (в минимальных единицах).
amountInc	M	long (n..18)	Абсолютная величина изменения (увеличение) на элементе счёта в ходе операции (в минимальных единицах).
amountDec	M	long (n..18)	Абсолютная величина изменения (уменьшение) на элементе счёта в ходе операции (в минимальных единицах).
after	M	long (n..18)	Сумма на элементе счёта после движения по операции (в минимальных единицах).

Структура AccStatementItem

Структура предназначена для передачи элемента выписки со счета карты или держателя карты. В выписку попадают только те операции, которые привели к изменению бонусного элемента счёта.

Атрибут	Обяз.	Тип	Комментарии
pcId	M	long (n..18)	Уникальный идентификатор транзакции, присвоенный ПЦ.
operKind	M	string (ans..30)	Тип операции. "payment" - Оплата баллами; "bonus" - Начисление баллов; "refund_payment" - Возврат на оплату; "refund_bonus" - Возврат на начисление; "correction" - Корректировка; "replacement" - Замена.
operDesc	M	string (ans..100)	Описание операции. "Оплата баллами"; "Начисление баллов"; "Возврат на оплату"; "Возврат на начисление"; "Корректировка"; "Замена".
pcDateTime	M	string (n14)	Дата и время ПЦ совершения операции в формате YYYYMMDDhhmmss.
dateTime	M	string (n14)	Локальные  для точки совершения операции дата и время в формате YYYYMMDDhhmmss.
partnerName	M	string (ans..200)	Имя Участника, инициировавшего операцию. Язык: русский, кодировка: UTF-8.
summary	M	массив OperSummaryItem	Информация о движениях средств на счете карты или держателя карты, произошедших в результате операции.

Структура AccStatementParams

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

Атрибут	Обяз.	Тип	Комментарии
countLimit	O	long (n..3)	Целое число от 1 до 200 включительно. Лимит на количество операций в выписке. Переопределяет настройку на ПЦ.

Структура Authentication

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

Атрибут	Обяз.	Тип	Комментарии
purchaseId	M	string (an..50)	Идентификатор заказа / покупки.
token	C	string (an..30)	Наименование токена. Не передаётся при запросе временного пароля.

Структура AuthRequestData

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

Атрибут	Обяз.	Тип	Комментарии
transaction	M	TransactionData	Ключевая информация об операции.
amount	M	long (n..18)	Общая сумма чека (операции) в минимальных единицах валюты (например, копейках).
currency	M	string (n3)	Валюта чека (операции). Числовой код по ISO 4217 (см.: http://www. iso. org/iso/en/prods-services/popstds/currencycodeslist. html)
payment	C	массив PaymentItem	Способы оплаты. Обязателен для метода authPoints. Отсутствует для методов activate, authGift, getAuthToken. Если данный массив присутствует, то сумма по всем PaymentItem. amount должна совпадать с общей суммой по чеку (AuthRequestData. amount).
cheque	С	массив ChequeItem	Состав чека. Опционален для методов authPoints и authGift, отсутствует для методов activate, getAuthToken. Если данный массив присутствует, то сумма по всем ChequeItem. amount должна совпадать с общей суммой по чеку (AuthRequestData. amount).
authentication	С	Authentication	Данные для проверки подлинности авторизации. Обязателен для метода getAuthToken. Обязателен для метода authPoints при реализации сценария оплата баллами с авторизацией по токену