Перейти до основного вмісту

Передача платежу / повернення коштів у SmartPay​

інформація

SmartPay — модуль для роботи з платіжним терміналом під час продажу.

SmartConnect — локальний модуль, який приймає запит і передає його в CashDesk.

use_terminal = true — параметр, що вмикає оплату через термінал.

payments.code = 1 — безготівковий тип оплати (картка/термінал).

Повний глосарій термінів

Метод використовується для проведення операцій продажу та повернення коштів через термінал SmartPay за допомогою SmartConnect.

URI: /api/v2/check/sale?api_token={api_token}

Запит виконується методом POST з тілом запиту у JSON форматі.

⚠️ Запит повинен містити заголовки Accept: application/json та Content-Type: application/json

інформація

Для передачі оплати в SmartPay необхідно додати параметр use_terminal = true, а в масиві payments передати безготівковий метод оплати (code = 1).

Параметри запиту​

Детальний опис параметрів запиту наведено на сторінці Реалізація / Повернення.

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

{
  "api_token": "42b5eaccba739f08***e7fe157eba8bf",
  "num_fiscal": 4000022469,
  "action_type": "Z_SALE",
  "local_number": 1022,
  "total_sum": 50.0,
  "round_sum": 0.0,
  "round_rule": 10,
  "use_terminal": true,
  "products": [
    {
      "letters": "А",
      "tax_prc": "20",
      "excise_prc": "5",
      "excise_letter": null,
      "code": "821",
      "unit_code": "2009",
      "unit_name": "штука",
      "name": "Вода питна",
      "uktzed": 4823004003572,
      "amount": "1",
      "price": "50.00",
      "cost": "50.00",
      "sum_discount": "0"
    }
  ],
  "payments": [
    {
      "code": 1,
      "name": "KARTKA",
      "payment_method": "БЕЗГОТІВКОВА",
      "sum": 50.0,
      "sum_provided": 50.0
    }
  ],
  "footer": "This is my\n custom footer! Welcome to CashDesk! \n Test \n Next line text!",
  "open_shift": true,
  "print_width": 32,
  "pdf_width": 48
}

Обробка оплати через термінал​

Після успішної оплати через термінал система SmartPay додає інформацію про транзакцію.
SmartConnect додає ці дані в запит і відправляє його в CashDesk.

Приклад запиту з даними термінала​

{
  "api_token": "42b5eaccba739f08***e7fe157eba8bf",
  "num_fiscal": 4000022469,
  "action_type": "Z_SALE",
  "local_number": 1022,
  "total_sum": 50.0,
  "round_sum": 0.0,
  "round_rule": 10,
  "use_terminal": true,
  "products": [
    {
      "letters": "А",
      "tax_prc": "20",
      "excise_prc": "5",
      "excise_letter": null,
      "code": "821",
      "unit_code": "2009",
      "unit_name": "штука",
      "name": "Вода питна",
      "uktzed": 4823004003572,
      "amount": "1",
      "price": "50.00",
      "cost": "50.00",
      "sum_discount": "0"
    }
  ],
  "payments": [
    {
      "code": 1,
      "name": "KARTKA",
      "payment_method": "БЕЗГОТІВКОВА",
      "sum": 50.0,
      "sum_provided": 50.0,
      "pay_terminal": {
        "comission": 0.5,
        "name": "493084867",
        "terminal_id": "40904582",
        "epz": "4149XXXXXXXX5807",
        "card_type": "VISA GOLD",
        "auth_code": "538296",
        "rrn": "000018706638",
        "additional_text": "Тримач ЕПЗ - підпис",
        "time": "03.04.2023 15:15:03"
      }
    }
  ],
  "footer": "This is my\n custom footer! Welcome to CashDesk! \n Test \n Next line text!",
  "open_shift": true,
  "print_width": 32,
  "pdf_width": 48
}

Приклади відповіді​

Успішні та неуспішні відповіді​

Приклади успішних і неуспішних відповідей сервера наведено в статті Реалізація / повернення.

Потрібно більше пояснень?

Перегляньте глосарій термінів CashDesk, де простими словами пояснені основні терміни.