OCT транзакции
Общая информация об OCT
OCT (Original Credit Transaction) – особый вид транзакций по зачислению денежных средств получателю в режиме реального времени.
Для всех OCT транзакций действуют правила:
- В запросе регистрации заказа необходимо передать параметр
featuresсо значениемWITHOUT_FROM_CARD. - В запросе оплаты указываются данные карты зачисления, т.е.
toCard.
Сценарий проведения OCT транзакции
- Держатель карты (клиент) взаимодействует с интернет-магазином для создания заказа.
- Система интернет-магазина регистрирует заказ в Платежном шлюзе через registerP2P.do. Используемые параметры регистрации включают сумму перевода, валюту, номер заказа в системе продавца и URL возврата для клиента.
- Платежный шлюз в ответ на запрос регистрации возвращает уникальный идентификатор заказа в платежной системе и URL для перенаправления клиента на форму сбора карточных данных.
- Система интернет-магазина передает URL-адрес перенаправления, полученный на Шаге 3, браузеру клиента.
- Клиент заполняет форму, и данные отправляются на сервер платежного шлюза.
- Платежный шлюз осуществляет перевод средств через performP2P.do.
- Когда деньги переведены, платежный шлюз отправляет обратный URL-адрес в веб-браузер клиента (URL-адрес был указан при регистрации заказа интернет-магазином на Шаге 2).
- Веб-браузер клиента запрашивает результаты перевода денег из интернет-магазина.
- Система интернет-магазина запрашивает информацию о статусе заказа у платежного шлюза – getP2PStatus.do.
- Платежный шлюз возвращает статус заказа.
- Система интернет-магазина показывает клиенту результат оплаты.
API calls
Для OCT интеграций необходимо, чтобы вызовы API были подписаны. Информацию о подписи запросов можно найти в нашем Руководстве по API.
Регистрация заказа P2P
Для оформления заказа на перевод денег с карты на карту используйте запрос https://abby.rbsuat.com/payment/rest/api/p2p/registerP2P.do.
При выполнении запроса необходимо использовать заголовок:
Content-Type: application/json
Параметры запроса
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | username |
String [1..30] | Логин учетной записи API продавца. |
| Обязательно | password |
String [1..30] | Пароль учетной записи API продавца. |
| Обязательно | orderNumber |
String [1..36] | Номер заказа (ID) в системе мерчанта; должен быть уникальным для каждого заказа. |
| Обязательно | amount |
Integer [0..12] | Сумма платежа в минимальных единицах валюты (например, в копейках). |
| Обязательно | currency |
String [3] | Код валюты платежа ISO 4217. Если не указано, то используется значение по умолчанию. Допускаются только цифры. |
| Обязательно | returnUrl |
String [1..512] | Адрес, на который требуется перенаправить пользователя в случае успешной оплаты. Адрес должен быть указан полностью, включая используемый протокол (например, https://mybestmerchantreturnurl.com вместо mybestmerchantreturnurl.com). В противном случае пользователь будет перенаправлен по адресу следующего вида: https://abby.rbsuat.com/payment/<merchant_address>. |
| Необязательно | failUrl |
String [1..512] | Адрес, на который требуется перенаправить пользователя в случае неуспешной оплаты. Адрес должен быть указан полностью, включая используемый протокол (например, https://mybestmerchantreturnurl.com вместо mybestmerchantreturnurl.com). В противном случае пользователь будет перенаправлен по адресу следующего вида: https://abby.rbsuat.com/payment/<merchant_address>. |
| Необязательно | orderDescription |
String [1..600] | Описание заказа передаваемое платежному шлюзу при регистрации. В этом поле недопустимо передавать персональные данные или платежные данные (номера карт т.п.). Данное требование связано с тем, что описание заказа нигде не маскируется. |
| Необязательно | language |
String [2] | Ключ языка по ISO 639-1. Если язык не указан, используется язык по умолчанию, указанный в настройках магазина. Поддерживаемые языки: ru,en,by,pl. |
| Необязательно | clientId |
String [0..255] | Номер клиента (ID) в системе мерчанта — до 255 символов. Используется для реализации функциональности связок. Может возвращаться в ответе, если мерчанту разрешено создавать связки. Указание этого параметра при обработке платежей по связке обязательно. В противном случае платеж будет невозможен. |
| Необязательно | merchantLogin |
String [1..255] | Чтобы зарегистрировать заказ от имени другого мерчанта, укажите его логин (для API-аккаунта) в этом параметре. Можно использовать, только если у вас есть разрешение на просмотр транзакций других продавцов или если указанный продавец является вашим дочерним продавцом. |
| Необязательно | dynamicCallbackUrl |
String [1..512] | Параметр для передачи динамического адреса для получения "платежных" callback-уведомлений по заказу, активированных для мерчанта (успешная авторизация, успешное списание, возврат, отмена, отклонение платежа по таймауту, отклонение card present платежа). "Не платежные" callback-уведомления (включение/выключение связки, создание связки), будут отправляться на статический callback адрес. |
| Необязательно | sessionTimeoutSecs |
Integer [1..9] | Продолжительность жизни заказа в секундах. В случае если параметр не задан, будет использовано значение, указанное в настройках мерчанта, или время по умолчанию (1200 секунд = 20 минут). Если в запросе присутствует параметр expirationDate, то значение параметра sessionTimeoutSecs не учитывается. |
| Необязательно | sessionExpiredDate |
String | Дата и время истечения срока действия заказа. Формат: yyyy-MM-ddTHH:mm:ss.Если этот параметр не передается в запросе, то для определения времени истечения срока действия заказа используется параметр sessionTimeoutSecs. |
| Необязательно | bindingId |
String [1..255] | Идентификатор уже существующей связки (идентификатор карты, токенизированной шлюзом). Его можно использовать, только если у мерчанта есть разрешение на работу со связками. Если этот параметр передается в этом запросе, это означает, что:
|
| Необязательно | creditBindingId |
String [0..255] | Идентификатор связки карты для зачисления. Используется при переводах с карты на карту, когда заранее известна карта получателя. Этот параметр нужно сначала передать в запросе на регистрацию платежа (registerP2P.do - здесь же должен быть передан параметр clientId), затем в запросе на перевод средств по cвязке (performP2PByBinding.do - значение параметра creditBindingId, переданного в registerP2P.do, должно быть передано в параметре bindingId в блоке toCard). |
| Обязательно | transactionTypeIndicator |
String | Используется в однонаправленных типах транзакций. Возможны такие значения:
|
| Обязательно | features |
Object | Контейнер для параметра feature, обязателен для однонаправленных операций.Если выполняется операция OCT (перевод со счета на карту) - в параметре feature должно быть передано WITHOUT_FROM_CARD. Пример: "features" : { "feature" : ["WITHOUT_FROM_CARD"] } |
| Необязательно | params |
Object | Поля дополнительной информации для последующего хранения, передаются в следующем виде: "params": [ {"name": "param1", "value": "value1"}, {"name": "param2", "value": "value2"} ].Данные поля могут быть переданы в процессинг банка для последующего отображения в реестрах банка. |
| Необязательно | shippingPayerData |
Object | Объект, содержащий данные о доставке клиенту. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. См. вложенные параметры. |
| Необязательно | preOrderPayerData |
Object | Объект, содержащий данные предварительного заказа. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. См. вложенные параметры. |
| Необязательно | orderPayerData |
Object | Объект, содержащий данные о плательщике заказа. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. См. вложенные параметры. |
| Необязательно | billingAndShippingAddressMatchIndicator |
String [1] | Индикатор соответствия платежного адреса владельца карты и адреса доставки. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. Возможные значения:
|
| Условие | billingPayerData |
Object | Блок с регистрационными данными клиента (адрес, почтовый индекс), необходимый для прохождения проверки адреса в рамках сервисов AVS/AVV. Обязателен, если функция включена для продавца на стороне Платежного шлюза. Должен был включен либо в запрос registerP2P.do, либо в запрос performP2P.do. См. вложенные параметры. |
| Необязательно | debitMdOrder |
String [1..36] | Уникальный номер заказа, для которого был выполнен перевод AFT в iPay. Этот параметр используется для операций OCT при P2P-переводах (AFT+OCT). |
Описание параметров объекта shippingPayerData:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | shippingCity |
String [1..50] | Город заказчика (из адреса доставки) |
| Необязательно | shippingCountry |
String [1..50] | Страна заказчика |
| Необязательно | shippingAddressLine1 |
String [1..50] | Основной адрес клиента (из адреса доставки) |
| Необязательно | shippingAddressLine2 |
String [1..50] | Основной адрес клиента (из адреса доставки) |
| Необязательно | shippingAddressLine3 |
String [1..50] | Основной адрес клиента (из адреса доставки) |
| Необязательно | shippingPostalCode |
String [1..16] | Почтовый индекс клиента для доставки |
| Необязательно | shippingState |
String [1..50] | Штат/регион покупателя (из адреса доставки) |
| Необязательно | shippingMethodIndicator |
Integer [2] | Индикатор способа доставки. Возможные значения:
|
| Необязательно | deliveryTimeframe |
Integer [2] | Срок поставки товара. Возможные значения:
|
| Необязательно | deliveryEmail |
String [1..254] | Целевой адрес электронной почты для доставки цифрового распространения. Предпочтительно передавать электронную почту в самостоятельном параметре запроса email (но если вы передадите его в этом блоке, к нему применятся те же правила). |
Описание параметров объекта preOrderPayerData:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | preOrderDate |
String [10] | Ожидаемая дата доставки (для предзаказанных покупок) в формате ГГГГММДД. |
| Необязательно | preOrderPurchaseInd |
Integer [2] | Индикатор размещения клиентом заказа на доступную или будущую доставку. Возможные значения:
|
| Необязательно | reorderItemsInd |
Integer [2] | Индикатор того, что клиент перебронирует ранее оплаченную доставку в составе нового заказа. Возможные значения:
|
Описание параметров объекта orderPayerData.
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | homePhone |
String [7..15] | Домашний телефон владельца карты. Необходимо всегда указывать код страны, но знак + или 00 в начале можно указать или опустить. Номер должен иметь длину от 7 до 15 цифр. Таким образом, возможны следующие значения:
|
| Необязательно | workPhone |
String [7..15] | Рабочий телефон владельца карты. Необходимо всегда указывать код страны, но знак + или 00 в начале можно указать или опустить. Номер должен иметь длину от 7 до 15 цифр. Таким образом, возможны следующие значения:
|
| Необязательно | mobilePhone |
String [7..15] | Номер мобильного телефона владельца карты. Необходимо всегда указывать код страны, но знак + или 00 в начале можно указать или опустить. Номер должен иметь длину от 7 до 15 цифр. Таким образом, возможны следующие значения:
Для платежей по VISA с 3DS авторизацией необходимо указать либо электронную почту, либо номер телефона владельца карты. Если у вас настроено отображение номера телефона на платежной странице и вы указали неверный номер телефона, клиент сможет исправить его на платежной странице. |
Ниже приведены параметры блока billingPayerData (данные об адресе регистрации клиента).
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | billingCity |
String [0..50] | Город, зарегистрированный по конкретной карте у Банка Эмитента. |
| Необязательно | billingCountry |
String [0..50] | Страна, зарегистрированная по конкретной карте банка-эмитента. Формат: ISO 3166-1 (Alpha 2 / Alpha 3 / Number-3) или наименование страны. Рекомендуем передавать двух/трехбуквенный ISO код страны. |
| Необязательно | billingAddressLine1 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента (адрес плательщика). Строка 1. Обязательно к передаче для AVS-проверки. |
| Необязательно | billingAddressLine2 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента. Строка 2. |
| Необязательно | billingAddressLine3 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента. Строка 3. |
| Необязательно | billingPostalCode |
String [0..9] | Почтовый индекс, зарегистрированный по конкретной карте у Банка Эмитента. Обязательно к передаче для AVS-проверки. |
| Необязательно | billingState |
String [0..50] | Штат, зарегистрированный по конкретной карте у Банка Эмитента. Формат: полное значение кода ISO 3166-2, его часть или наименование штата/региона. Может содержать буквы только латинского алфавита. Рекомендуем передавать двухбуквенный ISO код штата/региона. |
Параметры ответа
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | errorCode |
String [1..2] | Информационный параметр в случае ошибки, который может иметь разные кодовые значения:
|
| Обязательно | errorMessage |
String [1..512] | Информационный параметр, являющийся описанием ошибки в случае возникновения ошибки. Значение errorMessage может варьироваться, поэтому не следует явным образом ссылаться на его значения в коде. Язык описания задается в параметре language запроса. |
| Необязательно | formUrl |
String [1..512] | URL платежной формы, на которую будет перенаправлен покупатель. URL не возвращается, если регистрация заказа не прошла из-за ошибки, указанной в errorCode. |
| Необязательно | orderId |
String [1..36] | Номер заказа в платежном шлюзе. Уникален в пределах платежного шлюза. |
| Необязательно | orderNumber |
String [1..36] | Номер заказа (ID) в системе мерчанта; должен быть уникальным для каждого заказа. |
Примеры
Пример запроса операции OCT
curl -X POST 'https://abby.rbsuat.com/payment/rest/api/p2p/registerP2P.do'
-H 'Content-Type: application/json'
--data-raw '{
"username":"test_user",
"password":"test_user_password",
"amount" : 50000,
"currency" : "933",
"returnUrl" : "https://mybestmerchantreturnurl.com",
"orderNumber": "12",
"clientId": "122313",
"transactionTypeIndicator": "A",
"features":{
"feature":["WITHOUT_FROM_CARD"]
}
}'Пример ответа
{
"errorCode": 0,
"errorMessage": "Successful",
"orderId": "0a4eaae8-653a-71a9-8259-46fc00a8ea58",
"formUrl": "https://abby.rbsuat.com/payment/merchants/ecom/payment.html?mdOrder=0a4eaae8-653a-71a9-8259-46fc00a8ea58&language=en",
"orderNumber": "2009"
}Сумма комиссии
Для получения суммы комиссии за денежный перевод используйте запрос https://abby.rbsuat.com/payment/rest/api/p2p/verifyP2P.do.
Структура запроса предполагает наличие блока toCard для передачи атрибутов карты для зачисления.
При выполнении запроса необходимо использовать заголовок:
Content-Type: application/json
Параметры запроса
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | username |
String [1..30] | Логин учетной записи API продавца. |
| Обязательно | password |
String [1..30] | Пароль учетной записи API продавца. |
| Обязательно | orderId |
String [1..36] | Номер заказа в платежном шлюзе. Уникален в пределах платежного шлюза. |
| Необязательно | language |
String [2] | Ключ языка по ISO 639-1. Если язык не указан, используется язык по умолчанию, указанный в настройках магазина. Поддерживаемые языки: ru,en,by,pl. |
| Необязательно | amount |
String [0..12] | Сумма перевода в минимальных единицах валюты (например, в копейках). Этот параметр передается, если плательщик решит изменить сумму перевода при осуществлении денежного перевода. |
| Необязательно | billingPayerData |
Object | Блок с регистрационными данными клиента (адрес, почтовый индекс), необходимый для прохождения проверки адреса в рамках сервисов AVS/AVV. Обязателен, если функция включена для продавца на стороне Платежного шлюза. См. вложенные параметры. |
| Обязательно | toCard |
Object | Блок с атриубутами карты начисления. См. вложенные параметры. |
Блок toCard включает в себя следующие параметры:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Условие | pan |
String [1..19] | Номер карты для зачисления денежных средств. |
| Необязательно | expirationYear |
Integer [4] | Год истечения действия карты зачисления. Принимаются значения от 2000 до 2200. |
| Необязательно | expirationMonth |
Integer [2] | Месяц истечения действия карты зачисления. Доступные значения: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12. |
| Необязательно | cardholderName |
String [1..26] | Имя держателя карты зачисления. |
| Условие | seToken |
String | Зашифрованные данные карты. Обязательно, если используется вместо данных карты. Обязательные параметры для строки seToken: timestamp, UUID, PAN, EXPDATE, MDORDER. Подробнее о генерации seToken см. здесь. |
Ниже приведены параметры блока billingPayerData (данные об адресе регистрации клиента).
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | billingCity |
String [0..50] | Город, зарегистрированный по конкретной карте у Банка Эмитента. |
| Необязательно | billingCountry |
String [0..50] | Страна, зарегистрированная по конкретной карте банка-эмитента. Формат: ISO 3166-1 (Alpha 2 / Alpha 3 / Number-3) или наименование страны. Рекомендуем передавать двух/трехбуквенный ISO код страны. |
| Необязательно | billingAddressLine1 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента (адрес плательщика). Строка 1. Обязательно к передаче для AVS-проверки. |
| Необязательно | billingAddressLine2 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента. Строка 2. |
| Необязательно | billingAddressLine3 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента. Строка 3. |
| Необязательно | billingPostalCode |
String [0..9] | Почтовый индекс, зарегистрированный по конкретной карте у Банка Эмитента. Обязательно к передаче для AVS-проверки. |
| Необязательно | billingState |
String [0..50] | Штат, зарегистрированный по конкретной карте у Банка Эмитента. Формат: полное значение кода ISO 3166-2, его часть или наименование штата/региона. Может содержать буквы только латинского алфавита. Рекомендуем передавать двухбуквенный ISO код штата/региона. |
Параметры ответа
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | errorCode |
String [1..2] | Информационный параметр в случае ошибки, который может иметь разные кодовые значения:
|
| Обязательно | errorMessage |
String [1..512] | Информационный параметр, являющийся описанием ошибки в случае возникновения ошибки. Значение errorMessage может варьироваться, поэтому не следует явным образом ссылаться на его значения в коде. Язык описания задается в параметре language запроса. |
Блок feeDescriptionList включает в себя следующие параметры:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | feeAmount |
Integer [1..12] | Сумма комиссии. |
| Необязательно | feeCurrency |
String [3] | Код валюты платежа ISO 4217. |
| Необязательно | feeDescription |
String [1..512] | Описание комиссии. |
Примеры
Пример запроса
curl -X POST 'https://abby.rbsuat.com/payment/rest/api/p2p/verifyP2P.do'
-H 'Content-Type: application/json'
--data-raw '{
"username":"test_user",
"password":"test_user_password",
"orderId": "0a4eaae8-653a-71a9-8259-46fc00a8ea58",
"toCard": {
"pan": "4000001111111118"
},
"amount" : 50000
}'Пример ответа
{
"errorCode": 0,
"errorMessage": "Successful",
"feeDescriptionList: [ {
"feeAmount": 500,
"feeCurrency": "933",
"feeDescription": "Acquirer fee"
} ]
}Комиссия за P2P перевод по связке
Для получения суммы комиссии при переводе средств по связке используйте запрос https://abby.rbsuat.com/payment/rest/api/p2p/verifyP2PByBinding.do.
При выполнении запроса необходимо использовать заголовок:
Content-Type: application/json
Параметры запроса
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | username |
String [1..30] | Логин учетной записи API продавца. |
| Обязательно | password |
String [1..30] | Пароль учетной записи API продавца. |
| Необязательно | language |
String [2] | Ключ языка по ISO 639-1. Если язык не указан, используется язык по умолчанию, указанный в настройках магазина. Поддерживаемые языки: ru,en,by,pl. |
| Обязательно | orderId |
String [1..36] | Номер заказа в платежном шлюзе. Уникален в пределах платежного шлюза. |
| Обязательно | toCard |
Object | Блок с атрибутами карты начисления. См. вложенные параметры. |
Блок toCard включает в себя следующие параметры:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Условие | bindingId |
String [1..255] | Идентификатор связки, созданной при оплате заказа или использованной для оплаты. Доступно, только если продавцу разрешено создавать связки. |
| Условие | pan |
String [1..19] | Номер карты для зачисления денежных средств. |
| Необязательно | expirationYear |
Integer [4] | Год истечения действия карты зачисления. Принимаются значения от 2000 до 2200. |
| Необязательно | expirationMonth |
Integer [2] | Месяц истечения действия карты зачисления. Доступные значения: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12. |
| Необязательно | cardholderName |
String [1..26] | Имя держателя карты зачисления. |
| Условие | seToken |
String | Зашифрованные данные карты. Обязательно, если используется вместо данных карты. Обязательные параметры для строки seToken: timestamp, UUID, PAN, EXPDATE, MDORDER. Подробнее о генерации seToken см. здесь. |
Параметры ответа
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | errorCode |
String [1..2] | Информационный параметр в случае ошибки, который может иметь разные кодовые значения:
|
| Обязательно | errorMessage |
String [1..512] | Информационный параметр, являющийся описанием ошибки в случае возникновения ошибки. Значение errorMessage может варьироваться, поэтому не следует явным образом ссылаться на его значения в коде. Язык описания задается в параметре language запроса. |
| Необязательно | feeAmount |
Integer [1..12] | Сумма комиссии. |
| Необязательно | feeCurrency |
String [3] | Код валюты платежа ISO 4217. |
| Необязательно | feeDescription |
String [1..512] | Описание комиссии. |
Примеры
Пример запроса
curl --location --request POST 'https://abby.rbsuat.com/payment/rest/api/p2p/verifyP2PByBinding.do' \
--header 'Content-Type: application/json' \
--data-raw '{
"username": "test_user",
"password": "test_user_password",
"orderId": "fa71bf70-7c81-484e-a6fc-7db7e4283b2a",
"bindingId": "4d792471-cee0-742c-922d-a265072e6148",
"toCard": {
"cardholderName": "IVAN IVANOV",
"cvc": "123",
"expirationMonth": 12,
"expirationYear": 2024,
"pan": "5555555555555599"
},
"amount": 1000,
"currency": "933",
"clientId": "123"
}
}'Пример ответа
{
"errorCode" : 0,
"errorMessage" : "Successful",
"feeDescriptionList" : [ {
"feeAmount" : 10,
"feeCurrency" : "933",
"feeDescription" : "Acquirer fee"
} ]
}P2P перевод
Для осуществления денежного перевода с карты на карту используйте запрос https://abby.rbsuat.com/payment/rest/api/p2p/performP2P.do.
При выполнении запроса необходимо использовать заголовок:
Content-Type: application/json
Структура запроса performP2P.do предполагает наличие блока toCard для передачи атрибутов карты для зачисления.
Параметры запроса
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | username |
String [1..30] | Логин учетной записи API продавца. |
| Обязательно | password |
String [1..30] | Пароль учетной записи API продавца. |
| Необязательно | language |
String [2] | Ключ языка по ISO 639-1. Если язык не указан, используется язык по умолчанию, указанный в настройках магазина. Поддерживаемые языки: ru,en,by,pl. |
| Обязательно | orderId |
String [1..36] | Номер заказа в платежном шлюзе. Уникален в пределах платежного шлюза. |
| Необязательно | ip |
String [1..39] | IP адрес плательщика. IPv6 поддерживается во всех запросах (до 39 символов). |
| Необязательно | email |
String [1..64] | Электронная почта плательщика. |
| Необязательно | amount |
String [0..12] | Сумма перевода в минимальных единицах валюты (например, в копейках). Этот параметр передается, если плательщик решит изменить сумму перевода при осуществлении денежного перевода. |
| Необязательно | type |
String | В случае денежного перевода с данными только по одной карте необходимо передать в этом параметре соответствующее значение:WITHOUT_FROM_CARD - без указания карты для списания средств. |
| Необязательно | amountInput |
Integer [0..12] | Сумма перевода в минимальных единицах валюты (например, в копейках). Если в этом параметре указана сумма, перевод будет осуществлен на эту сумму (независимо от суммы, переданной в запросе на оформление заказа). |
| Необязательно | captcha |
String | CAPTCHA (текст, предназначенный для того, чтобы отличать человеческий ввод от машинного) |
| Необязательно | threeDSSDK |
Boolean | Возможные значения: true или false Флаг, показывающий, что платеж поступает из 3DS SDK. |
| Необязательно | threeDSSDKEncData |
String | Зашифрованные данные об устройстве. Параметр является обязательным для SDK. |
| Необязательно | threeDSSDKReferenceNumber |
String | Официальный идентификатор 3DS2 SDK |
| Необязательно | threeDSSDKEphemPubKey |
String | Публичная часть эфемерного ключа. Требуется для установки сеанса с ACS. Параметр является обязательным для SDK. |
| Необязательно | threeDSSDKAppId |
String | Уникальный идентификатор SDK. Параметр является обязательным для SDK. |
| Необязательно | threeDSSDKTransId |
String | Уникальный идентификатор транзакции в SDK. Параметр является обязательным для SDK. |
| Необязательно | threeDSMethodNotificationUrl |
String [1..512] | URL-адрес для отправки уведомления о прохождении проверки на ACS. |
| Условие | threeDSServerTransId |
String [1..36] | Идентификатор транзакции, созданный на сервере 3DS. Обязателен для аутентификации 3DS. |
| Необязательно | threeDSVer2FinishUrl |
String [1..512] | URL-адрес, по которому клиент должен быть перенаправлен после аутентификации на сервере ACS. |
| Условие | threeDSVer2MdOrder |
String [1..36] | Номер заказа, который был зарегистрирован в первой части запроса в рамках 3DS2 операции. Обязателен для аутентификации 3DS. Если данный параметр присутствует в запросе, то используется mdOrder, который передается в настоящем параметре. В таком случае регистрация заказа не происходит, а происходит сразу оплата заказа.Этот параметр передается только при использовании методов мгновенной оплаты, т.е., когда заказ регистрируется и оплачивается в рамках одного запроса. |
| Необязательно | bindingNotNeeded |
Boolean | Допустимые значения:
|
| Условие | originalPaymentNetRefNum |
String | Идентификатор оригинальной или предыдущей успешной транзакции в платежной системе по отношению к выполняемой операции по связке - TRN ID. Передается, если значение параметра tii = R,U или F.Обязателен при использовании связок мерчанта в переводах по связке. |
| Необязательно | params |
Object | Поля дополнительной информации для последующего хранения, передаются в следующем виде: "params": [ {"name": "param1", "value": "value1"}, {"name": "param2", "value": "value2"} ].Данные поля могут быть переданы в процессинг банка для последующего отображения в реестрах банка. |
| Необязательно | shippingPayerData |
Object | Объект, содержащий данные о доставке клиенту. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. См. вложенные параметры. |
| Необязательно | preOrderPayerData |
Object | Объект, содержащий данные предварительного заказа. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. См. вложенные параметры. |
| Необязательно | orderPayerData |
Object | Объект, содержащий данные о плательщике заказа. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. См. вложенные параметры. |
| Условие | billingPayerData |
Object | Блок с регистрационными данными клиента (адрес, почтовый индекс), необходимый для прохождения проверки адреса в рамках сервисов AVS/AVV. Обязателен, если функция включена для продавца на стороне Платежного шлюза. Должен был включен либо в запрос registerP2P.do, либо в запрос performP2P.do. См. вложенные параметры. |
| Обязательно | toCard |
Object | Блок с атрибутами карты начисления. См. вложенные параметры. |
Описание параметров объекта shippingPayerData:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | shippingCity |
String [1..50] | Город заказчика (из адреса доставки) |
| Необязательно | shippingCountry |
String [1..50] | Страна заказчика |
| Необязательно | shippingAddressLine1 |
String [1..50] | Основной адрес клиента (из адреса доставки) |
| Необязательно | shippingAddressLine2 |
String [1..50] | Основной адрес клиента (из адреса доставки) |
| Необязательно | shippingAddressLine3 |
String [1..50] | Основной адрес клиента (из адреса доставки) |
| Необязательно | shippingPostalCode |
String [1..16] | Почтовый индекс клиента для доставки |
| Необязательно | shippingState |
String [1..50] | Штат/регион покупателя (из адреса доставки) |
| Необязательно | shippingMethodIndicator |
Integer [2] | Индикатор способа доставки. Возможные значения:
|
| Необязательно | deliveryTimeframe |
Integer [2] | Срок поставки товара. Возможные значения:
|
| Необязательно | deliveryEmail |
String [1..254] | Целевой адрес электронной почты для доставки цифрового распространения. Предпочтительно передавать электронную почту в самостоятельном параметре запроса email (но если вы передадите его в этом блоке, к нему применятся те же правила). |
Описание параметров объекта preOrderPayerData:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | preOrderDate |
String [10] | Ожидаемая дата доставки (для предзаказанных покупок) в формате ГГГГММДД. |
| Необязательно | preOrderPurchaseInd |
Integer [2] | Индикатор размещения клиентом заказа на доступную или будущую доставку. Возможные значения:
|
| Необязательно | reorderItemsInd |
Integer [2] | Индикатор того, что клиент перебронирует ранее оплаченную доставку в составе нового заказа. Возможные значения:
|
Описание параметров объекта orderPayerData.
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | homePhone |
String [7..15] | Домашний телефон владельца карты. Необходимо всегда указывать код страны, но знак + или 00 в начале можно указать или опустить. Номер должен иметь длину от 7 до 15 цифр. Таким образом, возможны следующие значения:
|
| Необязательно | workPhone |
String [7..15] | Рабочий телефон владельца карты. Необходимо всегда указывать код страны, но знак + или 00 в начале можно указать или опустить. Номер должен иметь длину от 7 до 15 цифр. Таким образом, возможны следующие значения:
|
| Необязательно | mobilePhone |
String [7..15] | Номер мобильного телефона владельца карты. Необходимо всегда указывать код страны, но знак + или 00 в начале можно указать или опустить. Номер должен иметь длину от 7 до 15 цифр. Таким образом, возможны следующие значения:
Для платежей по VISA с 3DS авторизацией необходимо указать либо электронную почту, либо номер телефона владельца карты. Если у вас настроено отображение номера телефона на платежной странице и вы указали неверный номер телефона, клиент сможет исправить его на платежной странице. |
Ниже приведены параметры блока billingPayerData (данные об адресе регистрации клиента).
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | billingCity |
String [0..50] | Город, зарегистрированный по конкретной карте у Банка Эмитента. |
| Необязательно | billingCountry |
String [0..50] | Страна, зарегистрированная по конкретной карте банка-эмитента. Формат: ISO 3166-1 (Alpha 2 / Alpha 3 / Number-3) или наименование страны. Рекомендуем передавать двух/трехбуквенный ISO код страны. |
| Необязательно | billingAddressLine1 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента (адрес плательщика). Строка 1. Обязательно к передаче для AVS-проверки. |
| Необязательно | billingAddressLine2 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента. Строка 2. |
| Необязательно | billingAddressLine3 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента. Строка 3. |
| Необязательно | billingPostalCode |
String [0..9] | Почтовый индекс, зарегистрированный по конкретной карте у Банка Эмитента. Обязательно к передаче для AVS-проверки. |
| Необязательно | billingState |
String [0..50] | Штат, зарегистрированный по конкретной карте у Банка Эмитента. Формат: полное значение кода ISO 3166-2, его часть или наименование штата/региона. Может содержать буквы только латинского алфавита. Рекомендуем передавать двухбуквенный ISO код штата/региона. |
Блок toCard включает в себя следующие параметры:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Условие | pan |
String [1..19] | Номер карты для зачисления денежных средств. |
| Необязательно | expirationYear |
Integer [4] | Год истечения действия карты зачисления. Принимаются значения от 2000 до 2200. |
| Необязательно | expirationMonth |
Integer [2] | Месяц истечения действия карты зачисления. Доступные значения: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12. |
| Необязательно | cardholderName |
String [1..26] | Имя держателя карты зачисления. |
| Условие | seToken |
String | Зашифрованные данные карты. Обязательно, если используется вместо данных карты. Обязательные параметры для строки seToken: timestamp, UUID, PAN, EXPDATE, MDORDER. Подробнее о генерации seToken см. здесь. |
При аутентификации по протоколу 3DS2 также передаются следующие параметры:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | threeDSServerTransId |
String [1..36] | Идентификатор транзакции, созданный на сервере 3DS. Обязателен для аутентификации 3DS. |
| Необязательно | threeDSVer2FinishUrl |
String [1..512] | URL-адрес, по которому клиент должен быть перенаправлен после аутентификации на сервере ACS. |
| Необязательно | threeDSMethodNotificationUrl |
String [1..512] | URL-адрес для отправки уведомления о прохождении проверки на ACS. |
Параметры ответа
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | errorCode |
String [1..2] | Информационный параметр в случае ошибки, который может иметь разные кодовые значения:
|
| Необязательно | errorMessage |
String [1..512] | Информационный параметр, являющийся описанием ошибки в случае возникновения ошибки. Значение errorMessage может варьироваться, поэтому не следует явным образом ссылаться на его значения в коде. Язык описания задается в параметре language запроса. |
| Необязательно | info |
String | Результат попытки перевода средств. Значение в случае успешного перевода: "Ваш платеж обработан, происходит переадресация..." Значение в случае ошибки: "Происходит переадресация..." |
| Условие | acsUrl |
String [1..512] | URL-адрес для редиректа на ACS. Возвращается при успешном ответе в случае оплаты 3D-Secure, если требуется редирект на ACS. Подробнее см. Редирект на ACS. |
| Условие | paReq |
String [1..255] | PAReq (Payment Authentication Request) — сообщение, которое необходимо отправить в ACS вместе с редиректом. Возвращается при успешном ответе в случае оплаты 3D-Secure, если необходим редирект на ACS. Это сообщение содержит данные в кодировке Base64, необходимые для аутентификации держателя карты. Подробнее см. Редирект на ACS. |
| Необязательно | termUrl |
String [1..512] | При успешном ответе в случае оплаты 3D-Secure. URL-адрес для перенаправления клиента после взаимодействия с ACS для завершения платежа. |
| Необязательно | originalPaymentNetRefNum |
String | Идентификатор оригинальной или предыдущей успешной транзакции в платежной системе по отношению к выполняемой операции по связке - TRN ID. Передается, если значение параметра tii = R,U или F.Обязателен при использовании связок мерчанта в переводах по связке. |
| Условие | statusResponse |
Object | Параметры статуса ответа. Этот блок возвращается, только если у вас включена соответствующая настройка. Для включения этой функциональности, обратитесь в техническую поддержку. См. вложенные параметры. |
При аутентификации по протоколу 3DS2 в ответ на первый запрос приходят следующие параметры:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | is3DSVer2 |
Boolean | Возможные значения: true или false Флаг, показывающий, что платеж поступает из 3DS2. |
| Обязательно | threeDSServerTransId |
String [1..36] | Идентификатор транзакции, созданный на сервере 3DS. Обязателен для аутентификации 3DS. |
| Необязательно | threeDSMethodUrl |
String [1..512] | URL-адрес сервера ACS для сбора данных браузера. |
| Обязательно | threeDSMethodUrlServer |
String [1..512] | URL-адрес сервера 3DS для сбора данных браузера, которые будут включены в AReq (Authentication Request) с сервера 3DS на сервер ACS. |
| Необязательно | threeDSMethodDataPacked |
String [1..1024] | Данные CReq (Challenge Response) в кодировке Base-64 для отправки на сервер ACS. |
| Необязательно | threeDSMethodURLServerDirect |
String [1..512] | URL-адрес 3dsmethod.do для выполнения метода 3DS на сервере 3DS через платежный шлюз (при наличии соответствующего разрешения на уровне продавца). |
Ниже приведены параметры, которые должны присутствовать в ответе, после повторного запроса платежа и необходимости перенаправления клиента в ACS при аутентификации по протоколу 3DS2:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Условие | acsUrl |
String [1..512] | URL-адрес для редиректа на ACS. Возвращается при успешном ответе в случае оплаты 3D-Secure, если требуется редирект на ACS. Подробнее см. Редирект на ACS. |
| Условие | packedCReq |
String | Запакованные данные challenge request. Возвращается при успешном ответе в случае оплаты 3D-Secure, если требуется редирект на ACS. Это значение следует использовать как значение параметра creq ссылки на ACS (acsUrl), для перенаправления клиента на ACS. Подробнее см. Редирект на ACS. |
Параметры блока statusResponse:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | errorCode |
String [1..2] | Информационный параметр в случае ошибки, который может иметь разные кодовые значения:
|
| Обязательно | errorMessage |
String [1..512] | Информационный параметр, являющийся описанием ошибки в случае возникновения ошибки. Значение errorMessage может варьироваться, поэтому не следует явным образом ссылаться на его значения в коде. Язык описания задается в параметре language запроса. |
| Необязательно | orderStatus |
Integer | Значение этого параметра указывает статус заказа в платежном шлюзе. Отсутствует, если заказ не был найден. Ниже приведен список доступных значений:
|
| Необязательно | orderNumber |
String [1..36] | Номер заказа (ID) в системе мерчанта; должен быть уникальным для каждого заказа. |
| Необязательно | panMaskedFrom |
String [1..19] | Маскированный номер карты для списания средств. |
| Необязательно | panMaskedTo |
String [1..19] | Маскированный номер карты для зачисления средств. |
| Необязательно | amount |
Integer [0..12] | Сумма платежа в минимальных единицах валюты (например, в копейках). |
| Необязательно | currency |
String [3] | Код валюты платежа ISO 4217. Если не указано, то используется значение по умолчанию. Допускаются только цифры. |
| Необязательно | creationDate |
Integer | Дата регистрации заказа. |
| Необязательно | orderDescription |
String [1..600] | Описание заказа передаваемое платежному шлюзу при регистрации. В этом поле недопустимо передавать персональные данные или платежные данные (номера карт т.п.). Данное требование связано с тем, что описание заказа нигде не маскируется. |
| Необязательно | ip |
String [1..39] | IP адрес плательщика. IPv6 поддерживается во всех запросах (до 39 символов). |
| Обязательно | resultCode |
Integer | Код ошибки при выполнении запроса. Возможные значения:
|
| Необязательно | orderParams |
Object | Объект с мерчантскими атрибутами заказа. В ответе может быть представлено более одного блока orderParams.Объект должен передаваться следующим образом: {"param":"value","param2":"value2"}. |
| Необязательно | operationList |
Object | Объект, содержащий информацию о транзакциях, завершенных в заказе. В ответе может присутствовать более одного блока operationList.Параметры, которые можно передать, описаны ниже. |
| Необязательно | binding |
String | Идентификатор связки (если она уже была создана). Этот параметр возвращается, только если версия getP2PStatus равна 3 или выше. |
Для завершения транзакции используйте метод /p2p/finishThreeDsVer2.do.
Примеры
Пример запроса OCT
curl -X POST 'https://abby.rbsuat.com/payment/rest/api/p2p/performP2P.do'
-H 'Content-Type: application/json'
--data-raw '{
"username":"test_user",
"password":"test_user_password",
"orderId": "0a4eaae8-653a-71a9-8259-46fc00a8ea58",
"amount" : "50000",
"toCard" : {
"pan" : "4111111111111111"
}
}'Пример ответа на запрос
{
"errorCode": 0,
"info": "Your order is proceeded, redirecting...",
"acsUrl": "https://example.com/acs2/acs/creq",
"is3DSVer2": true,
"packedCReq": "eyJ0aHJlZURTU2VydmVyVHJhbnNJRCI6IjNhZmMxNjhhLTk0YjQtNGViMy04ZTJlLTgwZjZjMTg2NjY5ZCIsIm1lc3NhZ2VUeXBlIjoiQ1JlcSIsIm1lc3NhZ2VWZXJzaW9uIjoiMi4xLjAiLCJhY3NUcmFuc0lEIjoiOWM3NTkxMmEtZTg0NC00ODgyLWI5YzctYzZmYmMzNjIyNGQ3IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjA1In0"
}P2P перевод по связке
Чтобы выполнить перевод с карты на карту с помощью связки, используйте запрос https://abby.rbsuat.com/payment/rest/api/p2p/performP2PByBinding.do.
При выполнении запроса необходимо использовать заголовок:
Content-Type: application/json
Параметры запроса
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | username |
String [1..30] | Логин учетной записи API продавца. |
| Обязательно | password |
String [1..30] | Пароль учетной записи API продавца. |
| Необязательно | language |
String [2] | Ключ языка по ISO 639-1. Если язык не указан, используется язык по умолчанию, указанный в настройках магазина. Поддерживаемые языки: ru,en,by,pl. |
| Необязательно | ip |
String [1..39] | IP адрес плательщика. IPv6 поддерживается во всех запросах (до 39 символов). |
| Необязательно | email |
String [1..64] | Электронная почта для отображения на платежной странице. Если для продавца настроены уведомления клиента, электронную почту необходимо указать. Пример: client_mail@email.com. Для платежей по VISA с 3DS авторизацией необходимо указать либо электронную почту, либо номер телефона владельца карты. |
| Необязательно | type |
String | В случае денежного перевода с данными только по одной карте необходимо передать в этом параметре соответствующее значение:WITHOUT_FROM_CARD - без указания карты для списания средств. |
| Обязательно | orderId |
String [1..36] | Номер заказа в платежном шлюзе. Уникален в пределах платежного шлюза. |
| Необязательно | amountInput |
Integer [0..12] | Сумма перевода в минимальных единицах валюты (например, в копейках). Если в этом параметре указана сумма, перевод будет осуществлен на эту сумму (независимо от суммы, переданной в запросе на оформление заказа). |
| Необязательно | amountInput |
Integer [0..12] | Сумма перевода в минимальных единицах валюты (например, в копейках). Если в этом параметре указана сумма, перевод будет осуществлен на эту сумму (независимо от суммы, переданной в запросе на оформление заказа). |
| Необязательно | captcha |
String | CAPTCHA (текст, предназначенный для того, чтобы отличать человеческий ввод от машинного) |
| Необязательно | threeDSSDK |
Boolean | Возможные значения: true или false Флаг, показывающий, что платеж поступает из 3DS SDK. |
| Необязательно | threeDSSDKEncData |
String | Зашифрованные данные об устройстве. Параметр является обязательным для SDK. |
| Необязательно | threeDSSDKReferenceNumber |
String | Официальный идентификатор 3DS2 SDK |
| Необязательно | threeDSSDKEphemPubKey |
String | Публичная часть эфемерного ключа. Требуется для установки сеанса с ACS. Параметр является обязательным для SDK. |
| Необязательно | threeDSSDKAppId |
String | Уникальный идентификатор SDK. Параметр является обязательным для SDK. |
| Необязательно | threeDSSDKTransId |
String | Уникальный идентификатор транзакции в SDK. Параметр является обязательным для SDK. |
| Необязательно | threeDSMethodNotificationUrl |
String [1..512] | URL-адрес для отправки уведомления о прохождении проверки на ACS. |
| Условие | threeDSServerTransId |
String [1..36] | Идентификатор транзакции, созданный на сервере 3DS. Обязателен для аутентификации 3DS. |
| Необязательно | threeDSVer2FinishUrl |
String [1..512] | URL-адрес, по которому клиент должен быть перенаправлен после аутентификации на сервере ACS. |
| Условие | threeDSVer2MdOrder |
String [1..36] | Номер заказа, который был зарегистрирован в первой части запроса в рамках 3DS2 операции. Обязателен для аутентификации 3DS. Если данный параметр присутствует в запросе, то используется mdOrder, который передается в настоящем параметре. В таком случае регистрация заказа не происходит, а происходит сразу оплата заказа.Этот параметр передается только при использовании методов мгновенной оплаты, т.е., когда заказ регистрируется и оплачивается в рамках одного запроса. |
| Необязательно | bindingNotNeeded |
Boolean | Допустимые значения:
|
| Условие | originalPaymentNetRefNum |
String | Идентификатор оригинальной или предыдущей успешной транзакции в платежной системе по отношению к выполняемой операции по связке - TRN ID. Передается, если значение параметра tii = R,U или F.Обязателен при использовании связок мерчанта в переводах по связке. |
| Необязательно | params |
Object | Поля дополнительной информации для последующего хранения, передаются в следующем виде: "params": [ {"name": "param1", "value": "value1"}, {"name": "param2", "value": "value2"} ].Данные поля могут быть переданы в процессинг банка для последующего отображения в реестрах банка. |
| Необязательно | shippingPayerData |
Object | Объект, содержащий данные о доставке клиенту. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. См. вложенные параметры. |
| Необязательно | preOrderPayerData |
Object | Объект, содержащий данные предварительного заказа. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. См. вложенные параметры. |
| Необязательно | orderPayerData |
Object | Объект, содержащий данные о плательщике заказа. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. См. вложенные параметры. |
| Необязательно | billingAndShippingAddressMatchIndicator |
String [1] | Индикатор соответствия платежного адреса владельца карты и адреса доставки. Этот параметр используется для дальнейшей 3DS-аутентификации клиента. Возможные значения:
|
| Условие | billingPayerData |
Object | Блок с регистрационными данными клиента (адрес, почтовый индекс), необходимый для прохождения проверки адреса в рамках сервисов AVS/AVV. Обязателен, если функция включена для продавца на стороне Платежного шлюза. См. вложенные параметры. |
| Обязательно | toCard |
Object | Блок с атриубутами карты начисления. См. вложенные параметры. |
Блок toCard включает в себя следующие параметры:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Условие | bindingId |
String [1..255] | Идентификатор связки, созданной при оплате заказа или использованной для оплаты. Доступно, только если продавцу разрешено создавать связки. |
| Условие | pan |
String [1..19] | Номер карты для зачисления денежных средств. |
| Необязательно | expirationYear |
Integer [4] | Год истечения действия карты зачисления. Принимаются значения от 2000 до 2200. |
| Необязательно | expirationMonth |
Integer [2] | Месяц истечения действия карты зачисления. Доступные значения: 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12. |
| Необязательно | cardholderName |
String [1..26] | Имя держателя карты зачисления. |
| Условие | seToken |
String | Зашифрованные данные карты. Обязательно, если используется вместо данных карты. Обязательные параметры для строки seToken: timestamp, UUID, PAN, EXPDATE, MDORDER. Подробнее о генерации seToken см. здесь. |
Описание параметров объекта shippingPayerData:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | shippingCity |
String [1..50] | Город заказчика (из адреса доставки) |
| Необязательно | shippingCountry |
String [1..50] | Страна заказчика |
| Необязательно | shippingAddressLine1 |
String [1..50] | Основной адрес клиента (из адреса доставки) |
| Необязательно | shippingAddressLine2 |
String [1..50] | Основной адрес клиента (из адреса доставки) |
| Необязательно | shippingAddressLine3 |
String [1..50] | Основной адрес клиента (из адреса доставки) |
| Необязательно | shippingPostalCode |
String [1..16] | Почтовый индекс клиента для доставки |
| Необязательно | shippingState |
String [1..50] | Штат/регион покупателя (из адреса доставки) |
| Необязательно | shippingMethodIndicator |
Integer [2] | Индикатор способа доставки. Возможные значения:
|
| Необязательно | deliveryTimeframe |
Integer [2] | Срок поставки товара. Возможные значения:
|
| Необязательно | deliveryEmail |
String [1..254] | Целевой адрес электронной почты для доставки цифрового распространения. Предпочтительно передавать электронную почту в самостоятельном параметре запроса email (но если вы передадите его в этом блоке, к нему применятся те же правила). |
Описание параметров объекта preOrderPayerData:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | preOrderDate |
String [10] | Ожидаемая дата доставки (для предзаказанных покупок) в формате ГГГГММДД. |
| Необязательно | preOrderPurchaseInd |
Integer [2] | Индикатор размещения клиентом заказа на доступную или будущую доставку. Возможные значения:
|
| Необязательно | reorderItemsInd |
Integer [2] | Индикатор того, что клиент перебронирует ранее оплаченную доставку в составе нового заказа. Возможные значения:
|
Описание параметров объекта orderPayerData.
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | homePhone |
String [7..15] | Домашний телефон владельца карты. Необходимо всегда указывать код страны, но знак + или 00 в начале можно указать или опустить. Номер должен иметь длину от 7 до 15 цифр. Таким образом, возможны следующие значения:
|
| Необязательно | workPhone |
String [7..15] | Рабочий телефон владельца карты. Необходимо всегда указывать код страны, но знак + или 00 в начале можно указать или опустить. Номер должен иметь длину от 7 до 15 цифр. Таким образом, возможны следующие значения:
|
| Необязательно | mobilePhone |
String [7..15] | Номер мобильного телефона владельца карты. Необходимо всегда указывать код страны, но знак + или 00 в начале можно указать или опустить. Номер должен иметь длину от 7 до 15 цифр. Таким образом, возможны следующие значения:
Для платежей по VISA с 3DS авторизацией необходимо указать либо электронную почту, либо номер телефона владельца карты. Если у вас настроено отображение номера телефона на платежной странице и вы указали неверный номер телефона, клиент сможет исправить его на платежной странице. |
Ниже приведены параметры блока billingPayerData (данные об адресе регистрации клиента).
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | billingCity |
String [0..50] | Город, зарегистрированный по конкретной карте у Банка Эмитента. |
| Необязательно | billingCountry |
String [0..50] | Страна, зарегистрированная по конкретной карте банка-эмитента. Формат: ISO 3166-1 (Alpha 2 / Alpha 3 / Number-3) или наименование страны. Рекомендуем передавать двух/трехбуквенный ISO код страны. |
| Необязательно | billingAddressLine1 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента (адрес плательщика). Строка 1. Обязательно к передаче для AVS-проверки. |
| Необязательно | billingAddressLine2 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента. Строка 2. |
| Необязательно | billingAddressLine3 |
String [0..50] | Адрес, зарегистрированный по конкретной карте у Банка Эмитента. Строка 3. |
| Необязательно | billingPostalCode |
String [0..9] | Почтовый индекс, зарегистрированный по конкретной карте у Банка Эмитента. Обязательно к передаче для AVS-проверки. |
| Необязательно | billingState |
String [0..50] | Штат, зарегистрированный по конкретной карте у Банка Эмитента. Формат: полное значение кода ISO 3166-2, его часть или наименование штата/региона. Может содержать буквы только латинского алфавита. Рекомендуем передавать двухбуквенный ISO код штата/региона. |
При аутентификации по протоколу 3DS2 также передаются следующие параметры:
| Обязательно | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | threeDSServerTransId |
String [1..36] | Идентификатор транзакции, созданный на сервере 3DS. Обязателен для аутентификации 3DS. |
| Необязательно | threeDSVer2FinishUrl |
String [1..512] | URL-адрес, по которому клиент должен быть перенаправлен после аутентификации на сервере ACS. |
| Необязательно | threeDSMethodNotificationUrl |
String [1..512] | URL-адрес для отправки уведомления о прохождении проверки на ACS. |
Параметры ответа
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | errorCode |
String [1..2] | Информационный параметр в случае ошибки, который может иметь разные кодовые значения:
|
| Обязательно | errorMessage |
String [1..512] | Информационный параметр, являющийся описанием ошибки в случае возникновения ошибки. Значение errorMessage может варьироваться, поэтому не следует явным образом ссылаться на его значения в коде. Язык описания задается в параметре language запроса. |
| Необязательно | info |
String | Результат попытки перевода средств. Значение в случае успешного перевода: "Ваш платеж обработан, происходит переадресация..." Значение в случае ошибки: "Происходит переадресация..." |
| Условие | acsUrl |
String [1..512] | URL-адрес для редиректа на ACS. Возвращается при успешном ответе в случае оплаты 3D-Secure, если требуется редирект на ACS. Подробнее см. Редирект на ACS. |
| Условие | paReq |
String [1..255] | PAReq (Payment Authentication Request) — сообщение, которое необходимо отправить в ACS вместе с редиректом. Возвращается при успешном ответе в случае оплаты 3D-Secure, если необходим редирект на ACS. Это сообщение содержит данные в кодировке Base64, необходимые для аутентификации держателя карты. Подробнее см. Редирект на ACS. |
| Условие | termUrl |
String [1..512] | При успешном ответе в случае оплаты 3D-Secure. Это URL-адрес, на который ACS перенаправляет владельца карты после аутентификации. Подробнее см. Редирект на ACS. |
| Условие | statusResponse |
Object | Параметры статуса ответа. Этот блок возвращается, только если у вас включена соответствующая настройка. Для включения этой функциональности, обратитесь в техническую поддержку. См. вложенные параметры. |
При аутентификации по протоколу 3DS2 в ответ на первый запрос приходят следующие параметры:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | is3DSVer2 |
Boolean | Возможные значения: true или false Флаг, показывающий, что платеж поступает из 3DS2. |
| Обязательно | threeDSServerTransId |
String [1..36] | Идентификатор транзакции, созданный на сервере 3DS. Обязателен для аутентификации 3DS. |
| Необязательно | threeDSMethodUrl |
String [1..512] | URL-адрес сервера ACS для сбора данных браузера. |
| Обязательно | threeDSMethodUrlServer |
String [1..512] | URL-адрес сервера 3DS для сбора данных браузера, которые будут включены в AReq (Authentication Request) с сервера 3DS на сервер ACS. |
| Необязательно | threeDSMethodDataPacked |
String [1..1024] | Данные CReq (Challenge Response) в кодировке Base-64 для отправки на сервер ACS. |
| Необязательно | threeDSMethodURLServerDirect |
String [1..512] | URL-адрес 3dsmethod.do для выполнения метода 3DS на сервере 3DS через платежный шлюз (при наличии соответствующего разрешения на уровне продавца). |
Ниже приведены параметры, которые должны присутствовать в ответе, после повторного запроса платежа и необходимости перенаправления клиента в ACS при аутентификации по протоколу 3DS2:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Условие | acsUrl |
String [1..512] | URL-адрес для редиректа на ACS. Возвращается при успешном ответе в случае оплаты 3D-Secure, если требуется редирект на ACS. Подробнее см. Редирект на ACS. |
| Условие | packedCReq |
String | Запакованные данные challenge request. Возвращается при успешном ответе в случае оплаты 3D-Secure, если требуется редирект на ACS. Это значение следует использовать как значение параметра creq ссылки на ACS (acsUrl), для перенаправления клиента на ACS. Подробнее см. Редирект на ACS. |
Параметры блока statusResponse:
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | errorCode |
String [1..2] | Информационный параметр в случае ошибки, который может иметь разные кодовые значения:
|
| Обязательно | errorMessage |
String [1..512] | Информационный параметр, являющийся описанием ошибки в случае возникновения ошибки. Значение errorMessage может варьироваться, поэтому не следует явным образом ссылаться на его значения в коде. Язык описания задается в параметре language запроса. |
| Необязательно | orderStatus |
Integer | Значение этого параметра указывает статус заказа в платежном шлюзе. Отсутствует, если заказ не был найден. Ниже приведен список доступных значений:
|
| Необязательно | orderNumber |
String [1..36] | Номер заказа (ID) в системе мерчанта; должен быть уникальным для каждого заказа. |
| Необязательно | panMaskedFrom |
String [1..19] | Маскированный номер карты для списания средств. |
| Необязательно | panMaskedTo |
String [1..19] | Маскированный номер карты для зачисления средств. |
| Необязательно | amount |
Integer [0..12] | Сумма платежа в минимальных единицах валюты (например, в копейках). |
| Необязательно | currency |
String [3] | Код валюты платежа ISO 4217. Если не указано, то используется значение по умолчанию. Допускаются только цифры. |
| Необязательно | creationDate |
Integer | Дата регистрации заказа. |
| Необязательно | orderDescription |
String [1..600] | Описание заказа передаваемое платежному шлюзу при регистрации. В этом поле недопустимо передавать персональные данные или платежные данные (номера карт т.п.). Данное требование связано с тем, что описание заказа нигде не маскируется. |
| Необязательно | ip |
String [1..39] | IP адрес плательщика. IPv6 поддерживается во всех запросах (до 39 символов). |
| Обязательно | resultCode |
Integer | Код ошибки при выполнении запроса. Возможные значения:
|
| Необязательно | orderParams |
Object | Объект с мерчантскими атрибутами заказа. В ответе может быть представлено более одного блока orderParams.Объект должен передаваться следующим образом: {"param":"value","param2":"value2"}. |
| Необязательно | operationList |
Object | Объект, содержащий информацию о транзакциях, завершенных в заказе. В ответе может присутствовать более одного блока operationList.Параметры, которые можно передать, описаны ниже. |
| Необязательно | binding |
String | Идентификатор связки (если она уже была создана). Этот параметр возвращается, только если версия getP2PStatus равна 3 или выше. |
Примеры
Пример запроса
curl -X POST 'https://abby.rbsuat.com/payment/rest/api/p2p/performP2PByBinding.do'
-H 'Content-Type: application/json'
--data-raw '{
"amountInput" : 1000,
"toCard": {
"cardholderName": "TEST CARDHOLDER",
"expirationMonth": 12,
"expirationYear": 2029,
"pan": "5555555555555599"
},
"orderId" : "3dbaf8bb-1d68-76b3-b4e6-784700f26b04",
"password" : "test_user_password",
"type" : "WITHOUT_FROM_CARD",
"username" : "test_user"
}'Пример ответа
{
"errorCode" : 0,
"errorMessage" : "Successful",
"info" : "Your order is proceeded, redirecting...",
"redirect" : "https://example.com/?orderId=47743354-be15-7c70-b9ef-4bfc482e68dc&lang=en",
"is3DSVer2" : false
}Статус P2P перевода
Чтобы получить статус зарегистрированного заказа P2P, используйте запрос https://abby.rbsuat.com/payment/rest/api/p2p/getP2PStatus.do.
При выполнении запроса необходимо использовать заголовок:
Content-Type: application/json
Параметры запроса
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | username |
String [1..30] | Логин учетной записи API продавца. |
| Обязательно | password |
String [1..30] | Пароль учетной записи API продавца. |
| Необязательно | language |
String [2] | Ключ языка по ISO 639-1. Если язык не указан, используется язык по умолчанию, указанный в настройках магазина. Поддерживаемые языки: ru,en,by,pl. |
| Условие | orderId |
String [1..36] | Номер заказа в платежном шлюзе. Уникален в пределах платежного шлюза. |
| Условие | orderNumber |
String [1..36] | Номер заказа (ID) в системе мерчанта; должен быть уникальным для каждого заказа. |
Параметры ответа
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | errorCode |
String [1..2] | Информационный параметр в случае ошибки, который может иметь разные кодовые значения:
|
| Обязательно | errorMessage |
String [1..512] | Информационный параметр, являющийся описанием ошибки в случае возникновения ошибки. Значение errorMessage может варьироваться, поэтому не следует явным образом ссылаться на его значения в коде. Язык описания задается в параметре language запроса. |
| Необязательно | orderStatus |
Integer | Значение этого параметра указывает статус заказа в платежном шлюзе. Отсутствует, если заказ не был найден. Ниже приведен список доступных значений:
|
| Необязательно | orderNumber |
String [1..36] | Номер заказа (ID) в системе мерчанта; должен быть уникальным для каждого заказа. |
| Необязательно | panMaskedFrom |
String [1..19] | Маскированный номер карты для списания средств. |
| Необязательно | panMaskedTo |
String [1..19] | Маскированный номер карты для зачисления средств. |
| Необязательно | amount |
Integer [0..12] | Сумма платежа в минимальных единицах валюты (например, в копейках). |
| Необязательно | currency |
String [3] | Код валюты платежа ISO 4217. Если не указано, то используется значение по умолчанию. Допускаются только цифры. |
| Необязательно | creationDate |
Integer | Дата регистрации заказа. |
| Необязательно | orderDescription |
String [1..600] | Описание заказа передаваемое платежному шлюзу при регистрации. В этом поле недопустимо передавать персональные данные или платежные данные (номера карт т.п.). Данное требование связано с тем, что описание заказа нигде не маскируется. |
| Необязательно | ip |
String [1..39] | IP адрес плательщика. IPv6 поддерживается во всех запросах (до 39 символов). |
| Обязательно | resultCode |
Integer | Код ошибки при выполнении запроса. Возможные значения:
|
| Необязательно | orderParams |
Object | Объект с мерчантскими атрибутами заказа. В ответе может быть представлено более одного блока orderParams.Объект должен передаваться следующим образом: {"param":"value","param2":"value2"}. |
| Необязательно | operationList |
Object | Объект, содержащий информацию о транзакциях, завершенных в заказе. В ответе может присутствовать более одного блока operationList.Параметры, которые можно передать, описаны ниже. |
| Необязательно | binding |
String | Идентификатор связки (если она уже была создана). Этот параметр возвращается, только если версия getP2PStatus равна 3 или выше. |
Ниже приведены возможные параметры блока operationList.
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Необязательно | operationType |
String | Тип транзакции. Доступны следующие значения:
|
| Необязательно | amount |
Integer [0..12] | Сумма платежа в минимальных единицах валюты (например, в копейках). |
| Необязательно | currency |
String [3] | Код валюты платежа ISO 4217. Если не указано, то используется значение по умолчанию. Допускаются только цифры. |
| Необязательно | datetime |
String | Дата и время совершения операции. |
| Необязательно | resultCode |
String | Код ответа от процессинга банка. Содержит числовое значение. См. список кодов ответа здесь. |
| Необязательно | resultCodeDescription |
String [1..512] | Описание кода ошибки транзакции. |
| Необязательно | maskedPan |
String [1..19] | Маскированный номер карты или токена, использованного для оплаты. |
| Необязательно | cardholderName |
String [1..26] | Имя держателя карты (при наличии). |
| Необязательно | refNum |
String [12] | Уникальный идентификатор операции, присваиваемый банком-эквайером при проведении платежа по банковской карте. RRN создаётся исключительно банком-эквайером и используется для последующего поиска, проверки и урегулирования операций (включая возвраты, чарджбеки и расследования). |
Примеры
Пример запроса
curl -X POST 'https://abby.rbsuat.com/payment/rest/api/p2p/getP2PStatus.do'
-H 'Content-Type: application/json'
--data-raw '{
"username": "test_user",
"password": "test_user_password",
"orderId" : "0a4eaae8-653a-71a9-8259-46fc00a8ea58"
}'Пример ответа
{
"orderStatus": 0,
"errorCode": 0,
"errorMessage": "Successful",
"orderNumber": "2009",
"amount": 50000,
"currency": "933",
"creationDate": 1674137044330,
"orderParams": [],
"operationList": [],
"resultCode": 0
}Завершение P2P-транзакции 3DS2 через API
Чтобы завершить P2P-транзакцию, продавец отправляет идентификатор транзакции на шлюз, используя метод https://abby.rbsuat.com/payment/rest/api/p2p/finishThreeDsVer2.do.
При выполнении запроса необходимо использовать заголовок:
Content-Type: application/x-www-form-urlencoded
Параметры запроса
| Обязательность | Название | Тип | Описание |
|---|---|---|---|
| Обязательно | username |
String [1..30] | Логин учетной записи API продавца. |
| Обязательно | password |
String [1..30] | Пароль учетной записи API продавца. |
| Обязательно | tDsTransId |
String [1..36] | Уникальный идентификатор транзакции, полученный от сервера 3DS. |
Параметры ответа
Ответ на этот запрос не содержит никаких параметров JSON. Вместо этого он перенаправляет клиента на один из следующих URL-адресов:
- Если обработка запроса прошла успешно, платежный шлюз перенаправляет клиента на URL-адрес, указанный в параметре
returnUrlпри регистрации заказа, с добавленными параметрамиorderIdиlang; - Если обработка запроса прошла неуспешно, платежный шлюз перенаправляет клиента на URL-адрес, указанный в параметре
failUrlпри регистрации заказа, с добавленными параметрамиorderIdиlang.
Примеры
Пример запроса
curl --request POST \
--url https://abby.rbsuat.com/payment/rest/api/p2p/finishThreeDsVer2.do \
--header 'content-type: application/x-www-form-urlencoded' \
--data '{
"username": "test_user",
"password": "test_user_password",
"threeDSServerTransId": "65020d0c-2627-4a45-8eab-b93b58fc52ae"
}'Пример URL редиректа
https://mybestmerchantreturnurl.com/finish.html?orderId=906bf262-bd53-4ac7-983c-07127954681b&lang=en