Спецификация команд
Команда TRANSFER_PREPARE
Параметры запроса
Параметр | Описание | Значение | Обязательность |
action | Тип операции | TRANSFER_PREPARE | + |
client_key | Уникальный ключ Клиента (CLIENT_KEY) | + | |
client_order_id | ID перевода в системе Клиента | Строка до 255 символов | + |
sender_card_number | Номер карты Отправителя перевода | + | |
sender_card_exp_month | Месяц окончания срока действия карты Отправителя | Месяц в формате XX | + |
sender_card_exp_year | Год окончания срока действия карты Отправителя | Год в формате XXXX | + |
sender_card_cvv2 | CVV/CVC2 код карты Отправителя | 3-4 символа | + |
receiver_card_number | Номер карты Получателя | + | |
transfer_amount | Сумма перевода | Число в формате XXXX.XX | + |
transfer_currency | Валюта перевода | 3-символьный код | + |
sender_phone | Номер телефона Отправителя | Строка до 32 символов | + |
sender_ip | IP-адрес Отправителя | XXX.XXX.XXX.XXX | + |
term_url_3ds | URL на который необходимо вернуть отправителя, после прохождения 3DS. | Строка до 1024 символов | +/- |
signature | Подпись запроса | + |
Команда используется для регистрации в Платежной Платформе данных для выполнения перевода, а также расчета комиссии за перевод
Успешный ответ
Параметр | Описание |
action | TRANSFER_PREPARE |
result | SUCCESS |
status | INIT |
client_order_id | ID перевода в системе Клиента |
transfer_id | ID перевода в Платежной платформе |
transfer_amount | Сумма перевода |
transfer_commission | Сумма комиссии |
transfer_currency | Валюта перевода |
transaction_date | Дата транзакции |
Не успешный ответ
Параметр | Описание |
action | TRANSFER_PREPARE |
result | DECLINED |
status | DECLINED |
client_order_id | ID перевода в системе Клиента |
transfer_id | ID перевода в Платежной платформе |
decline_reason | Причина отказа |
transaction_date | Дата транзакции |
Команда TRANSFER_RUN
Параметр | Описание | Значение | Обязательность |
action | Тип операции | TRANSFER_RUN | + |
client_key | Уникальный ключ Клиента (CLIENT_KEY) | + | |
transfer_id | ID перевода в Платежной платформе | + | |
sender_card_cvv2 | CVV/CVC2 код карты Отправителя | 3-4 символа | + |
signature | Подпись запроса | + |
Команда используется для начала выполнения перевода по ранее введенным данным.
В зависимости от используемых карт и настроек аккаунта, может потребоваться выполнить дополнительную проверку или проверки.
Успешный ответ, если не выполняется 3DS или Look-up проверка
Параметр | Описание |
action | TRANSFER_RUN |
result | SUCCESS |
status | SETTLED |
client_order_id | ID перевода в системе Клиента |
transfer_id | ID перевода в Платежной платформе |
transaction_date | Дата транзакции |
| rrn | RRN транзакції |
Успешный ответ, если необходимо выполнить 3DS
Параметр | Описание |
action | TRANSFER_RUN |
result | SUCCESS |
status | 3DS |
client_order_id | ID перевода в системе Клиента |
transfer_id | ID перевода в Платежной платформе |
redirect_url | URL на который необходимо перенаправить Отправителя |
redirect_params | Массив параметров |
redirect_method | POST или GET |
transaction_date | Дата транзакции |
После этого, необходимо выполнить редирект плательщика (Отправителя) на "redirect_url" (ACS сервер банка-эмитента карты), с параметрами "redirect_params", которые должны быть отправлены методом POST или GET (см. "redirect_method"). После прохождения 3DS, плательщик будет переадресован на "term_url_3ds".
Для дальнейшей работы, чтобы узнать результат прохождения 3DS - необходимо обязательно выполнить запрос TRANSFER_STATUS. На основе полученного статуса перевода, необходимо инициировать дальнейшие команды.
Например:
если получен статус SETTLED – значит, проверка прошла успешно, и перевод уже выполнен.
если получен статус LOOKUP – значит, проверка прошла неуспешно, и необходимо пройти еще Look-up проверку.
Успешный ответ, если необходимо выполнить Look-up проверку
Параметр | Описание |
action | TRANSFER_RUN |
result | SUCCESS |
status | VERIFICATION_BCODE |
client_order_id | ID перевода в системе Клиента |
transfer_id | ID перевода в Платежной платформе |
transaction_date | Дата транзакции |
Для дальнейшей работы необходимо выполнить команду TRANSFER_VERIFY
Не успешный ответ
Параметр | Описание |
action | TRANSFER_RUN |
result | DECLINED |
status | DECLINED |
client_order_id | ID перевода в системе Клиента |
transfer_id | ID перевода в Платежной платформе |
transaction_date | Дата транзакции |
Команда TRANSFER_VERIFY
Параметры запроса
Параметр | Описание | Значение | Обязательность |
action | Тип операции | TRANSFER_VERIFY | + |
client_key | Уникальный ключ Клиента (CLIENT_KEY) | + | |
transfer_id | ID перевода в Платежной платформе | + | |
| sender_card_cvv2 | CVV/CVC2 код карты Отправителя | 3-4 символа | + |
lookup_code | Проверочный код полученный Отправителем | 6 цифр в формате XXXXXX | + |
signature | Подпись запроса | + |
Успешный ответ
Параметр | Описание |
action | TRANSFER_VERIFY |
result | SUCCESS |
status | SETTLED |
client_order_id | ID перевода в системе Клиента |
transfer_id | ID перевода в Платежной платформе |
transaction_date | Дата транзакции |
| rrn | RRN транзакції |
Не успешный ответ
Параметр | Описание |
action | TRANSFER_VERIFY |
result | DECLINED |
status | DECLINED |
client_order_id | ID перевода в системе Клиента |
transfer_id | ID перевода в Платежной платформе |
decline_reason | Причина отказа |
transaction_date | Дата транзакции |
Команда TRANSFER_STATUS
Параметры запроса
Параметр | Описание | Значение | Обязательность |
action | Тип операции | TRANSFER_STATUS | + |
client_key | Уникальный ключ Клиента (CLIENT_KEY) | + | |
transfer_id | ID перевода в Платежной платформе | + | |
signature | Подпись запроса | + |
Команда используется для получения текущего статуса и данных о переводе.
Команду можно выполнить в любой момент после того, как перевод был зарегистрирован в Платежной Платформе с соответствующим идентификатором.
Успешный ответ
Параметр | Описание |
action | TRANSFER_STATUS |
result | SUCCESS |
status | Текущий статус перевода |
client_order_id | ID перевода в системе Клиента |
transfer_id | ID перевода в Платежной Платформе |
sender_card_bin | BIN карты Отправителя |
sender_card_last4 | Последние 4 цифры номера карты Отправителя |
receiver_card_bin | BIN карты Получателя |
receiver_card_last4 | Последние 4 цифры номера карты Получателя |
sender_phone | Номер телефона Отправителя |
transfer_amount | Сумма перевода |
transfer_commission | Сумма комиссии |
transfer_total | Общая сумма операции (сумма перевода + сумма комиссии) |
transfer_currency | Валюта перевода |
redirect_url | URL на который необходимо перенаправить Отправителя |
redirect_params | Массив параметров |
redirect_method | POST или GET |
decline_reason | Причина отказа |
transfer_date | Дата перевода |
Ошибки
В случае невозможности обработать запрос, будет отправлено сообщение об ошибке:
Параметр | Описание |
result | ERROR |
error_message | Текст сообщения об ошибке |