Sorry, you need to enable JavaScript to visit this website.

You are here

Запросы используемые при двухстадийной оплате

1. Запрос регистрации заказа c предавторизацией

Для запроса регистрации заказа с предавторизацией используется метод registerPreAuth.do (см. раздел "Координаты подключения").

Параметры запроса:

Название

Тип

Обязательно

Описание

userName

AN..30

да

Логин магазина, полученный при подключении

password

AN..30

да

Пароль магазина, полученный при подключении

orderNumber

AN..32

да

Номер (идентификатор) заказа в системе магазина, уникален для каждого магазина в пределах системы

amount

N..20

да

Сумма платежа в копейках (или центах)

currency

N3

нет

Код валюты платежа ISO 4217. Если не указан, считается равным коду валюты по умолчанию.

returnUrl

AN..512

да

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

failUrl

AN..512

нет

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

description

AN..1024

нет

Описание заказа в свободной форме

language

A2

нет

Язык в кодировке ISO 639-1. Если не указан, будет использован язык, указанный в настройках магазина как язык по умолчанию (default language)

pageView

ANS..20

нет

По значению данного параметра определяется, какие страницы платёжного интерфейса должны загружаться для клиента. Возможные значения:

  • DESKTOP – для загрузки страниц, верстка которых предназначена для отображения на экранах ПК (в архиве страниц платёжного интерфейса будет осуществляться поиск страниц с названиями payment_<locale>.html и errors_<locale>.html );
  • MOBILE – для загрузки страниц, верстка которых предназначена для отображения на экранах мобильных устройств (в архиве страниц платёжного интерфейса будет осуществляться поиск страниц с названиями mobile_payment_<locale>.html и mobile_errors_<locale>.html);
  • Если магазин создал страницы платёжного интерфейса, добавив в название файлов страниц произвольные префиксы, передайте значение нужного префикса в параметре pageView для загрузки соответствующей страницы. Например, при передаче значенияiphone в архиве страниц платёжного интерфейса будет осуществляться поиск страниц с названиями iphone_payment_<locale>.html и iphone_error_<locale>.html.

Где:

locale – язык страницы в кодировке ISO 639-1. Например, ru для русского или en для английского.

Если параметр отсутствует, либо не соответствует формату, то по умолчанию считается pageView=DESKTOP.

clientId

AN..255

нет

Номер (идентификатор) клиента в системе магазина. Используется для реализации функционала связок. Может присутствовать, если магазину разрешено создание связок.

merchantLogin

AN..255

нет

Чтобы зарегистрировать заказ от имени дочернего мерчанта, укажите его логин в этом параметре.

jsonParams

AN..1024

нет

Блок для передачи дополнительных параметров мерчанта. Поля дополнительной информации для последующего хранения, передаются в виде:

{"<name1>":"<value1>",...,"<nameN>":"<valueN>"},

Данные поля могут быть переданы в процессинг банка для последующего отображения в реестрах.*

Включение данного функционала возможно по согласованию с банком в период интеграции.

Если для продавца настроена отправка уведомлений покупателю, адрес электронной почты покупателя должен передаваться в этом блоке в параметре с именем email.

sessionTimeoutSecs

N...9

нет

Продолжительность жизни заказа в секундах.

В случае если параметр не задан, будет использовано значение, указанное в настройках мерчанта или время по умолчанию (1200 секунд = 20 минут).

Если в запросе присутствует параметр expirationDate, то значение параметра sessionTimeoutSecs  не учитывается.

expirationDate

ANS

нет

Дата и время окончания жизни заказа. Формат: yyyy-MM-ddTHH:mm:ss.

Если этот параметр не передаётся в запросе, то для определения времени окончания жизни заказа используется sessionTimeoutSecs.

bindingId

AN..255

no

Идентификатор связки, созданной ранее. Может использоваться, только если у магазина есть разрешение на работу со связками. Если этот параметр передаётся в данном запросе, то это означает:
1. Данный заказ может быть оплачен только с помощью связки;
2. Плательщик будет перенаправлен на платёжную страницу, где требуется только ввод CVC.

* По умолчанию в процессинг банка передаются поля:

  • orderNumber – номер заказа в системе магазина;
  • description – описание заказа (не более 99 символов, запрещены к использованию %, +, конец строки \r и перенос строки \n).

Если в заказе передать дополнительный параметр с именем merchantOrderId, то именно его значение будет передано в процессинг в качестве номера заказа (вместо значения поля orderNumber).

Параметры ответа:

Название

Тип

Обязательно

Описание

orderId

ANS36

Нет

Номер заказа в платежной системе. Уникален в пределах системы. Отсутствует если регистрация заказа на удалась по причине ошибки, детализированной в errorCode.

formUrl

AN..512

Нет

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

errorCode

N3

Нет

Код ошибки.

errorMessage

AN..512

нет

Описание ошибки на языке, переданном в параметре language в запросе.

Коды ошибок (поле errorCode):

Классификация ошибок:

Значение

Описание

0

Обработка запроса прошла без системных ошибок

1

Заказ с таким номером уже зарегистрирован в системе

3

Неизвестная (запрещенная) валюта

4

Отсутствует обязательный параметр запроса

5

Ошибка значение параметра запроса

7

Системная ошибка

Расшифровка:

Значение

Описание

0

Обработка запроса прошла без системных ошибок

1

Заказ с таким номером уже обработан

1

Заказ с таким номером был зарегистрирован, но не был оплачен

1

Неверный номер заказа

3

Неизвестная валюта

4

Номер заказа не может быть пуст

4

Имя мерчанта не может быть пустым

4

Отсутствует сумма

4

URL возврата не может быть пуст

4

Пароль не может быть пуст

5

Неверная сумма

5

Неправильный параметр 'Язык'

5

Логин продавца неверен

5

Доступ запрещён

5

Пользователь должен сменить свой пароль

5

Доступ запрещён

5

[jsonParams] неверен

7

Системная ошибка

Пример запроса GET:

https://server/application_context/rest/registerPreAuth.do?amount=100&currency=810&language=ru&orderNumber=87654321&password=password&returnUrl=https://server/applicaton_context/finish.html&userName=userName&pageView=MOBILE&expirationDate=2014-09-08T14:14:14&merchantLogin=merch_child

Пример запроса POST:

amount=100&currency=810&language=ru&orderNumber=87654321&returnUrl=https://server/applicaton_context/finish.html&pageView=MOBILE&expirationDate=2014-09-08T14:14:14&merchantLogin=merch_child

Пример ответа:

{"orderId":"61351fbd-ac25-484f-b930-4d0ce4101ab7","formUrl":"https://server/application_context/mobile_payment_ru.html?mdOrder=61351fbd-ac25-484f-b930-4d0ce4101ab7"}

2. Запрoс завершения oплаты заказа

Для запроса завершения ранее пред авторизованного заказа используется запрос deposit.do.

Данную операцию можно осуществлять, если есть соответствующие права в системе.

Параметры запроса:

Название

Тип

Обязательно

Описание

userName

AN..30

да

Логин магазина, полученный при подключении

password

AN..30

да

Пароль магазина, полученный при подключении

orderId

ANS36

да

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

amount

N..20

да

Сумма платежа в копейках (или центах).

Внимание!!! Если в этом параметре указать ноль, завершение произойдет на всю предавторизованную сумму.

Параметры ответа:

Название

Тип

Обязательно

Описание

errorCode

N3

Нет

Код ошибки.

errorMessage

AN..512

Нет

Описание ошибки на языке.

Коды ошибок (поле ErrorCode):

Классификация:

<Значение

Описание

0

Обработка запроса прошла без системных ошибок

5

Ошибка значение параметра запроса

6

Незарегистрированный OrderId

7

Системная ошибка

Расшифровка:

Значение

Описание<

5

Доступ запрещён

5

Пользователь должен сменить свой пароль

5

Неверная сумма

5

Сумма депозита должна быть равной нулю или не менее одного рубля

6

Неверный номер заказа

7

Платёж должен быть в корректном состоянии

7

Ошибка системы

Пример запроса GET:

https://server/application_context/rest/deposit.do?amount=100&currency=810&language=ru&orderId=e5b59d3d-746b-4828-9da4-06f126e01b68&password=password&userName=userName

Пример запроса POST:

Пример ответа:

{"errorCode":0}

3. Запрос отмены оплаты заказа

Для запроса отмены оплаты заказа используется запрос reverse.do. Функция отмены доступна в течение ограниченного времени после оплаты, точные сроки необходимо уточнять в Банке.

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

Данная функция доступна магазинам по согласованию с Банком. Для выполнения операции отмены пользователь должен обладать соответствующими правами.

Параметры запроса:

Название

Тип

Обязательность

Описание

userName

AN..30

да

Логин магазина, полученный при подключении

password

AN..30

да

Пароль магазина, полученный при подключении

orderId

ANS36

да

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

language

A2

нет

Язык в кодировке ISO 639-1. Описание ошибки возвращается на этом языке. Если параметр отсутствует, используется язык по умолчанию, указанный в настройках мерчанта.

Параметры ответа:

Название

Тип

Обязательность

Описание

errorCode

N3

Нет

Код ошибки.

errorMessage

AN..512

Нет

Описание ошибки на языке.

Коды ошибок (поле ErrorCode):

Классификация:

Значение

Описание

0

Обработка запроса прошла без системных ошибок

5

Ошибка значение параметра запроса

6

Незарегистрированный OrderId

7

Системная ошибка

Расшифровка:

Значение

Описание

0

Обработка запроса прошла без системных ошибок

5

Доступ запрещён

5

Пользователь должен сменить свой пароль

5

[orderId] не задан

6

Неверный номер заказа

7

Операция невозможна для текущего состояния платежа

7

Реверсал невозможен. Причина: неверные внутренние значения, проверьте суммы холда, депозита

7

Ошибка системы

Пример запроса GET:

https://server/application_context/rest/reverse.do?language=ru&orderId=9231a838-ac68-4a3e-bddb-d9781433d852&password=password&userName=userName

Пример запроса POST:

language=ru&orderId=9231a838-ac68-4a3e-bddb-d9781433d852

Пример ответа:

{"errorCode":"0","errorMessage":"Успешно"}

4. Запрос возврата средств оплаты заказа

Для возврата средств используется запрос refund.do.

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

Для выполнения операции возврата необходимо наличие соответствующих права в системе.

Параметры запроса:

Название

Тип

Обязательно

Описание

userName

AN..30

да

Логин магазина, полученный при подключении

password

AN..30

да

Пароль магазина, полученный при подключении

orderId

ANS36

да

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

amount

N..20

да

Сумма платежа в копейках (или центах)

Параметры ответа:

Название

Тип

Обязательно

Описание

errorCode

N3

Нет

Код ошибки.

errorMessage

AN..512

Нет

Описание ошибки на языке.


Коды ошибок (поле ErrorCode):

Классификация:

Значение

Описание

0

Обработка запроса прошла без системных ошибок

5

Ошибка значение параметра запроса

6

Незарегистрированный OrderId

7

Системная ошибка

Расшифровка:

Значение

Описание

0

Обработка запроса прошла без системных ошибок

5

Доступ запрещён

5

Пользователь должен сменить свой пароль

5

[orderId] не задан

6

Неверный номер заказа

7

Платёж должен быть в корректном состоянии

7

Неверная сумма депозита (менее одного рубля)

7

Ошибка системы

Пример запроса GET:

https://server/application_context/rest/refund.do?amount=500&currency=810&language=ru&orderId=5e97e3fd-1d20-4b4b-a542-f5995f5e8208&password=password&userName=userName

Пример запроса POST:

amount=500&currency=810&language=ru&orderId=5e97e3fd-1d20-4b4b-a542-f5995f5e8208

Пример ответа:

{"errorCode":0}

5. Запрос состояния заказа

Запрос getOrderStatus.do используется чтобы получить текущее состояние заказа.

Cтатус заказа необходимо определять по значению параметра OrderStatus.
Поле authCode является устаревшим.

Параметры запроса:

Название

Тип

Обязательность

Описание

userName

AN..30

да

Логин магазина, полученный при подключении

password

AN..30

да

Пароль магазина, полученный при подключении

orderId

ANS36

да

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

language

A2

нет

Язык в кодировке ISO 639-1. Если не указан, считается, что язык – русский. Сообщение ошибке будет возвращено именно на этом языке.


Параметры ответа:

Название

Тип

Обязательность

Описание

OrderStatus

N2

Нет

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

ErrorCode

N3

Нет

Код ошибки.

ErrorMessage

AN..512

Нет

Описание ошибки на языке, переданном в параметре Language в запросе.

OrderNumber

AN..32

Да

Номер (идентификатор) заказа в системе магазина

Pan

N..19

нет

Маскированный номер карты, которая использовалась для оплаты. Указан только после оплаты заказа.

expiration

N6

нет

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

cardholderName

A..64

нет

Имя держателя карты. Указан только после оплаты заказа.

Amount

N..20

да

Сумма платежа в копейках (или центах)

currency

N3

нет

Код валюты платежа ISO 4217. Если не указан, считается равным коду валюты по умолчанию.

approvalCode

AN6

нет

Код авторизации МПС. Поле фиксированной длины (6 символов), может содержать цифры и латинские буквы.

authCode

N3

нет

Это поле является устаревшим. Его значение всегда равно "2", независимо от состояния заказа и кода авторизации процессинговой системы.

Ip

AN..20

нет

IP адрес пользователя, который оплачивал заказ

Элемент BindingInfo:

 

 

 

clientId

AN..255

нет

Номер (идентификатор) клиента в системе магазина, переданный при регистрации заказа. Присутствует только если магазину разрешено создание связок.

bindingId

AN..255

нет

Идентификатор связки созданной при оплате заказа или использованной для оплаты. Присутствует только если магазину разрешено создание связок.


Поле OrderStatus может принимать следующие значения:

Номер состояния

Описание

0

Заказ зарегистрирован, но не оплачен

1

Предавторизованная сумма захолдирована (для двухстадийных платежей)

2

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

3

Авторизация отменена

4

По транзакции была проведена операция возврата

5

Инициирована авторизация через ACS банка-эмитента

6

Авторизация отклонена


Коды ошибок (поле ErrorCode):

Значение

Описание

0

Обработка запроса прошла без системных ошибок

2

Заказ отклонен по причине ошибки в реквизитах платежа

5

Доступ запрещён

5

Пользователь должен сменить свой пароль

5

[orderId] не указан

6

Незарегистрированный OrderId

7

Системная ошибка

Пример запроса GET:

https:/server/application_context/rest/getOrderStatus.do?
orderId=b8d70aa7-bfb3-4f94-b7bb-aec7273e1fce&language=ru&password=password&userName=userName

Пример запроса POST:

orderId=b8d70aa7-bfb3-4f94-b7bb-aec7273e1fce&language=ru

Пример ответа:

{"expiration":"201512","cardholderName":"tr tr","depositAmount":789789,"currency":"810","approvalCode":"123456","authCode":2,"clientId":"666","bindingId":"07a90a5d-cc60-4d1b-a9e6-ffd15974a74f","ErrorCode":"0","ErrorMessage":"Успешно","OrderStatus":2,"OrderNumber":"23asdafaf","Pan":"411111**1111","Amount":789789}

6. Расширенный запрос состояния заказа

Для запроса состояния зарегистрированного заказа используется запрос getOrderStatusExtended.do.

Параметры запроса:

Название

Тип

Обязательность

Описание

userName

AN..30

да

Логин магазина, полученный при подключении

password

AN..30

да

Пароль магазина, полученный при подключении

orderId

ANS36

да*

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

orderNumber

AN..32

да*

Номер (идентификатор) заказа в системе магазина.

language

A2

нет

Язык в кодировке ISO 639-1. Если не указан, считается, что язык – русский. Сообщение ошибке будет возвращено именно на этом языке.

* В запросе должен присутствовать либо orderId, либо orderNumber. Если в запросе присутствуют оба параметра, то приоритетным считается orderId.

Существует 3 набора параметров ответа. Какие именно наборы параметров будут возвращены, завит от версии getOrderStatusExtended, указанной в настройках мерчанта.

Параметры ответа для версий 01, 02, 03:
Эти параметры будут возвращены в ответе независимо от версии getOrderStatusExtended.

Название

Тип

Обязательность

Описание

orderNumber

AN..32

да

Номер (идентификатор) заказа в системе магазина

orderStatus

N2

нет

Состояние заказа в платежной системе. Значение выбирается из списка, приведенного ниже. Отсутствует, если заказ не был найден

actionCode

N3

да

Код ответа

actionCodeDescription

AN..512

да

Расшифровка кода ответа на языке, переданном в параметре Language в запросе

errorCode

N3

нет

Код ошибки.

errorMessage

AN..512

нет

Описание ошибки на языке, переданном в параметре Language в запросе

amount

N..20

да

Сумма платежа в копейках (или центах)

currency

N3

нет

Код валюты платежа ISO 4217. Если не указан, считается равным 810 (российские рубли)

date

ANS

да

Дата регистрации заказа

orderDescription

AN..512

нет

Описание заказа, переданное при его регистрации

ip

N..

да

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

 Элемент merchantOrderParams – присутствует в ответе, если в заказе содержатся дополнительные параметры продавца. Каждый дополнительный параметр заказа представлен в отдельном блоке. Блоки элемента merchantOrderParams состоят из полей name и value:

name

AN..20

нет

Название дополнительного параметра

value

AN..1024

нет

Значение дополнительного параметра

Элемент cardAuthInfo (в элементе лежит структура, состоящая из элемента secureAuthInfo и следующих атрибутов: 

pan

N..19

нет

Маскированный номер карты, которая использовалась для оплаты. Указан только после оплаты заказа

expiration

N6

нет

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

cardholderName

A..64

нет

Имя держателя карты. Указан только после оплаты заказа

approvalCode

AN6

нет

Код авторизации платежа. Поле фиксированной длины (6 символов), может содержать цифры и латинские буквы. Указан только после оплаты заказа.



Элемент secureAuthInfo (содержит параметр eci и элемента threeDSInfo, являющимся списком из cavv и xid ):

eci

N..4

нет

Электронный коммерческий индикатор. Указан только после оплаты заказа и в случае соответствующего разрешения

cavv

ANS..200

нет

Значение проверки аутенфикации владельца карты. Указан только после оплаты заказа и в случае соответствующего разрешения

xid

ANS..80

нет

Электронный коммерческий идентификатор транзакции. Указан только после оплаты заказа и в случае соответствующего разрешения

Элемент bindingInfo состоит из параметров:

clientId

AN..255

нет

Номер (идентификатор) клиента в системе магазина, переданный при регистрации заказа. Присутствует только если магазину разрешено создание связок

bindingId

AN..255

нет

Идентификатор связки созданной при оплате заказа или использованной для оплаты. Присутствует только если магазину разрешено создание связок

Параметры ответа для версий 02, 03:
Если для мерчанта указана версия getOrderStatusExtended 02 и выше, то в ответе, кроме описанных выше параметров, будут также возвращены следующие параметры.

Название

Тип

Обязательность

Описание

authDateTime

ANS

нет

Дата/время авторизации

authRefNum

AN..24

нет

Reference number

terminalId

AN..10

нет

Id терминала

Параметры ответа для версии 03:
Если для мерчанта указана версия getOrderStatusExtended 03, то в ответе, кроме описанных выше параметров, будут также возвращены следующие параметры.

Название

Тип

Обязательность

Описание

Элемент paymentAmountInfo состоит из полей:

approvedAmount

N..20

нет

Сумма, захолдированная на карте (используется только при двухстадийных платежах)

depositedAmount

N..20

нет

Сумма, подтвержденная для списания с карты

refundedAmount

N..20

нет

Сумма возврата

paymentState

N2

нет

Состояние заказа

Элемент bankInfo состоит из параметров: 

bankName

AN..200

нет

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

bankCountryCode

AN..4

нет

Код страны банка-эмитента

bankCountryName

AN..160

нет

Наименование страны банка-эмитента на языке, переданном в параметре language в запросе, или на языке пользователя, вызвавшего метод, если язык в запросе не указан

Поле orderStatus может принимать следующие значения:

Номер состояния

Описание

0

Заказ зарегистрирован, но не оплачен

1

Предавторизованная сумма захолдирована (для двухстадийных платежей)

2

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

3

Авторизация отменена

4

По транзакции была проведена операция возврата

5

Инициирована авторизация через ACS банка-эмитента

6

Авторизация отклонена

Коды ошибок (поле errorCode):

Значение

Описание

0

Обработка запроса прошла без системных ошибок

1

Ожидается [orderId] или [orderNumber]

2

Заказ отклонен по причине ошибки в реквизитах платежа

5

Доступ запрещён

5

Пользователь должен сменить свой пароль

6

Заказ не найден

7

Системная ошибка

Пример запроса GET:

https://server/application_context/rest/getOrderStatusExtended.do?userName=userName&password=password&orderId=b9054496-c65a-4975-9418-1051d101f1b9&language=ru&merchantOrderNumber=0784sse49d0s134567890

Пример запроса POST:

orderId=b9054496-c65a-4975-9418-1051d101f1b9&language=ru&merchantOrderNumber=0784sse49d0s134567890

Пример ответа:

{"expiration":"201512","cardholderName":"tr tr","depositAmount":789789,"currency":"810","approvalCode":"123456","authCode":2,"clientId":"666","bindingId":"07a90a5d-cc60-4d1b-a9e6-ffd15974a74f","ErrorCode":"0","ErrorMessage":"Успешно","OrderStatus":2,"OrderNumber":"23asdafaf","Pan":"411111**1111","Amount":789789}

7. Запрос проверки вовлечённости карты в 3DS

Для проверки вовлечённости карты в 3DS используется запрос verifyEnrollment.

Параметры запроса:

Название

Тип

Обязательно

Описание

userName

AN..30

да

Логин пользователя (API)

password

AN..30

да

Пароль пользователя (API)

pan

N12...19

да

Номер карты

Параметры ответа:

Название

Тип

Обязательно

Описание

errorCode

N3

нет

Код ошибки.

errorMessage

AN..512

нет

Описание ошибки.

enrolled

A1

нет

Признак вовлечённости карты в 3DS. Возможные значения: Y, N, U.

emitterName

AN..160

нет

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

emitterCountryCode

AN..4

нет

Код страны банка-эмитента.

Коды ошибок (поле errorCode):

Значение

Описание

0

Обработка запроса прошла без системных ошибок

1

Не указан номер карты

1

Номер карты должен быть числом, содержащим от 13 до 19 цифр

5

Пользователь должен изменить свой пароль.

5

Доступ запрещён

6

По заданному номеру карты информация не найдена.

7

Произошла системная ошибка.

Пример запроса GET:

https://server/application_context/rest/verifyEnrollment.do?userName=userName&password=password&pan=4111111111111111

Пример запроса POST:

pan=4111111111111111

Пример ответа:

{"errorCode":"0","errorMessage":"Успешно","emitterName":"TEST CARD", 
 "emitterCountryCode":"RU","enrolled":"Y"}

8. Запрос статистики по платежам за период

Метод getLastOrdersForMerchants.do позволяет получать статистику по платежам за определенный период.

Параметры запроса:

Название

Тип

Обязательно

Описание

userName

AN..30

да

Логин магазина, полученный при подключении.

password

AN..30

да

Пароль магазина, полученный при подключении.

language

A2

нет

Язык в кодировке ISO 639-1. Если не указан, считается, что язык – русский. Сообщение ошибке будет возвращено именно на этом языке.

page

N

нет

При обработке запроса будет сформирован список, разбитый на страницы (с количеством записей size на одной странице). В ответе возвращается страница под номером, указанным в параметре page. Нумерация страниц начинается с 0.
Если параметр не указан, будет возвращена страница под номером 0.

size

N..3

да

Количество элементов на странице (максимальное значение = 200).

from

ANS

да

Дата и время начала периода для выборки заказов в формате YYYYMMDDHHmmss.

to

ANS

да

Дата и время окончания периода для выборки заказов в формате YYYYMMDDHHmmss.

transactionStates

A..9

да

В этом блоке необходимо перечислить требуемые состояния заказов. Только заказы, находящиеся в одном из указанных состояний, попадут в отчёт.
Несколько значений указываются через запятую. Возможные значения: CREATED, APPROVED, DEPOSITED, DECLINED, REVERSED, REFUNDED.

merchants

ANS

да

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

Оставьте это поле пустым, чтобы получить список отчётов по всем доступным мерчантам (дочерним мерчантам и мерчантам, указанным в настройках пользователя).

searchByCreatedDate

boolean

нет

Возможные значения:

  • true – поиск заказов, дата создания которых попадает в заданный период.
  • false – поиск заказов, дата оплаты которых попадает в заданный период (таким образом, в отчёте не могут присутствовать заказы в статусе CREATED и DECLINED).

Значение по умолчанию – false .

 Параметры ответа:

Название

Тип

Обязательно

Описание

errorCode

N..2

да

Код ошибки. Описание возможных кодов представлено ниже в таблице "Коды ошибок (поле errorCode)"

errorMessage

AN..512

нет

Описание ошибки. Присутствует только при наличии ошибки (errorCode не равно 0).

orderStatuses

 

 

Блок, содержащий информацию о заказах, попавших в отчёт. См. ниже таблицу "Параметры блока orderStatuses".

totalCount

N

да

Общее количество элементов во отчёте (на всех страницах).

page

N

да

Номер текущей страницы (равный номеру страницы, переданному в запросе).

pageSize

N..3

да

Максимальное количество записей на странице (равно размеру страницы, переданному в запросе).

 Параметры блока orderStatuses:

Название

Тип

Обязательно

Описание

orderNumber

AN..32

да

Номер (идентификатор) заказа в системе магазина.

orderStatus

N..2

да

Состояние заказа в платежной системе. Возможные значения представлены ниже в таблице "Поле orderStatus:".

actionCode

N..3

да

Код ответа.

actionCodeDescription

AN..512

да

Расшифровка кода ответа.

amount

N..20

да

Сумма платежа в минимальных единицах валюты.

currency

N3

да

Код валюты платежа ISO 4217. Если не указан, считается равным валюте по умолчанию.

date

ANS

да

Дата регистрации заказа.

orderDescription

AN..512

нет

Описание заказа, переданное при его регистрации

ip

AN..20

нет

IP адрес покупателя. Указан только после оплаты.

errorCode

N..2

да

Код ошибки.

merchantOrderParams

 

нет

Тэг с атрибутами, в которых передаются дополнительные параметры мерчанта. См. ниже таблицу "Параметры блока merchantOrderParams".

attributes

 

да

Атрибуты заказа в платёжной системе (номер заказа).  См. ниже таблицу "Параметры блока attributes".

cardAuthInfo

 

нет

Тэг с атрибутами платежа. См. ниже таблицу "Параметры блока cardAuthInfo".

bindingInfo

 

нет

Тэг с информацией о связке, с помощью которой осуществлена оплата. См. ниже таблицу "Параметры блока bindingInfo".

authDateTime

ANS

нет

Дата/время авторизации

terminalId

AN..10

нет

Id терминала

authRefNum

AN..24

нет

Reference number

paymentAmountInfo

 

нет

Тэг с информацией о суммах подтверждения, списания, возврата. См. ниже таблицу "Параметры блока paymentAmountInfo".

bankInfo

 

нет

Тэг с информацией о Банке-эмитенте. См. ниже таблицу "Параметры блока bankInfo".

 Параметры блока merchantOrderParams:

Название

Тип

Обязательно

Описание

name

AN..20

да

Название дополнительного параметра мерчанта

value

AN..1024

да

Значение дополнительного параметра мерчанта

 Параметры блока attributes:

Название

Тип

Обязательно

Описание

name

A7

да

Название атрибута - "mdOrder".

value

ANS36

да

Значение атрибута - номер заказа в платежной системе (уникален в пределах системы).

 Параметры блока cardAuthInfo:

Название

Тип

Обязательно

Описание

pan

N..19

нет

Маскированный номер карты, которая использовалась для оплаты.

expiration

N6

нет

Срок истечения действия карты в формате YYYYMM.

cardholderName

A..64

нет

Имя держателя карты.

approvalCode

AN6

нет

Код авторизации платежа. Поле фиксированной длины (6 символов), может содержать цифры и латинские буквы.

 Параметры блока bindingInfo:

Название

Тип

Обязательно

Описание

clientId

AN..255

нет

Номер (идентификатор) клиента в системе магазина.

bindingId

AN..255

нет

Идентификатор связки, использованной для оплаты.

 Параметры блока paymentAmountInfo:

Название

Тип

Обязательно

Описание

paymentState

N..9

нет

Состояние платежа

approvedAmount

N..20

нет

Сумма, подтверждённая к списанию.

depositedAmount

N..20

нет

Сумма списания с карты.

refundedAmount

N..20

нет

Сумма возврата.

 Параметры блока bankInfo:

Название

Тип

Обязательно

Описание

bankName

AN..200

нет

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

bankCountryCode

AN..4

нет

Код страны Банка-эмитента

bankCountryName

AN..160

нет

Наименование страны банка-эмитента на языке, переданном в параметре language в запросе, или на языке пользователя, вызвавшего метод, если язык в запросе не указан.

 Поле orderStatus может принимать следующие значения:

Значение

Описание

0

Заказ зарегистрирован, но не оплачен

1

Предавторизованная сумма захолдирована (для двухстадийных платежей)

2

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

3

Авторизация отменена

4

По транзакции была проведена операция возврата

5

Инициирована авторизация через ACS банка-эмитента

6

Авторизация отклонена

 Коды ошибок (поле errorCode):

Значение

Описание

0

Обработка запроса прошла без системных ошибок

5

Не заполнено одно из обязательных полей

5

Неверный формат параметра transactionStates

5

Доступ запрещён

7

Системная ошибка

10

Значение параметра size превышает максимально допустимое

10

Недостаточно прав для просмотра транзакций указанного мерчанта

Пример запроса GET:

https://server/application_context/rest/getLastOrdersForMerchants.do?userName=userName&password=password&language=ru&page=0&size=100&from=20141009160000&to=20141111000000&transactionStates=DEPOSITED,REVERSED&merchants=SevenEightNine&searchByCreatedDate=false

Пример запроса POST:

language=ru&page=0&size=100&from=20141009160000&to=20141111000000&transactionStates=DEPOSITED,REVERSED&merchants=SevenEightNine&searchByCreatedDate=false

Пример ответа:

{"errorCode":0, 
 
 "orderStatuses":[
 
 {"errorCode":"0","orderNumber":"58drs0Pes459Hdsddd0567a0","orderStatus":2,"actionCode":0,"actionCodeDescription":"Запрос успешно обработан","amount":250000,"currency":"810","date":1414485649233,"orderDescription":"Opisanie","ip":"212.5.125.194","merchantOrderParams":,"attributes":,"cardAuthInfo":{"expiration":"201512","cardholderName":"Ivan","approvalCode":"123456","pan":"411111**1111"},"bindingInfo":{"clientId":"666","bindingId":"1eabfb8e-b90e-4dc8-bef6-14bd392b1cec"},"authDateTime":1414485661207,"terminalId":"111113","authRefNum":"111111111111","paymentAmountInfo":{"paymentState":"DEPOSITED","approvedAmount":250000,"depositedAmount":250000,"refundedAmount":0},"bankInfo":{"bankName":"TEST CARD","bankCountryCode":"RU","bankCountryName":"Россия"}}, 
 
 {"errorCode":"0","orderNumber":"57drs0Pes459Hdsddd0567a0","orderStatus":2,"actionCode":0,"actionCodeDescription":"Запрос успешно обработан","amount":250000,"currency":"810","date":1414485277286,"orderDescription":"Opisanie","ip":"212.5.125.194","merchantOrderParams":,"attributes":,"cardAuthInfo":{"expiration":"201512","cardholderName":"Ivan","approvalCode":"123456","pan":"411111**1111"},"bindingInfo":{"clientId":"666","bindingId":"1eabfb8e-b90e-4dc8-bef6-14bd392b1cec"},"authDateTime":1414485296046,"terminalId":"111113","authRefNum":"111111111111","paymentAmountInfo":{"paymentState":"DEPOSITED","approvedAmount":250000,"depositedAmount":250000,"refundedAmount":0},"bankInfo":{"bankName":"TEST CARD","bankCountryCode":"RU","bankCountryName":"Россия"}}], 
 
 "totalCount":2,"page":0,"pageSize":100}

9. Запрос добавления карты в список SSL-карт

Для добавления номера карты, которая использовалась при попытке оплаты заказа, в "Список SSL-карт" используется запрос updateSSLCardList.do.

Метод доступен только по согласованию с банком. Пользователю должны быть назначены права на работу с фрод-списками.

Параметры запроса:

Название

Тип

Обязательно

Описание

mdorder

ANS36

да

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

Параметры ответа:

Название

Тип

Обязательно

Описание

errorCode

N3

нет

Код ошибки.

errorMessage

AN..512

нет

Описание ошибки на языке пользователя по умолчанию.

Коды ошибок (поле errorCode):

Значение

Описание

0

Обработка запроса прошла без системных ошибок

1

Доступ запрещён

2

Пользователь должен изменить свой пароль

3

Номер заказа не задан

4

Платеж отсутствует в системе или указан неверный mdorder

6

Номер карты уже присутствует списке

7

Системная ошибка

Пример запроса:

https://server/application_context/rest/updateSSLCardList.do?mdorder=a4d7d5e5-441d-401c-b25e-bd5d9fffe227&userName=987&password=111111

Пример ответа:

{"errorCode":"0","errorMessage":"Обработка запроса прошла без системных ошибок"}