Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

·        Данные клиента (clientAttributes)

Anchor
4115
4115

Таблица 4.1.1.6 – Данные  Данные клиента

Поле

Описание

Тип

Cookie

Значение уникального идентификатора пользователя в платежном сервисе внешней системы, который соответствует указанному domainId (см.табл.4.1.1.1)

Строковый (16 символов)

SystemLanguage

Код языка операционной системы покупателя

Строковый (5 символов)

BrowserLanguage

Код языка веб-браузера

Строковый (5 символов)

UserLanguage

Код языка покупателя

Строковый (5 символов)

TimeZone

Смещение времени в часовом поясе покупателя относительно GMT в минутах. Например, для GMT +2 в часах значение в минутах + 120.

Числовой (5)

ConnectionType

Тип соединения по HTTP

Строковый (16 символов)

JsVer

Версия интерпретатора Java script.

Строковый (16 символов)

LocalTime

Местное время клиента

Строковый (128 символов)

ScreenRes

Разрешение экрана у клиента

Строковый (16 символов)

ScreenPixelDepth

Глубина цветов экрана у клиента

Числовой (15)

BrowserName

Название браузера клиента

Строковый (255 символа)

CookiesEnabled

Есть поддержка Cookie и они включены в браузере клиента

Логический (true,false)

JavaEnabled

Есть поддержка Java script и интерпретатор включен.

Логический (true,false)

BrowserStylesheetsEnabled

Поддержка css стилей.

Логический (true,false)

BrowserPlatform

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

Строковый (64 символов)

Processor

Название процессора на клиентской машине.

Строковый (16 символов)

Latitude

Географическая координата широты, определяющая положение плательщика на поверхности Земли. Указывается в градусах. Например, 55.755831

Числовой (3,7)

Longitude

Географическая координата долготы, определяющая положение плательщика на поверхности Земли. Указывается в градусах. Например, 37.617673

Числовой (3,7)

Device

Описание электронного устройства пользователя, через которое он совершает оплату.

Строковый (50)

DeviceUniqueID

Уникальный номер электронного устройства пользователя (UDID, IMEI, MEID, ESN или IMSI).

Строковый (50)

Application

Название приложения, через которое производится оплата

Строковый (50)

ApplicationVersion

Версия приложения, через которое производится оплата

Строковый (25)

MacAddress

Mac адрес сетевого устройства пользователя

Строковый (17)

AndroidID

Идентификатор Android устройства

Строковый (20)

AccountLifetimeDays

Срок существования учетной записи в днях

Числовой (5)

OrdersNumber

Количество заказов с момента регистрации

Числовой (7)

LastBuyDays

Количество дней с момента последней покупки

Числовой (5)

LastChangePwdDate

Дата и время последней смены пароля пользователя

Дата

IsFirstBuy

Признак первой покупки клиента

Логический (true,false)

TotalOrdersAmount

Общая сумма покупок

Числовой (15,2)

CurrentSessionTime

Время сессии клиента. Время, прошедшее с момента логина до момента формирования заказа в минутах.

Числовой (5)

...

Параметр

Описание

Тип

Params

Массив структур данных, каждый элемент которого представляет собой структуру CheckPaymentParams (подробнее см. п.4.1.1.)

Массив структур данных

waitResults

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

Логический (true,false)

...

Выходные параметры

Результатом работы процедуры является ответ в виде массива объектов типа getAFSResult. Ответ содержит данные о проверке платежей (коды RetCode), если задано ожидание проверки всех платежей. Ответ не содержит данные о проверке платежей (коды RetCodeравны нулю), если не задано ожидание проверки всех платежей. Подробнее см.п.4.1.1.

...

Подробности.

Процедура передачи данных по 3DS транзакциям

Наименование процедуры передачи данных по 3DS транзакциям - set3DSecData. Вызов этой процедуры следует осуществлять после вызова процедуры checkPayment для данного платежа.

...

Входные параметры

Все параметры данной процедуры являются обязательными.

Таблица 4.3.1.1 – Входные параметры процедуры set3DSecData

Параметр

Описание

Тип

outPaymentId

Идентификатор платежной операции во внешней системе.

Числовой (15)

outSystemId

Идентификатор внешней системы.

Числовой (15)

authResult

Результат авторизации по 3DSecure (Y - успешно, N - неуспешно, A - Attempt, U –неизвестно). 

Строковый (1 символ)

authRequired

Результат проверки вовлеченности карты (1 – вовлечена, 0 – не вовлечена, -1 – неизвестно, null – все остальное).

Числовой (1)

...

Выходные параметры

Результатом работы процедуры является текущий фрод-статус платежа, который можно использовать для принятия решения о дальнейших действиях над платежом.

Таблица 4.3.2.1 – Выходные параметры процедуры set3DSecData

Параметр

Описание

Тип

FraudStatus

Код фрод-статуса проверяемой операции (см .табл.3.1).

Числовой (15)

ReasonDescription

Описание причины выставления фрод-статуса проверяемой операции (см. табл.3.2)..

Строковый (100 Строковый (100 символов)

ReasonId

Код причины выставления фрод-статуса (см. табл.3 .2).

Числовой (15)

RetCode

Результат выполнения процедуры.

Целочисленный (10)

Description

Произвольный комментарий к результату выполнения процедуры.

Строковый (2000 символов)

Таблица 4.3.2.2 – Коды результатов выполнения процедуры set3DSecData

Код

Описание

0

Операция прошла успешно, ошибок нет.

2

Ошибка авторизации внешней системы.

4

Указан несуществующий идентификатор платежа.

1

Другая ошибка при выполнении операции.

Anchor
44
44

...

Процедура получения фрод-статуса операции

Наименование процедуры получения фрод-статуса платежной операции - getFraudStatus. Вызов этой процедуры следует осуществлять после вызова процедуры checkPayment для данного платежа.

Anchor
4411
4411

...


Входные параметры

Все параметры данной процедуры являются обязательными.

Таблица 4.4.1.1 – Входные  Входные параметры процедуры getFraudStatus

Параметр

Описание

Тип

outPaymentId

Идентификатор платежной операции во внешней системе.

Числовой (15)

outSystemId

Идентификатор внешней системы.

Числовой (15)

...

Выходные параметры

Результатом работы процедуры всегда является ответ в виде объекта типа getAFSResult, содержащий данные о проверке платежа в случае успешного выполнения процедуры (код результата ее работы RetCode равен нулю) или не содержащий данные о проверке платежа в случае неуспешного выполнения процедуры (код результата ее работы RetCodeне равен нулю).

Таблица 4.4.2.1 – Выходные параметры процедуры getFraudStatus

Параметр

Описание

Тип

FraudStatus

Код фрод-статуса проверяемой операции (см .табл.3.1).

Числовой (15)

ReasonDescription

Описание причины выставления фрод-статуса проверяемой операции (см. табл.3.2).

Строковый (100 символов)

ReasonId

Код причины выставления фрод-статуса (см. табл.3.2).

Числовой (15)

RetCode

Результат выполнения процедуры.

Целочисленный (10)

Description

Произвольный комментарий к результату выполнения процедуры.

Строковый (2000 символов)

PaymentParameters

Список возвращаемых параметров платежа

Список из структур:

name — название параметра (строка, регистр не важен);

booleanValue — заполняется, если значение параметра имеет логический тип (true, false);

doubleValue — заполняется, если значение параметра имеет числовой тип;

stringValue — заполняется, если значение параметра имеет строковый тип;

intValue — заполняется, если значение параметра имеет целочисленный тип;

dateValue — заполняется, если значение параметра имеет тип дата.

Таблица 4.4.2.2 – Список возвращаемых параметров платежа PaymentParameters

Параметр

Описание

Тип

date

Дата платежа, если она была передана от внешней системы. Иначе дата получения данных по платежу в СПМ.

Дата

calculateAmount

Пересчитанная сумма платежа в основной валюте СПМ.

Числовой

outAmount

Переданная от внешней системы сумма платежа.

Числовой

outCurrencyCode

Код валюты, в которой была передана сумма платежа.

Строковый

email

Email плательщика.

Строковый

phone

Телефон плательщика.

Строковый

mobilePhone

Телефон плательщика.

Строковый

cardNumberMask

Номер банковской карты плательщика (первые 6 и последние 4 цифры).

Строковый

cardType

Тип банковской карты, определенный в СПМ по номеру карты.

Строковый

cardSubType

Подтип банковской карты, определенный в СПМ по номеру карты.

Строковый

cardholder

Держатель карты.

Строковый

cardBankCountry

Страна банка эмитента, определенная по номеру карты.

Строковый

cardBank

Название банка эмитента, определенное по номеру карты.

Строковый

expiredate

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

Дата

acquirer

Уникальное название эквайера в переделах внешней системы.

Строковый

cookie

Значение уникального идентификатора плательщика, переданное внешней системой.

Строковый

ip

IP-адрес покупателя.

Строковый

ipCountry

Страна, определенная по IP-адресу покупателя.

Строковый

billNumber

Номер счета из внешней системы.

Строковый

orderNumber

Номер заказа из внешней системы.

Строковый

outStatus

Статус операции в соответствии со справочником СПМ (см.табл. 3.1).

Числовой

outStatusName

Название статуса операции.

Строковый

fraudStatus

Код из справочника фрод‑статусов (см.табл.3.2).

Числовой

reasonId

Код из справочника причин выставления фрод‑статусов (см.табл.3.2).

Числовой

testMode

Тестовый режим.

Логический

usedCSC

Использовался ли Card Secure Code.

Логический

3DSecAuthresult

Результат авторизации по 3DSecure (Y - успешно, N - неуспешно, A - Attempt, U – неизвестно).

Строковый

3DSecAuthrequired

Результат проверки вовлеченности карты (1 – вовлечена, 0 – не вовлечена, -1 – неизвестно, null – все остальное).

Числовой

recurringIndicator

Режим рекуррентного платежа.

Логический

billingPostalCode

BillingData. Индекс предприятия связи покупателя.

Строковый

billingAddress

BillingData. Адрес покупателя.

Строковый

billingFirstName

BillingData. Имя покупателя.

Строковый

billingLastName

BillingData. Фамилия покупателя.

Строковый

billingPhoneNumber

BillingData. Телефон покупателя.

Строковый

billingEMailAddress

BillingData. E-mail покупателя.

Строковый

customer

ФИО покупателя.

Строковый

customerCountry

Страна, указанная покупателем.

Строковый

customerRegion

Регион, указанный покупателем.

Строковый

customerCity

Город, указанный покупателем.

Строковый

customerAddress

Адрес, указанный покупателем.

Строковый

clientSystemLanguage

Код языка операционной системы покупателя.

Строковый

clientLocalTime

Местное время клиента.

Строковый

clientUserLanguage

Код языка покупателя.

Строковый

clientBrowserLanguage

Код языка веб-браузера покупателя.

Строковый

clientBrowserPlatform

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

Строковый

clientJsBrowserName

Название браузера покупателя.

Строковый

clientJsVersion

Версия интерпретатора Java script.

Строковый

clientTimeZone

Смещение времени в часовом поясе покупателя относительно GMT в минутах. Например, для GMT +2 в часах значение в минутах + 120.

Строковый

clientCookieEnabled

Есть поддержка Cookie и они включены в браузере покупателя.

Логический

clientJavaEnabled

Есть поддержка Java script и интерпретатор включен.

Логический

clientConnectionType

Тип соединения по HTTP.

Строковый

clientProcessor

Название процессора на компьютере покупателя.

Строковый

clientScreenRes

Разрешение экрана на компьютере покупателя.

Строковый

clientScreenPixelDepth

Глубина цветов экрана на компьютере покупателя.

Числовой

clientStylesheetsEnabled

Поддержка css стилей.

Логический

httpAccept

Заголовок Accept http-запроса.

Строковый

httpAcceptLanguage

Заголовок Accept Language http-запроса.

Строковый

httpReferer

Заголовок Referer http-запроса.

Строковый

httpServerProtocol

Переменная окружения Server_Protocol.

Строковый

httpUserAgent

Заголовок User Agent http-запроса.

Строковый

hostname

Имя хоста покупателя.

Строковый

Таблица 4.4.2.3 – Коды результатов выполнения процедуры getFraudStatus

Код

Описание

0

Операция прошла успешно, ошибок нет.

2

Ошибка авторизации внешней системы.

4

Указан несуществующий идентификатор платежа.

1

Другая ошибка при выполнении операции.

...

Процедура изменения статуса операции

Наименование процедуры изменения статуса платежной операции - setStatus.

...

Входные параметры

Единственным входным параметром, который передается внешней системой в СПМ для изменения статуса платежной операции, является параметр params, который представляет собой структуру данных с именем SetPaymentStatusParams..

Таблица 4.5.1.1 – Поля SetPaymentStatusParams

Поле

Описание

Тип

outPaymentId

Идентификатор платежной операции во внешней системе.

Числовой (15)

outSystemId

Идентификатор внешней системы.

Числовой (15)

outStatus

Статус операции в соответствии со справочником СПМ (см. табл.3.3)СПМ .

Числовой (15)

timeOut

Время ожидания ответа от сервера СПМ в мс. Если не указано, то используется значение по умолчанию (10 с). Если указано значение, меньшее или равное 0, то проверка на предельное время ожидания не используется.

Числовой (15), необязательный параметр

approvalCode

Код выполнения операции в процессинговом центре. Каждый процессинговый центр использует собственные коды.

Строковый (12)

psDate

Дата обработки платежной операции в процессинговом центре. Время передается в UTC (GMT-0) или же с указанием часового пояса.

Дата и время

responseCode

Код результата платежа от процессингового центра.

Строковый (70)

responseComment

Расшифровка кода результата платежа от процессингового центра.

Строковый (128)

externalTransactionID

  • RetrievalReferenceNumber (формируется процессинговым центром по собственному алгоритму) для процессинговых центров, передающих RRN (в настоящий момент это BPC, BPCBel, RAIF, SviazBank, MBank, AmexPOAисемействоMULT)

или

  • другой возможный номер транзакции

Строковый (50)

meanNumber

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

Строковый (70)

meanTypeGroup

Группа по типу платежного средства: 1 – карта (значение по умолчанию), 2 – электронный кошелек.

Целочисленный (1)

meanType

Тип электронного кошелька (обязательный параметр для кошельков), используемые типы электронных кошельков представлены в дополнительной таблице «Типы электронных кошельков» .

Строковый (3 символа)

reasonId

Причина выставления статуса операции.

Целочисленный (15)

reasonComment

Комментарий к причине выставления статуса.

Строковый (400 символов)

...

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

Таблица 4.5.1.2 – Причины выставления статуса операции

Наименование

Код

Расшифровка

Превышение времени ожидания ввода данных

1

Пользователь не закончил ввод персональных данных, выбор платежного средства, ввод данных платежного средства за отведенное на платеж время.

Отказ от оплаты

2

В процессе проведения оплаты плательщик явно нажал на кнопку отмены и отказался продолжать оплату.

Превышены лимиты

3

Один из установленных лимитов мерчанта не позволяет провести этот платеж.

Операция заблокирована черным списком

4

Черный список по IP плательщика или по платежному средству мерчанта не позволяет провести платеж.

Операция заблокирована фильтром.

5

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

Превышение времени ожидания 3DS

6

Плательщик не завершил 3DS авторизацию (на стороне ACS) за отведенное на это время.

3DS результат N

7

Плательщик не прошел 3DS авторизацию.

3DS результат U

8

В ходе проведения 3DS авторизации возникла ошибка.

Ошибка настроек

9

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

Техническая ошибка

10

На стороне внешней системы произошла ошибка (общие, системные и прочие технические ошибки процессе подготовки к проведению оплаты).

...

Выходные параметры

Результатом работы процедуры всегда является ответ, содержащий код результата ее работы и закодированное описание результата в случае успешного выполнения процедуры (код результата RetCode равен нулю) или не содержащий данные о проверке платежа в случае неуспешного выполнения процедуры (код результата ее работы RetCodeне равен нулю).

Таблица 4.5.2.1 – Выходные параметры процедуры setStatus

Параметр

Описание

Тип

RetCode

Результат выполнения процедуры.

Целочисленный (10)

Description

Произвольный комментарий к результату выполнения процедуры.

Строковый (2000 символов)

Таблица 4.5.2.2 – Коды  Коды результатов выполнения процедуры setStatus

Код

Описание

0

Операция прошла успешно, ошибок нет.

2

Ошибка авторизации внешней системы.

4

Указан несуществующий идентификатор платежа.

5

Указан некорректный код статуса операции

8

Превышено выделенное время обработки платежа. При этом обработка статуса платежа в СПМ будет продолжена, но запрос от внешней системы будет прерван и внешней системе будет отослан только данный код ошибки.

1

Другая ошибка при выполнении операции.

...

Процедура передачи данных по мерчанту

Наименование процедуры передачи данных по мерчанту - setMerchantData.

...

Входные параметры

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

Таблица 4.6.1.1 – Входные параметры процедуры setMerchantData

...

Note

Результатом процедуры является обновление всех указанных параметров для мерчанта с данным идентификатором. Если в базе СПМ не найден мерчант с данным идентификатором из внешней системы, то в базе будет создана новая запись.

Таблица 4.6.1.2 – Категории мерчантов

Код

Название

19

Книги, Видео, CD

20

Билеты в театр, кино, на концерты

21

Игорный бизнес

22

Цветы, подарки, парфюмерия

23

Искусство, коллекционные модели, награды

24

Службы знакомств

25

Программное обеспечение

26

Интернет и хостинг решения, кабельное TV

27

Обучение / конференции / форумы

28

Бытовая техника и электроника

29

Информационно - консультационные услуги

30

Компьютеры и комплектующие

31

Продукты питания

32

Средства массовой информации

34

Разное

35

Автозапчасти

36

Бронирование авиа и ж/д билетов, гостиниц, туров, машин

37

Библиотеки

38

Товары для красоты и здоровья

39

Одежда и обувь

40

Товары для дома / Мебель

41

Табачные изделия

43

Переводческие услуги

44

Благотворительность

46

Фото и полиграфия

47

Связь и телефония

48

Охранные системы

49

Он-лайн игры

50

Файлы для скачивания (Музыка, фильмы, передачи, книги)

51

Спорт и туризм

52

Ювелирные изделия, часы

53

Аукционы

54

Коммунальные и прочие платежи

55

Реклама

56

Страхование

57

Авиакомпании

58

Гостиницы

59

Купоны/сертификаты

77

Агрегаторы

78

Товары для детей

97

Онлайн трейдинг

98

Работа/рекрутинг/фриланс

...

Выходные параметры

Результатом работы процедуры всегда является ответ, содержащий код результата ее работы и закодированное описание результата в случае успешного выполнения процедуры (код результата RetCode равен нулю) или не содержащий данные о проверке платежа в случае неуспешного выполнения процедуры (код результата ее работы RetCodeне равен нулю).

Таблица 4.6.2.1 – Выходные параметры процедуры setMerchantData

Параметр

Описание

Тип

RetCode

Результат выполнения процедуры.

Целочисленный (10)

Description

Произвольный комментарий к результату выполнения процедуры.

Строковый (2000 символов)

Таблица 4.6.2.2 – Коды  Коды результатов выполнения процедуры setStatus

...