Загальні відомості

__NOTOC__

Merchant API

Головна сторінка

• Загальні_відомості
• Заголовки запитів
  • URL
  • Налаштування безпеки
  • Реєстрація партнера в системі
  • Тестові параметри
• Основні запити та відповіді
• Реєстрація точки та створення сесії
• Створення замовлення
  • Створення замовлення для холдованих платежів
• Розхолдування платежу
• Параметри BrowseInfo при 3DS оплаті
• Підтвердження платежу клієнтом. Введення смс. Проходження 3DS перевірки
• Перевірка статусу платежу
• Скасування платежу
  • Скасування звичайного платежу
  • Скасування повної суми платежу (замовлення зі Splitting параметрами)
  • Приклади запитів
  • Часткове скасування (повернення) платежу (замовлення зі Splitting параметрами)
• Повідомлення про платіж
  • Отримання інформації про рекурентний платіж
  • Виклик рекурентного платежу
  • Видалення рекурентного платежу
• Робота з токенізованими картами

(Токенізація з передачею даних картки у запиті

• Токенізація за допомогою введення даних картки користувачем на сторінці
• Отримання списку токенізованих карт
• Видалення токенізованих карт
• Видача кредиту (переказ на картку користувача)
• Нотифікації (колбеки) щодо операцій поповнення карток
• Інтеграція з ApplePay та GooglePay
  • Інтеграція з ApplePay
  • Інтеграція з GooglePay
• Створення підпису
• Можливі варіанти інструментів оплати
• SDK
  • IOS-SDK
  • Android-SDK
  • Flutter-SDK

Вступ

---

Протокол призначено для торговців, які є одержувачами платежів. Продавець підписує договір про прийняття платежів або анкету-акцепт до публічної оферти.

Щоб отримати платежі, ви можете використовувати web, мобільні версії сайтів, а також мобільні програми. У разі використання цього протоколу не здійснюється перевірка даних для ідентифікації замовлення або облікового запису. EasyPay завжди приймає дані, надіслані та створені продавцем.

Заголовки запитів

---

Для надсилання запиту та отримання відповіді у форматі JSON, необхідно передати такі обов’язкові заголовки у запиті.

--header 'Content-Type: application/json'

--header 'AppId: cd7fde18-15db-4d94-a91b-7cf8edd81209'

--header 'PageId: 3e7bf353-417a-410c-a22e-df8bdcccb760'

--header 'PartnerKey: easypay-test'

--header 'locale: ua'

--header 'Sign: bS+vPOwu1Sif1Iz47Cdh+z1RAi0s6X21C3uU0YNBNWE='

URL

---

Посилання	Характеристика	Коментарій
https://merchantapi.easypay.ua	Production	в т.ч. для надсилання тестових запитів

Налаштування безпеки

---

Партнер надає IP, з яких будуть здійснюватися запити.

Реєстрація партнера в системі EasyPay

---

Реєстрація нового торговця передбачає отримання унікального ідентифікатора PartnerKey.

Характеристика параметрів реєстрації

Параметр	Характеристика	Коментарій
PartnerKey	унікальний ідентифікатор партнера (продавця) у системі EasyPay.	передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
ServiceKey	ідентифікатор сервісу торговця у системі EasyPay.	магазину чи послуги передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
SecretKey	секретний ключ для формування підпису	відомий лише торговцю та EasyPay передається партнеру після реєстрації у системі EasyPay відповідальним менеджером.
AppId	ідентифікатор торгової точки партнера	параметр валідний протягом 90 днів. Один і той же AppID може використовуватись для декількох платежів)
PageId	ідентифікатор сесії	параметр валідний протягом 20 хв. Для кожного запиту CreateOrder потрібно використовувати унікальний PageID

Тестові параметри

---

Для тестових запитів використовуються такі параметри:

PartnerKey = easypay-test
ServiceKey = MERCHANT-TEST
SecretKey = test

На даний момент відсутня можливість тестування з використанням фейкових оплат / тестових карток. Платежі тільки реальні, їх можна відмінити в день оплати методом cancelOrder (Скасування платежу)

Тестове середовище

---

Перед початком використання тестового середовища необхідно надати ір з яких будуть надходити запити, для відкриття доступу. На тестовому середовищі використовуються методи аналогічні Merchant Api. Тестові дані:

PartnerKey:credit-test
SecretKey: credit-test
serviceKey:TEST-CREDIT-PAYMENT - погашення
serviceKey:TEST-CREDIT-PAYMENT - погашення
serviceKey:TEST-CREDIT-TO-CARD - виплата
Надсилання колбеків з Iр: 195.230.131.50

Тестові картки для верифікації/виплат:

Код підтвердження для 2дс при верифікації картки: 123456

Pan	Card.Expire/CVV	Статус виплати
5167803258208169	0525/111	Успішна виплата
4235751329985326	0525/111	Неуспішна виплата
4111111111111111	0525/111	Неуспішна без створення транзакції
4999999999990011	0525/111	Успішна виплата з затримкою статусу 5 хв
4217198608967728	0525/111	Неуспішна виплата з затримкою статусу 5 хв

Тестові картки для оплати:

Pan	Card.Expire/CVV	Статус виплати
5168752081922117	0128/111	Успішна оплата з 3ДС/ або не успішна оплата з 3ДС
4909150002132451	0129/111	Успішна 2ДС оплата
4300380058021820	0130/111	Не успішна з 3ДС + помилка PAYMENT_ALFABANK_116
5567217349220669	0130/111	Успішна оплата з 3ДС/ або не успішна оплата з 3ДС

У разі отримання помилки APPID_NOT_FOUND у відповідь на будь-який метод, необхідно повторити запит createApp до отримання точки ІД.

← Назад
Головна сторінка

Далі → Основні запити та відповіді