Versions Compared

Key

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

...

При этом необходимо присваивать параметрам outSystemId и outPaymentId в url соответствующие значения идентификаторов (см.табл.4.1.1.1).

Anchor
41
41

...

Процедура проверки платежной операции

Наименование процедуры проверки платежной операции - check.

Anchor
411
411

...

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

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

...

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

Anchor
4111
4111

Таблица 4.1.1.1 – Обязательные поля CheckPaymentParams

Поле

Описание

Тип

outPaymentId

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

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

outSystemId

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

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

outMerchantId

Внешний идентификатор мерчанта

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

domainId

Код приложения/сервиса внешних систем из соответствующего справочника СПМ.

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

paymentTypeId

Тип платежа

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

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

Таблица 4.1.1.2 – Типы  Типы платежей

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

Код

e-commerce

1

MO/TO

2

POS

3

...

Warning

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

Таблица 4.1.1.3 – Необязательные поля CheckPaymentParams

Поле

Описание

Тип

paymentAttributes

Данные по операции (см. табл.4.1.1.5)

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

clientAttributes

Данные браузера клиента, выполняющего платеж

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

httpAttributes

Заголовки http-запроса браузера клиента к внешней системе при проведении операции

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

serverAttributes

Переменные среды окружения

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

timeOut

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

Примечание. Имеется возможность отключить принудительное оповещение внешней системы об установленном фрод-статусе платежа в том случае, если время обработки этого платежа превысило максимально допустимое. Настройка осуществляется с помощью сотрудников службы технической поддержки. По умолчанию оповещение осуществляется.

Целое число

sendNotification

Необходимость принудительного оповещения внешней системы об установленном фрод-статусе данной платежной операции по окончании работы процедуры check. По умолчанию оповещение не отправляется.

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

paymentStatus

Данные по изменению статуса операции (подробнее см.п.4.4.1.1.) 

Структура данных

Таблица 4.1.1.4 – Структуры в описании полей CheckPaymentParams

...

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

·        Данные по операции (paymentAttributes)

Таблица 4.1.1.5 – Данные по операции

Поле

Описание

Тип

Meannumber

Зашифрованный номер платежного средства*, должен передаваться в виде строки:

"IR_TOKEN=<необратимый токен PAN> BIN=<6 первых цифр PAN> POST==<4 последних цифры PAN>".

Альтернативная возможность передавать номер платежного средства в незашифрованном виде в настоящий момент существует, но в будущем будет исключена.

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

meanTypeGroup

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

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

meanType

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

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

OutAmount

Сумма платежа в оригинальной валюте

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

OutCurrencyCode

Буквенный код валюты платежа в соответствии с ISO 42 17

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

BillNumber

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

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

OrderNumber

Номер заказа платежной операции

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

Email

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

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

Firstname

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

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

Middlename

Отчество покупателя

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

Lastname

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

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

Regioncode

Код региона покупателя

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

Regionname

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

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

City

Город

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

Countrycode

Код страны в соответствии с ISO 3166 alpha-2

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

Address

Почтовый адрес

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

Postcode

Почтовый индекс

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

Phone

Номер телефона

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

Workphone

Номер рабочего телефона

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

Mobilephone

Номер мобильного телефона

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

Fax

Номер факса

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

Cardholder

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

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

Bankname

Наименование банка-эмитента

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

Acquirer

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

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

Date

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

Дата

Expiredate

Дата окончания действия банковской карты (месяц, год)

Дата

BillingNumberTag

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

  • YBIL (Yota billing);
  • MTSBelBlN (MTS Belarussia BillNumber);
  • MTSBelPhN (MTS Belarussia PhoneNumber);
  • MTTPhN (MTT Phone Number);
  • MTTTel (MTT Telecommunication);
  • MTTInt (MTT Internet).

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

BillingNumber

Биллинговый номер (Billing number), в пользу которого производится оплата.

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

TwoStepSchema

Двустадийная схема оплаты. Если не указано, то false – одностадийная схема оплаты без подтверждения.

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

Дополнительные поля авторизации для платежей по картам American Express

billingPostalCode

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

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

billingAddress

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

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

billingFirstName

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

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

billingLastName

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

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

billingPhoneNumber

Номер телефона покупателя

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

billingEMailAddress

Адрес E-mail покупателя

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

TestMode

Режим тестирования. Платеж является тестовым.

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

RecurringIndicator

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

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

usedCSC

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

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

3DSecAuthresult

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

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

AirData

XML с описанием дополнительных параметров, определенных для авиаперевозчиков**

Текст

BookingData

XML с описанием дополнительных параметров по бронированию и оплате гостиниц***

Текст

3DSecAuthrequired

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

Числовой (1)

...

Code Block
languagexml
<data>
        <email>...</email>   <!-- varchar 128 (email алрес покупателя)   -->
        <from>
            <date>...</date> <!-- varchar 14, формат YYYYMMdd HH:mm (дата приезда) -->
        </from>
        <to>
            <date>...</date> <!--varchar 14, формат YYYYMMdd HH:mm (дата отъезда) -->
        </to>
        <traveler>   <!--traveler-->
            <orig_numb>...</orig_numb>  <!-- int 4 (количество гостей) -->
            <first_name>...</first_name>  <!-- varchar 32 (имя гостя) -->
            <last_name>...</last_name>  <!-- varchar 32 (фамилия гостя) -->
            <traveler_name>...</traveler_name>  <!-- varchar 64 (полное имя гостя) -->
        </traveler>
        <traveler>...</traveler>   <!—следующий гость-->
        ...
    </data>

·        Данные клиента (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)

Note

Выделенные в таблице жирным шрифтом поля являются желательными для качественной работы методов математического моделирования.

·        HTTP заголовки (httpAttributes)

Таблица 4.1.1.7 – HTTP заголовки

Поле

Описание

Тип

AcceptLanguage

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

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

UserAgent

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

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

Accept

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

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

Referer

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

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

Forwarded

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

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

XForwardedFor

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

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

Via

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

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

·        Переменные окружения сервера (serverAttributes)

Таблица 4.1.1.8 – Переменные окружения сервера

...

Note

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

...

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

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

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

Параметр

Описание

Тип

FraudStatus

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

Числовой (15)

ReasonDescription

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

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

ReasonId

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

Числовой (15)

RetCode

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

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

Description

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

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

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

Код

Описание

0

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

2

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

3

Указан неправильный идентификатор мерчанта.

6

Указан неправильный идентификатор типа платежа.

7

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

8

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

1

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

...

Одновременная проверка нескольких платежных операций

Наименование процедуры одновременной проверки нескольких платежных операций - checkArray.

...

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

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

Параметр

Описание

Тип

Params

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

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

waitResults

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

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

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

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

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

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

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

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

...

Параметр

Описание

Тип

outPaymentId

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

Числовой (15)

outSystemId

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

Числовой (15)

authResult

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

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

authRequired

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

Числовой (1)

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

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

...

Код

Описание

0

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

2

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

4

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

1

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

Anchor
44
44

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

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

Anchor
4411
4411


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

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

...

Параметр

Описание

Тип

outPaymentId

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

Числовой (15)

outSystemId

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

Числовой (15)

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

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

...

Код

Описание

0

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

2

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

4

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

1

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

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

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

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

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

...

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

Код

Расшифровка

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

1

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

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

2

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

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

3

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

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

4

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

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

5

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

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

6

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

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

7

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

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

8

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

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

9

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

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

10

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

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

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

...

Код

Описание

0

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

2

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

4

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

5

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

8

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

1

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

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

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

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

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

...

Код

Название

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

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

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

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

...

Код

Описание

0

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

2

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

1

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

Наверх