Специфікація команд
- Vladimir Tychina (Unlicensed)
- Tech Platon
Команда 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 | Текст повідомлення про помилку |