Перейти к основному содержимому

1. Введение

С помощью данного API может быть реализован приём денежных средств по различным способам оплаты (перечислены в разделе 6.8). Вы можете инициировать платежи, выставлять счета, совершать возвраты, узнавать статус платежей и т.д.

1.1 Быстрый старт

Существует 2 основных способа подключить приём платежей на сайте или в приложении:

  • Всплывающий или встроенный js-виджет для оплаты на странице сайта ТСП (раздел 2.1)
  • Платёжная страница Миксплат, на которую нужно перенаправить плательщика (раздел 3.1)

Любой из этих способов равнозначен по опциям создания платежа. Использование js-виджета более приоритетно, если аудитория лояльна к вашему сайту.

Для многих популярных CMS (систем управления сайтом) доступны платёжные модули, если используется модуль интеграция не требуется, достаточно установить и настроить модуль.

1.2 Подготовка к взаимодействию

Перед началом интеграции данного API у вас должен быть создан аккаунт в системе Миксплат, получен секретный ключ для работы с API или открытый ключ для вызова js-виджета из вашего личного кабинета, подключен как минимум один проект и корректно настроены параметры данного проекта.

Если есть необходимость в получении статусов платежей, потребуется подготовить скрипт-обработчик статусов и прописать его в настройках проекта ЛК. Также потребуются страницы для перенаправления плательщика в случае успешного и неуспешного статуса платежа.

Платёжный шлюз Миксплат полностью соответствует требованиям Закона 54-ФЗ о фискальных чеках и предоставляет возможность передавать список товаров для формирования онлайн-чеков (подробнее в разделе 4.6).

1.3 Термины и определения

  • ТСП – торгово-сервисное предприятие, работающее с Миксплат
  • Проект – отдельная услуга/сервис/сайт ТСП
  • ЛК – личный кабинет ТСП в системе Миксплат
  • API – программный интерфейс для взаимодействия с Миксплат, расположенный по адресу: https://api.mixplat.com
  • API_KEY – секретный ключ для работы с API, получаемый из ЛК Миксплат, единый для всех проектов ТСП
  • Обработчик ТСП – скрипт на стороне ТСП, принимающий нотификации от Миксплат
  • Мобильная коммерция – оплата товара/услуги со счёта мобильного телефона
  • Эквайринг – оплата товара/услуги банковскими картами
  • Плательщик - пользователь Проекта, покупатель, осуществляющий оплату в пользу ТСП
  • ОФД – оператор фискальных данных - организация, куда передаются онлайн-чеки
  • Рекуррент - повторные безакцептные списания произвольных сумм с карты плательщика в произвольные моменты времени (например, по запросу со стороны ТСП)
  • Подписка - частный случай рекуррентов, когда регулярные безакцептные списания средств с карты плательщика производятся без дополнительных действий со стороны ТСП согласно настройкам в системе Миксплат