api REST API — документація

key Автентифікація

API використовує JWT Bearer Token. Отримайте токен через /api/v1/auth/token/ і передавайте його у заголовку кожного запиту:

Authorization: Bearer <access_token>

{
  "username": "your_username",
  "password": "your_password"
}

{
  "access":  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

{
  "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

{
  "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

{}

point_of_sale Термінали

{
  "name":  "Основна каса",
  "is_active":     true,
  "show_payments": true
}

{
  "id": 3,
  "name": "Основна каса",
  "merchant_id":   "Mexxxxxxxxxx",
  "merchant_name": "ФОП Іваненко І.І.",
  "edrpou":        "12345678",
  "is_active":     true,
  "show_payments": true,
  "created_at":    "2026-03-01T10:00:00Z",
  "updated_at":    "2026-03-05T12:30:00Z"
}

{
  "synced":       4,
  "merchant_name": "ФОП Іваненко І.І.",
  "merchant_id":   "Mexxxxxxxxxx"
}

qr_code QR-каси

Каси створюються автоматично через синхронізацію терміналів. Через API доступний лише перегляд.

{
  "id":           12,
  "terminal":     3,
  "terminal_name":"Основна каса",
  "qr_id":        "QRxxxxxxxxxx",
  "short_qr_id":  "QRxx",
  "name":         "Стійка №1",
  "is_active":    true,
  "created_at":   "2026-03-01T10:00:00Z",
  "updated_at":   "2026-03-05T12:30:00Z"
}

receipt_long Інвойси

{
  "terminal":   3,
  "destination":"Оплата замовлення №123",
  "reference":  "ORDER-123",
  "validity":   86400,
  "items": [
    { "name": "Кава Латте", "price": 8500, "quantity": 2, "unit": "шт" },
    { "name": "Тістечко",   "price": 4500, "quantity": 1, "unit": "шт", "discount_pct": 10 }
  ]
}

{
  "terminal":    3,
  "amount":      25000,
  "destination": "Оплата послуг"
}

{
  "id":             42,
  "number":         17,
  "number_display": "00017",
  "invoice_id":     "2304xxxxxxxx",
  "status":         "created",
  "status_display": "Створено",
  "terminal":       3,
  "terminal_name":  "Основна каса",
  "cash_register":  null,
  "amount":         25000,
  "ccy":            980,
  "final_amount":   null,
  "reference":      "ORDER-123",
  "destination":    "Оплата послуг",
  "comment":        "",
  "page_url":       "https://pay.mbnk.biz/230400xxxx",
  "failure_reason": "",
  "masked_pan":     "",
  "approval_code":  "",
  "rrn":            "",
  "payment_system": "",
  "fee":            0,
  "created_locally":true,
  "webhook_received":false,
  "created_date":   "2026-03-05T10:00:00Z",
  "modified_date":  null,
  "paid_date":      null,
  "is_cancellable": true,
  "items": []
}

category Категорії товарів

{
  "name": "Напої"
}

{
  "id":         5,
  "name":       "Напої",
  "created_at": "2026-03-01T10:00:00Z",
  "updated_at": "2026-03-05T12:30:00Z"
}

straighten Одиниці виміру

{
  "name":       "Кілограм",
  "short_name": "кг"
}

{
  "id":         3,
  "name":       "Кілограм",
  "short_name": "кг",
  "created_at": "2026-03-01T10:00:00Z",
  "updated_at": "2026-03-05T12:30:00Z"
}

inventory_2 Товари

{
  "id":           17,
  "name":         "Кава Латте",
  "name_for_docs":"",
  "code":         1,
  "article":      "LATTE-200",
  "external_code":"",
  "category":     5,
  "category_name":"Напої",
  "unit":         3,
  "unit_name":    "Кілограм",
  "price":        8500,
  "is_archived":  false,
  "created_at":   "2026-03-01T10:00:00Z",
  "updated_at":   "2026-03-05T12:30:00Z"
}

group Співробітники

{
  "id":                   8,
  "username":             "kasir_ivan",
  "email":                "ivan@example.com",
  "full_name":            "Іван Петренко",
  "position":             "Касир",
  "can_view_invoices":    true,
  "can_create_invoices":  true,
  "can_cancel_invoices":  false,
  "can_manage_terminals": false,
  "can_manage_employees": false,
  "is_active":            true,
  "created_at":           "2026-03-01T10:00:00Z",
  "updated_at":           "2026-03-05T12:30:00Z"
}

bar_chart Статистика

{
  "total_count":       158,
  "success_count":      94,
  "created_count":      12,
  "expired_count":      38,
  "failure_count":      14,
  "total_amount":   285000,
  "success_amount": 195000,
  "unpaid_amount":   90000
}

error_outline Пагінація та коди відповідей

{
  "count":    158,
  "next":     "https://mmpay.com.ua/api/v1/invoices/?page=2",
  "previous": null,
  "results":  [ ... ]
}

{
  "detail": "Помилка валідації.",
  "errors": {
    "terminal": ["Це поле обов'язкове."],
    "items": [
      { "price": ["Ensure this value is greater than or equal to 0."] }
    ]
  }
}

{
  "detail": "Не знайдено."
}

{
  "detail":   "Невірний токен",
  "err_code": "INVALID_TOKEN"
}

speed Обмеження запитів (Rate Limiting)

Для захисту від зловживань API використовує обмеження кількості запитів на хвилину.

{
  "detail": "Request was throttled. Expected available in 23 seconds."
}