1.1 Информация про MP Business

Для чего? ВАЖНО!

API MP Business, помогает:

• Управлять балансом Касс Информация про Кассы
• Выставление счетов Генерация Платежей
• Проверка статусов счетов Уведомления и API запрос
• Переводы средств Перевод на карты, э-кошельки и криптовалюту

1.2 Описание процесса

Описание сценария

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

1. Оформление заказа (на стороне вашего сайта)
   • Требуется сгенерировать форму оплаты с методом post
   • В форме обязательно должен быть сгенерированный ключ signature, а так же другие дополнительные параметры, которые Вы можете найти в 1.4 Выставление счета
2. Отправка клиента к нам
   • Клиент оплачивает выставленный вами счет. Сумма оплаты будет выдана клиенту.
   • Выбрать кто будет оплачивать комиссия, Вы можете в настройках магазина.
3. Переадресация клиента
   • После оплаты клиентом, он переадресовывается на 302 страницу, где будет происходить проверка прихода средств. Как на нашу сторону придет уведомление о статусе оплаты, мы переадресовываем его на соответствующую страницу после успешной/неуспешной страницы.
4. Интеграция - потребуется интеграция посредством отправки формы. Для перехода к оплате, вам потребуется отправлять пользователя к нам. Пользователя Вы должны отправить путем отправки формы, подробнее о генерации формы
5. Обработка платежей
   • Если клиент оплатил выставленный счет, то только тогда Вам приходит уведомление об оплате с get/post параметрами. 1.6 Информация о счете
6. Выполнение обязательств
   • После отправки уведомления, вы обязательно должны выполнить обязательства. Если клиент не получает услугу после оплаты, ваш магазин будет заблокирован без вывода средств.

1.3 Авторизация

Аутентификация с использованием подписи

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

Генерация параметров запроса

1. Генерация Time stamp (Временная метка)

# Example in Python
import time  

timestamp = time.time()

2. Создание подписи

# Example in Python
import hashlib
import hmac
import json

params = {
    '': '',
    ...
}

# Преобразование параметров в JSON-строку
payload_str = json.dumps(params)

# Секретный ключ кассы
secret_key = ''

# Создайте подпись
XApiSignature = hmac.new(secret_key.encode(), payload_str.encode(), hashlib.sha256).hexdigest()

Пример заголовков запроса (headers)

POST /api/authorization HTTP/1.1
Host: example.com
timestamp:
x-api-public-key: <your-public-key>
x-api-signature: <generated-signature>
Content-Type: application/json

Где:
• timestamp- Заменяется на сгенерированный timestamp (временная метка).
• x-api-public-key- Заменяется на ваш открытый ключ для аутентификации.
• x-api-signature- Заменяется на созданную подпись с использованием секретного ключа и параметров запроса.

# Example in Python
import time
import hashlib
import hmac
import json
import requests

# Параметры запроса
params = {
    '': '',
    ...
}

# Преобразование параметров в строку JSON
payload_str = json.dumps(params)

# Получение текущего времени в виде строки
timestamp = str(time.time())

# Секретный ключ и публичный ключ
secret_key = ''
public_key = ''

# Создание подписи запроса
XApiSignature = hmac.new(secret_key.encode(), payload_str.encode(), hashlib.sha256).hexdigest()

# Формирование заголовков запроса
headers = {
    'timestamp': timestamp,
    'x-api-public-key': public_key,
    'x-api-signature': XApiSignature,
}

# Отправка GET-запроса
url = 'https://mayfpay.top/api/v2/...' 
r = requests.get(url, params=params, headers=headers)

# Вывод ответа на запрос
print(r.json())

1.4 Баланс Кассы

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

• URL метода: https://mayfpay.top/api/v2/kassa/balance
• Метод: GET
• Content-Type: application/json
• Описание: Основная информация о Кассе

Пример ответа

{
   "KassaId": 3,
   "KassaName": "MAYFPAY TEST",
   "KassaBalance": 12232.55,
   "KassaFeeOn": 0
}

1.5 Создания платежа (Выставление счета)

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

Требование (Requirement) ВАЖНО!

• 1. Авторизация запроса
• 2. Генерация/Создание платежа
• 3. Обработка платежей

Создания платежа (Выставление счета)

• URL метода: https://mayfpay.top/api/v2/kassa/invoice/create
• Метод: POST
• Content-Type: application/json
• Описание: Создание платежа (Получение ссылки)

Пример тела запроса:

• Python
• PHP
• JavaScript
• Curl

# Установка базового URL для запросов
base_url = 'https://mayfpay.top/'

# Параметры запроса
params = {
    'api_token': '',  # Здесь нужно указать ваш API токен
    'kassa_id': '',  # Здесь нужно указать идентификатор кассы
    'amount': '',  # Здесь нужно указать сумму платежа
    'order_id': '',  # Здесь нужно указать идентификатор заказа
}

secret_key = ''  # Здесь нужно указать ваш секретный ключ
public_key = ''  # Здесь нужно указать ваш публичный ключ

# Преобразование параметров запроса в строку JSON
payload_str = json.dumps(params)

# Создание подписи запроса
XApiSignature = hmac.new(secret_key.encode(), payload_str.encode(), hashlib.sha256).hexdigest()

# Формирование заголовков запроса
headers = {
    'timestamp': str(time.time()),
    'x-api-public-key': public_key,
    'x-api-signature': XApiSignature,
    'Content-type': 'application/json',
}

# Формирование полного URL для создания инвойса
url = base_url + 'api/v2/kassa/invoice/create'

# Отправка POST-запроса для создания инвойса
response = requests.post(url, json=params, headers=headers)

<?php
$base_url = 'https://mayfpay.top/';

$params = array(
    'api_token' => '', // Здесь нужно указать ваш API токен
    'kassa_id' => '', // Здесь нужно указать идентификатор кассы
    'amount' => '', // Здесь нужно указать сумму платежа
    'order_id' => '' // Здесь нужно указать идентификатор заказа
);

$secret_key = ''; // Здесь нужно указать ваш секретный ключ
$public_key = ''; // Здесь нужно указать ваш публичный ключ

$payload_str = json_encode($params);

$XApiSignature = hash_hmac('sha256', $payload_str, $secret_key);

$headers = array(
    'timestamp' => strval(time()),
    'x-api-public-key' => $public_key,
    'x-api-signature' => $XApiSignature,
    'Content-type' => 'application/json'
);

$url = $base_url . 'api/v2/kassa/invoice/create';

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

?>

const crypto = require('crypto');
const axios = require('axios');

// Установка базового URL для запросов
const base_url = 'https://mayfpay.top/';

// Параметры запроса
const params = {
  api_token: '', // Здесь нужно указать ваш API токен
  kassa_id: '', // Здесь нужно указать идентификатор кассы
  amount: '', // Здесь нужно указать сумму платежа
  order_id: '', // Здесь нужно указать идентификатор заказа
};

const secret_key = ''; // Здесь нужно указать ваш секретный ключ
const public_key = ''; // Здесь нужно указать ваш публичный ключ

// Преобразование параметров запроса в строку JSON
const payload_str = JSON.stringify(params);

// Создание подписи запроса
const XApiSignature = crypto
  .createHmac('sha256', secret_key)
  .update(payload_str)
  .digest('hex');

// Формирование заголовков запроса
const headers = {
  timestamp: String(Date.now() / 1000),
  'x-api-public-key': public_key,
  'x-api-signature': XApiSignature,
  'Content-type': 'application/json',
};

// Формирование полного URL для создания инвойса
const url = base_url + 'api/v2/kassa/invoice/create';

// Отправка POST-запроса для создания инвойса
axios
  .post(url, params, { headers })
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error);
  });

curl -X POST -H "timestamp: <timestamp_value>" \
-H "x-api-public-key: <public_key_value>" \
-H "x-api-signature: <XApiSignature_value>" \
-H "Content-type: application/json" \
-d '{
    "api_token": "<api_token_value>",
    "kassa_id": "<kassa_id_value>",
    "amount": "<amount_value>",
    "order_id": "<order_id_value>"
}' "https://mayfpay.top/api/v2/kassa/invoice/create"

{"success":false, "error":"...", "time":"..."}

{
'success': true, 
'Id': ...,
'OrderId':'...',
'StatusTransaction': 0,
'KassaId': ...,
'Amount': ...,
'Currency': '...',
'AccountAmount': ...,
'RecipientTotalAmount': ...,
'PayyerTotalAmount': ...,
'FeeOn': ...,
'PayMethodId': '...',
'Comment': None,
'TransactionData': ...,
'DateOfCreateTransactions': '...',
'SuccessUrl': '...',
'UnSuccessUrl': '...',
'UrlTransaction':'',
'Sign': ...
}

1.7 Информация о счете

Предоставляет возможность получить подробную информацию о конкретном счете.

• URL метода: https://mayfpay.top/api/v2/kassa/invoice/check
• Метод: GET
• Content-Type: application/json
• Описание: Детальная информация о счете

Пример ответа

{
'success': true, 
'Id': ...,
'OrderId':'...',
'StatusTransaction': 0,
'KassaId': ...,
'Amount': ...,
'Currency': '...',
'AccountAmount': ...,
'RecipientTotalAmount': ...,
'PayyerTotalAmount': ...,
'FeeOn': ...,
'PayMethodId': '...',
'Comment': None,
'TransactionData': ...,
'DateOfCreateTransactions': '...',
'SuccessUrl': '...',
'UnSuccessUrl': '...',
'UrlTransaction':'',
'Sign': ...
}

1.6 Уведомления о платеже (CallBack)

Данное уведомление приходит после успешной оплаты в вашем магазине. Указать WebHook(Ссылку для уведомлений), можно в настройках магазина.

• Метод: POST
• Content-Type: application/json
• Описание: Callback функция для передачи информации об изменении статуса платежа

Пример ответа

{
'Id': ...,
'OrderId':'...',
'StatusTransaction': 0,
'KassaId': ...,
'Amount': ...,
'Currency': '...',
'AccountAmount': ...,
'RecipientTotalAmount': ...,
'PayyerTotalAmount': ...,
'FeeOn': ...,
'PayMethodId': '...',
'Comment': None,
'TransactionData': ...,
'DateOfCreateTransactions': '...',
'SuccessUrl': '...',
'UnSuccessUrl': '...',
'UrlTransaction':'',
'Sign': ...
'CBStatus': ...
}

1.8 Генерация подписи (SIGNATURE)

Генерация ключа, обязательный параметр. Он требуется для проверки платежа на уникальность и подтверждения, что переход к оплате был с вашего сайта. SIGNATURE ключ должен быть сгенерирован до отправки формы и введен в форму!

Метод шифрования: sha256

Пример генерации

# Example in Python
import hashlib

KassaId = ''
KassaSecretKey =''
Amount = ''
OrderId = ''

concatenated_string = ':'.join([KassaId, Amount, KassaSecretKey, OrderId])
sign = hashlib.sha256(concatenated_string.encode()).hexdigest()

# print(sign)

1.9 Эквайринг (H2H)

Метод H2H (Host To Host) — оптимальное решение для эффективной интеграции.