Info
Цей функціонал буде активовано після вашого запиту в груповому чаті.

Зміст

Table of Contents

maxLevel	2
indent	0px
absoluteUrl	true
style	circle

Опис

Цей функціонал дозволить розмістити на вашому боці інтерфейс оплати частинами для клієнтів Monobank.

Info

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

Для використання в оффлайні вам необхідно інтегрувати це API до вашого ПЗ. Механізм взаємодії в такому випадку буде наступним:

Клієнт в оффлайн магазині говорить, що хоче оплатити частинами Monobank.
Менеджер просить назвати номер телефону прив'язаного до Monobank та вводить його разом з кількістю частин в вашому ПЗ, та відправляє запит відповідно до цього API методу.
Клієнту на телефон в додаток Monobank надходить повідомлення з пропозицією про можливість взяття оплати частинами, яке він може прийняти / відхилити, збільшити кількість частин (від наданої мерчантом кількості частин) з додатковою платою з боку клієнта за тарифами Monobank.
Після успішного підтвердження клієнтом в додатку до вас в систему буде відправлено коллбек з даними про платіж по результату якого менеджер може вибити чек та видати товар.

Мінімальна сума - 500 грн.

Максимальна сума - визначається Monobank та відображається в умовах та правилах Monobank.

Після відправки API запиту у платника буде 15 хв на прийняття рішення.

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

Підтвердження списання можливе декількома методами:

Вручну в нашому особистому кабінеті.
Налаштувати на боці PSP Platon автоматичне підтвердження списання в термін від 1 години до 29 днів, про що необхідно повідомити в груповий чат. В цьому випадку менеджеру мерчанта необхідно вручну перевіряти кінцевий статус оплати в особистому кабінеті PSP Platon. Фінальний статус успішнох оплати буде SETTLED CAPTURE SUCCESS.
Налашатувати по API запиту підтвердження списання з холду під вашу бізнес-логіку використовуючи Підтвердження списання з HOLD.

Warning
Увага! Підтвердження списання з HOLD та повернення необхідно виконувати в повному обсязі суми кредиту. Часткове списання та часткове повернення заборонено.

Warning
Увага! Товар / послугу можна надавати лише після успішного підтвердження списання коштів.

Чекліст інтеграції

Привести сайт / додаток до відповідності вимогам.
Передати тех підтримці PSP Platon посилання для Callback.
Повідомити тех підтримці PSP Platon ваші IP адреси серверів сайта або про те, що буде використовуватись додаток (в цьому випадку обмеження по IP будуть зняті).
Провести інтеграцію цього API методу.
Створити і відобразити клієнту форму для вводу номерат телефону, який прив'язаний до Monobank.
Відобразити клієнту вибір кількості частин за необхідності в проміжку від 3 до 25 платежів (включно).
Відправити API запит з вашого сервера / додатку відповідно до цього API методу.
Відобразити платнику сторінку очікування на якій клієнт буде поки не проведе дії в додатку Monobank. У клієнта є 15 хв на прийняття рішення.
Отримати Response або Callback зі статусом платежа PSP Platon після проведення платником дій в додатку Monobank.
Повідомити клієнту про успішність / не успішність оплати частинами.

Best Practices

Ознайомтесь з PDF файлом з Best Practices як найкраще надати клієнтам інформацію про нову для ним можливість оплати частинами на вашому ресурсі:

View file

name	Instalment best practices.pdf

Вимоги до сайту

Include Page

	Вимоги до сайтів та додатків
	Вимоги до сайтів та додатків

API параметри

HTTP METHOD: POST

API ENDPOINT: https://secure.platononline.com/post/

Параметр

Значення

Опис

Особливості

action

Status

colour	Green
title	обов'язковий

SALE_PART

Код платіжного метода

client_key

Status

colour	Green
title	обов'язковий

String

API ключ мерчанта

Ключ надається на пошту мерчанта

order_id

Status

colour	Green
title	обов'язковий

String

ID оплати в системі мерчанта

Max 32 символи

order_amount

Status

colour	Green
title	обов'язковий

Number

Сума оплати

Info
Мінімальна сума оплати частинами Monobank - 500.00

Tip

Вірний варіант

1000.00

Warning

Невалідні варіанти

1000
1000.0
1,000.0
1,000.00

order_currency

Status

colour	Green
title	обов'язковий

UAH

Валюта

Info
Оплата можлива лише в національній валюті гривні

order_description

Status

colour	Green
title	обов'язковий

String

Опис

Note
Для кириличних символів необхідно використовувати формат UTF-8

Max 255 символів

payer_ip

Status

colour	Green
title	обов'язковий

Number

IP-адреса платника

В форматі "ХХХ.ХХХ.ХХХ.ХХХ"

Note
IPv6 на даний момент не підтримується та за наявності буде приводити до помилки.

term_url_3ds

Status

colour	Green
title	обов'язковий

String

Посилання по якому буде відправлено платника після спроби оплати

Max 255 символів

payer_email

Status

colour	Green
title	обов'язковий

String

Пошта платника

Info
Обов'язково валідна пошта.

Info
Відсутність пробілів.

Max 255 символів

payer_phone

Status

colour	Green
title	обов'язковий

Number

Фінансовий номер телефону платника прив'язаний до Monobank

Info
Обов'язковий формат телефону +380XXXXXXXXX

ext4

Status

colour	Green
title	обов'язковий

String

"{"available_parts_count":"n"}"

JSON з кількістю обраних частин від 3 до 25 (включно), наприклад "{"available_parts_count":"6"}"

channel_id

Status

colour	Yellow
title	не обов'язковий

hash

Status

colour	Green
title	обов'язковий

String

Контрольний підпис

Code Block

language	php

md5(
  strtoupper($pass).
  strrev($order_id)
)

async

Status

colour	Yellow
title	не обов'язковий

Y
N

Включити асинхронний режим

В асинхронному режимі обов'язкове використання коллбеків.
Стандартне значення N

payer_first_name

Status

colour	Yellow
title	не обов'язковий

String

Ім'я платника

Max 32 символи без пробілів

payer_last_name

Status

colour	Yellow
title	не обов'язковий

String

Прізвище платника

Max 32 символи без пробілів

payer_address

Status

colour	Yellow
title	не обов'язковий

String

Адреса платника

Max 256 символи
ВказатиNA, якщо немає даних

payer_country

Status

colour	Yellow
title	не обов'язковий

String

Країна платника

Стандарт ISO 3166-1 alpha-2
В форматі "ХХ"
2 символа
Вказати NA, якщо немає даних

payer_state

Status

colour	Yellow
title	не обов'язковий

String

Штат платника

Стандарт ISO 3166-2
В форматі "ХХ"
2 символа
Вказати NA, якщо немає даних

payer_city

Status

colour	Yellow
title	не обов'язковий

String

Місто плателника

Max 32 символи
Вказати NA, якщо немає даних

payer_zip

Status

colour	Yellow
title	не обов'язковий

String

Поштовий індекс платника

Max 32 символи
Вказати NA, якщо немає даних

ext1, ext2, ext3, ext5, ext6, ext7, ext8, ext9, ext10

Status

colour	Yellow
title	не обов'язковий

String

10 додаткових полів

Max 1024 символи в кажному ext полі

Приклад запиту

Expand

title	Приклад запиту на PHP

Code Block

language	php

<?php
  $client_pass = '***';
  $data['action'] = 'SALE_PART';
  $data['client_key'] = '***';
  $data['order_id'] = '546-4588';
  $data['order_amount'] = '1000.00';
  $data['order_currency'] = 'UAH';
  $data['order_description'] = 'test';
  $data['payer_first_name'] = 'Ivan';
  $data['payer_last_name'] = 'Ivanov';
  $data['payer_phone'] = '+380111111111';
  $data['payer_email'] = 'sale@gmail.com';
  $data['payer_ip'] = '213.186.115.164';
  $data['term_url_3ds'] = 'https://google.com';
  $data['ext4'] = '{"available_parts_count":"6"}';
  $data['hash'] = md5(
                    strtoupper($client_pass).
                    strrev($data['order_id'])
                  );

$url = 'https://secure.platononline.com/post/';
$crq = curl_init();
curl_setopt($crq, CURLOPT_URL, $url);
curl_setopt($crq, CURLOPT_HEADER, 0);
curl_setopt($crq, CURLOPT_POST, 1);
curl_setopt($crq, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($crq, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($crq, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($crq, CURLOPT_POSTFIELDS, $data);
$result = curl_exec($crq);
if (curl_errno($crq)) {
  echo 'ERROR: '.curl_error($crq);
}else{
  echo $result;
}
curl_close($crq);

Info
Postman Collection

Тестування

Тестування рекомендовано проводити реальним номером телефону, який підключено до Monobank та має відповідний баласн для оплати частинами.

Якщо ви не маєте змоги робити це реальним номером телефону, то можете використати тестове середовище, але зверніть увагу, що його використання сильно відрізняється від реального використання так як не включає в себе використання додатку Monobank яке є обов'язковим при реальній оплаті. Нижче описано варіанти доступні для тестового середовища:

Успішне підтвердження заявки. Для цієї ситуації потрібно передати фейковий номер телефону, що закінчується на 1. У цьому випадку через 5 секунд буде кинуто callback про успішне затвердження заявки.
Заявка, що очікує підтвердження від клієнта. Для цієї ситуації необхідно передати фейковий номер телефону, що закінчується на 2.
Помилка підтвердження заявки через недостатній ліміт у клієнта. Для цієї ситуації потрібно передати фейковий номер телефону, що закінчується на 3. У цьому випадку через 5 секунд буде кинуто callback про відхилення заявки.
Заявка підтверджена клієнтом та очікує на підтвердження від магазину. Для цієї ситуації необхідно передати фейковий номер телефону, що закінчується на 4.

Перевірка платежів

Expand

title	Список методів отримання результату транзакції

Include Page

	Отримання результату транзакції
	Отримання результату транзакції

Callback

Expand

title	Особливості роботи з Callback

Include Page

	Робота з Callback
	Робота з Callback

Expand

title	Безпека

Include Page

	Безпека
	Безпека

Синхронний режим

Стандартний режим роботи. Передавати async = N не потрібно.

Асинхронний режим

Цей режим активується при передачі async = Y. В цьому режимі є обов'язковим використання коллбеків.

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

Include Page

	Callback / Response - SALE_PART Monobank
	Callback / Response - SALE_PART Monobank

Помилки запитів

Якщо в запиті буде вказано не фінансовий номер телефону клієнта (тобто той який не підв'язаний в Monobank) - буде помилка "decline_reason":"Phone not found in MONO"

Expand

title	Список помилок та рішень

Include Page

	Помилки та рішення при запитах
	Помилки та рішення при запитах

Versions Compared

Old Version 52

New Version Current

Key

Зміст

Опис

Чекліст інтеграції

Рекомендації

Best Practices

Вимоги до сайту

API параметри

Приклад запиту

Тестування

Перевірка платежів

Callback

Синхронний режим

Асинхронний режим

Помилки запитів

Page Comparison

Versions Compared

Old Version 52

New Version Current

Key

Зміст

Опис

Чекліст інтеграції

Рекомендації

Best Practices

Вимоги до сайту

API параметри

Приклад запиту

Тестування

Перевірка платежів

Callback

Синхронний режим

Асинхронний режим

Помилки запитів