Description of request parameters
Parameter
Necessity
Описание параметров запроса
Параметр | Нужность | Описание | ||||
---|---|---|---|---|---|---|
Operation | Yes | Type of transaction. Fixed valueДа | Тип операции. Фиксированное значение: Process3DSAuth | |||
Step | YesДа | Verification stage. Fixed valueЭтап проверки. Фиксированное значение: AREQ | ||||
OrderID | Yes | ID of the order on which the operation is to be performedДа | Идентификатор заказа, по которому необходимо выполнить операцию | |||
Merchant | Yes | Merchant IDДа | Идентификатор интернет-магазина. | |||
AddParams.threeDSCompInd | Yes | A flag indicating the result of a 3DSMethod call. | Признак, указывающий на результат вызова 3DSMethod. Фиксированное значение: U | |||
AddParams.threeDSRequestorAuthenticationInd | Yes | The type of request being made that required Да | Тип выполняемого запроса, для которого возникла необходимость проведения аутентификации 3-D Secure authentication:
Если нет особых условий - желательное значение - 01. | |||
AddParams.transType | Yes | The type of transaction being authenticated. Possible values:
If there are no special conditions, the desired value is Да | Тип аутентифицируемой транзакции. Возможные значения:
Если нет особых условий - желательное значение - 01. | |||
AddParams.messageCategory | Yes | Category of the message. Possible valuesДа | Категория сообщения. Возможные значения:
На данный момент поддерживается значение: 01 - PA (financial transactionфинансовая транзакция); | |||
AddParams.addrMatch | No | Parameter indicating the match / mismatch of the delivery address of the goods with the address of the cardholder. Possible values: Y - the delivery address of the goods matches the address of the cardholder; Нет | Параметр, указывающий на совпадение / несовпадение адреса доставки товара с адресом держателя карты. Возможные значения:
| |||
AddParams.billAddrCity | No | City where the cardholder's address is locatedНет | Город, в котором находится адрес держателя карты | |||
AddParams.billAddrCountry | No | Three-character country code (in Нет | Трехсимвольный код страны (в формате ISO 3166-1 format) in which the cardholder's address is located), в которой находится адрес держателя карты | |||
AddParams.billAddrLine1 | No | First line of the cardholder's addressНет | Первая строка адреса держателя карты | |||
AddParams.billAddrLine2 | No | Second line of the cardholder's addressНет | Вторая строка адреса держателя карты | |||
AddParams.billAddrLine3 | No | Third line of the cardholder's addressНет | Третья строка адреса держателя карты | |||
AddParams.billAddrPostCode | No | Postal code of the cardholder's addressНет | Почтовый индекс адреса держателя карты | |||
AddParams.billAddrState | No | State or province (in Нет | Штат или область (в формате ISO 3166-2 format) where the cardholder's address is located), в которой находится адрес держателя карты | |||
AddParams.shipAddrCity | No | Delivery cityНет | Город доставки товара | |||
AddParams.shipAddrCountry | No | Three-character code for the country of delivery of the goods (in Нет | Трехсимвольный код страны доставки товара (в формате ISO 3166-1 format) | |||
AddParams.shipAddrLine1 | No | The first line of the delivery address of the goodsНет | Первая строка адреса доставки товара | |||
AddParams.shipAddrLine1 | No | The second line of the delivery address of the goodsНет | Вторая строка адреса доставки товара | |||
AddParams.shipAddrLine1 | No | The third line of the delivery address of the goodsНет | Третья строка адреса доставки товара | |||
AddParams.shipAddrPostCode | No | Postal code of delivery of the goodsНет | Почтовый индекс доставки товара | |||
AddParams.shipAddrState | No | State or area of delivery of goods in Нет | Штат или область доставки товара в формате ISO 3166-2 format | |||
AddParams.email | No | Cardholder's email addressНет | Адрес электронной почты держателя карты | |||
AddParams.homePhone | No | The cardholder's home phone number. The parameter value is specified in JSON formatНет | Номер домашнего телефона держателя карты. Значение параметра указывается в формате JSON: {"cc": "7", "subscriber": "9998887766"} where: cc is the telephone code of the country; subscriber - telephone number (i.e. a sequence of digits assigned to a telephone network subscriberгде: сс – телефонный код страны; subscriber – телефонный номер (т.е. последовательность цифр, присвоенная абоненту телефонной сети) | |||
AddParams.workPhone | No | The cardholder's work phone number. The value of the parameter is specified in the same way as the value of the homePhone parameterНет | Номер рабочего телефона держателя карты. Значение параметра указывается аналогично значению параметра homePhone | |||
AddParams.mobilePhone | No | Mobile phone number of the cardholder. The value of the parameter is specified in the same way as the value of the homePhone parameter | Нет | Номер мобильного телефона держателя карты. Значение параметра указывается аналогично значению параметра homePhone | ||
AddParams.threeDSRequestorAuthenticationInfo | No | Information about the authentication of the cardholder in the online store. The parameter value is specified in JSON formatНет | Информация об аутентификации держателя карты в интернетмагазине. Значение параметра указывается в формате JSON. {"threeDSReqAuthMethod": "01", whereгде:
threeDSReqAuthTimestamp - date and time of cardholder authentication. The value format is YYYYMMDDHHMM; threeDSReqAuthData - data about the cardholder authentication procedure
| |||
AddParams.threeDSRequestorChallengeInd | No | Parameter indicating the need for additional user authentication through a request authentication data. Possible values: 01 - no preference; 02 - additional authentication is not required; 03 – additional authentication requested by merchant; Нет | Параметр, указывающий на необходимость проведения дополнительной аутентификации пользователя посредством запроса аутентификационных данных. Возможные значения:
| |||
AddParams.threeDSRequestorPriorAuthenticationInfo | No | Information about the authentication of the cardholder in the online store during the previous transaction. The parameter value is specified in JSON formatНет | Информация об аутентификации держателя карты в интернетмагазине при выполнении предыдущей транзакции. Значение параметра указывается в формате JSON. {"threeDSReqPriorRef": "93f58edb-c916-4b76-ad3a-97b2c0562467",
threeDSReqPriorAuthTimestamp - the date and time of the previous cardholder authentication. The value format is YYYYMMDDHHMM. threeDSReqPriorAuthData - data about the previous authentication procedure
| |||
AddParams.acctType | No | Cardholder account type. Possible valuesНет | Тип счета держателя карты. Возможные значения:
| |||
AddParams.acctID | No | Additional information about the cardholder account in the online storeНет | Дополнительная информация об учетной записи держателя карты в интернет-магазине | |||
AddParams.acctInfo | No | Additional information about the cardholder's account in the online store. The parameter value is specified in JSON formatНет | Дополнительная информация об учетной записи держателя карты в интернет-магазине. Значение параметра указывается в формате JSON. {"chAccAgeInd": "1", "chAccDate": "20170707", "chAccChangeInd": "1", "chAccChange": "20170707",
| AddParams.merchantRiskIndicator | No |
|
AddParams.merchantRiskIndicator | Нет | Оцененный ТСП уровень риска, связанного с конкретной аутентификацией. Значение параметра указывается в формате JSON. {"shipIndicator": "01","deliveryTimeframe": "1","deliveryEmailAddress": "test@testtest@test.ru","reorderItemsInd": "1","preOrderPurchaseInd": "1","preOrderDate": "20170707","giftCardAmount": "123","giftCardCurr": "643","giftCardCount": "02"} Whereгде: | AReqDetails.browserIP | Yes | Browser IP address. Possible value formats:
| |
AddParams.threeDSRequestorNPAInd | No | Type of non-financial transaction. Possible values:
| ||||
AddParams.payTokenInd | No | A flag indicating the use of a token instead of a card number. The only possible value is true | ||||
SessionID | Yes | Order session ID | ||||
PAN | Yes | Card number | ||||
PAN2 | No | The recipient's card number. Mandatory when performing a P2PTransfer operation | ||||
ExpDate | Yes | Card expiration date in YYMM format. | ||||
CVV2 | Yes | CVV2 cards. If CVV2 was not entered, it is necessary to pass the value '-1' (minus one) | ||||
AReqDetails.OrderID | Yes | ID of the order on which the operation is to be performed | ||||
AReqDetails.browserAcceptHeader | Yes | The content of the customer's browser HTTP headers. Maximum value - 2048 characters | ||||
AReqDetails.browserColorDepth | Yes | A value representing the bit depth of the color palette for displaying images, in bits per pixel. The maximum value is 2 characters. Possible values:
| ||||
| ||||||
AddParams.threeDSRequestorNPAInd | Тип нефинансовой транзакции. Возможные значения: 01 – добавление карты в электронный кошелек; 02 – сохранение информации по карте; 03 – проверка держателя карты в рамках идентификации и проверки EMV-токена | |||||
AddParams.payTokenInd | Признак, указывающий на использование токена вместо номера карты. Единственное возможное значение – true | |||||
SessionID | Да | Идентификатор сессии заказа | ||||
PAN | Да | Номер карты | ||||
PAN2 | Нет | Номер карты получателя. Обязателен при выполнении операции P2PTransfer | ||||
ExpDate | Да | Срок действия карты в формате YYMM. | ||||
CVV2 | Да | CVV2 карты. Если CVV2 не вводился, необходимо преедать значение '-1' (минус один) | ||||
AReqDetails.OrderID | Да | Идентификатор заказа, по которому необходимо выполнить операцию | ||||
AReqDetails.browserAcceptHeader | Да | Содержимое HTTP-заголовков браузера покупателя. Максимальное значение – 2048 символов | ||||
AReqDetails.browserColorDepth | Да | Значение, представляющее битовую глубину цветовой палитры для отображения изображений, в битах на пиксель. Максимальное значение – 2 символа. Возможные значения:
| ||||
AReqDetails.browserIP | Да | IP-адрес браузера. Возможные форматы значения:
| ||||
AReqDetails.browserLanguage | Yes | Browser language as specified in Да | Язык браузера, указанный в IETF BCP47. Maximum value - 8 charactersМаксимальное значение – 8 символов | |||
AReqDetails.browserScreenHeight | Yes | The total height (in pixels) of the screen displayed to the cardholder. Maximum value - 6 charactersДа | Общая высота (в пикселях) экрана, отображаемого держателю карты. Максимальное значение – 6 символов | |||
AReqDetails.browserScreenWidth | Yes | The total width (in pixels) of the screen displayed to the cardholder. Maximum value - 6 charactersДа | Общая ширина (в пикселях) экрана, отображаемого держателю карты. Максимальное значение – 6 символов | |||
AReqDetails.browserTZ | Yes | The time difference between UTC and the local time of the user's browser. Maximum value - 5 charactersДа | Разница во времени между временем по UTC и местным временем браузера пользователя. Максимальное значение – 5 символов | |||
AReqDetails.browserUserAgent | Yes | The content of the Да | Содержимое HTTP-заголовка User-Agent HTTP header. Maximum value - 2048 characters. Максимальное значение – 2048 символов | |||
AReqDetails.browserJavaEnabled | Yes | Ability to execute JavaScript in the cardholder's browser. Possible valuesДа | Признак возможности выполнения JavaScript в браузере держателя карты. Возможные значения:
| |||
AReqDetails.threeRIInd | Yes | The type of request that the merchant performs without the participation of the cardholder (recurring payments). Possible valuesДа | Тип запроса, который выполняет ТСП без участия держателя карты (рекуррентные платежи). Возможные значения:
| |||
AReqDetails.notificationUrl | YesДа | The URL of the service provider to which the CRes POST message from ACS is returned after performing cardholder verification on URL-адрес сервис провайдера, на который возвращается POST-сообщение CRes от ACS, после выполнения проверки владельца карты при challenge-flow. | ||||
AReqDetails.deviceChannel | Yes | The type of device from which the transaction was initiated. Possible valuesДа | Тип устройства, с которого инициирована транзакция. Возможные значения:
At the moment, only the value is availableНа данный момент доступно только значение: 02 - the user's browser браузер пользователя(Browser). | |||
CReqDetails.WindowWidth | Yes | Width of the browser window (in pixels) in which pages of the Merchant's website are displayedДа | Ширина окна браузера (в пикселях), в котором отображаются страницы сайта ТСП | |||
CReqDetails.WindowHeight | Yes | Height of the browser window (in pixels) in which pages of the merchant's website are displayed |
XML response for version 2.1 with challenge-flow and the need to redirect the cardholder to the ACS page
Да | Высота окна браузера (в пикселях), в котором отображаются страницы сайта ТСП |
XML-ответ для версии 2.1 при challenge-flow и необходимости перенаправления держателя карты на страницу ACS
XML-ответ Challenge-Flow имеет следующий формат | |||||
---|---|---|---|---|---|
|
Описание параметров XML-ответа для версии 3DS 2.1 Challenge-Flow
versionParameterПараметр | DescriptionОписание | |
---|---|---|
StatusResult of the request | Refinement.RefinementType | Результат выполнения запроса: – успешно – неверный формат сообщения (нет обязательных параметров и т. д.) 54 - invalid operation 72 - system error 96 - system error 97 - system error |
NextStep | Specifies the next validation step. Fixed value: CRES | |
Operation | Type of operation performed | |
Type of data to be passed in the next step: Fixed value– интернет-магазин не имеет доступа к операции создания заказа (или такой интернет-магазин не зарегистрирован) | ||
NextStep | Определяет следующий шаг проверки. Фиксированное значение: CRES | |
Operation | Тип выполненной операции | |
Refinement.RefinementType | Тип данных, которые необходимо передать на следующем этапе: Фиксированное значение: CREQ | |
Refinement.AcsURL | URL-адрес сервера ACS Server URL | |
Refinement.CReq | Сообщение CReq message, in a POST message that needs to be generated in the customer's browser when redirected to the card issuer's ACSв POST-сообщении которое необходимо сформировать в браузере покупателя при перенаправлении на ACS эмитента карты. | |
Refinement.AcsChallengeMandated | Indicates that a Challenge Flow script needs to be run due to local/regional mandate requirements ValuesПризнак необходимости выполнения сценария Challengу Flow по причине локальных/региональных мандатных требований Значения: Y/N | |
ARes | ARes message received from the issuer's ACS in JSON format |
Полученное от ACS эмитента сообщение ARes в формате JSON |
Описание параметров XML-ответа для версии non-3DS
version-
financial transactionфинансовая транзакция
XML response has the following format-ответ имеет следующий формат | |||||
---|---|---|---|---|---|
|
< Field descriptions Описание полей >
Filter by label (Content by label) | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|