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

Обзор

Управлять платежами можно с помощью личного кабинета и/или путем обращения к Empayre Platform API. Способы приема платежей описаны на шаге 2 раздела «С чего начать?».

Ниже приведено описание основных терминов и понятий, которыми оперирует платформа.

Платформа (Platform)

Программно-аппаратный комплекс Empayre, обеспечивающий техническую реализацию бизнес-процессов по приему платежей.

Личный кабинет​

Чтобы начать работать с платформой, необходимо зарегистрироваться и получить доступ к личному кабинету мерчанта (далее по тексту — ЛК).

Мерчант (Merchant)

Продавец товара или услуги, которую оплачивает покупатель. Участник информационно-технического и финансового взаимодействия.

В нем вы сможете найти API-ключ (API Key) для прохождения аутентификации при обращении к API, а также провести тестовый платеж.

API​

Одним из способов приема платежей является интеграция с платформой по Empayre Platform API.

C целью успешной авторизации запроса к API в его заголовке следует передать соответствующий ключ. Для каждого отдельного запроса могут потребоваться различные ключи: зависит от типа выполняемой операции.

Так, например, API-ключ передается в запросе на создание инвойса, а ключ доступа к инвойсу — в последующих запросах, нацеленных на оплату выставленного счета.

Магазин​

Магазин — торговая точка мерчанта. Представляет собой способ обобщения товаров или услуг, объединённых одной категорией (MCC, Merchant Category Code). Является получателем платежа.

Магазину соответствует как минимум один счет в платформе, на котором аккумулируются полученные от покупателей денежные средства.

Покупатель (Payer)

Физическое лицо, осуществляющее оплату товаров или услуг. В некоторых случаях упоминается как «плательщик».

Накопленные средства можно получить с помощью банковского перевода или на баланс электронного кошелька Empayre.

Магазин может быть:

  • активным или неактивным;
  • настоящим или тестовым.

Получить информацию о магазине, а также управлять его активностью можно с помощью данных запросов к api.

Инвойс​

Инвойс — это счет на оплату: отражение заказа с товарами или услугами, который необходимо оплатить. Демонстрирует обязательства продавца и покупателя.

Создать инвойс или получить его состояние можно с помощью данных запросов к api. В результате выполнения запроса createInvoice в платформе создается счет, ожидающий оплату, которому присваивается уникальный идентификатор и ключ доступа.

Жизненный цикл счета на оплату отражен в разделе «Invoice statuses» документации API.

Ключ доступа к инвойсу​

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

InvoiceAccessToken, в отличие от API Key, допустимо публиковать.

Платеж​

Для того чтобы денежные средства за предложенные покупателю товары или услуги поступили на счет магазина, необходимо оплатить инвойс.

В случае, когда оплата производится с платежной формы Empayre, последовательность взаимодействия с платформой выглядит так:

Далее платежная форма самостоятельно выполняет весь процесс проведения платежа.

В случае, когда вы сами верстаете платежную форму, последовательность взаимодействия с платформой выглядит так, как показано в разделе «Схема информационного взаимодействия».

Схема информационного взаимодействия​

Ниже приведен пример оплаты инвойса с web-сайта мерчанта в случае, когда платеж производится с его собственной платежной формы.

Названия представленных на схеме запросов указывают на конкретные методы платежного API.

Информация

Получение, передача, обработка и хранение данных банковских карт влечет за собой необходимость соответствовать определенным стандартам безопасности.

Уведомление о событиях (Webhook)​

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

Webhook'ами можно управлять с помощью данных запросов к API.

При получении уведомления следует убедиться, что оно было отправлено платформой. Для решения этой задачи платформа подтверждает подлинность переданной информации, подписывая сообщения приватным ключом RSA. C описанием спецификации «Webhooks Events API» можно ознакомиться здесь.