Отримання даних по комісії (Invoice showCommission)

Метод для отримання інформації щодо можливої суми комісії по створеному інвойсу.

URI

POST /api/invoicer/payments/showCommission

Запит:

Ключ	Опис	Тип	Обов'язковість	Приклад

Ключ	Опис	Тип	Обов'язковість	Приклад
params
sessionId	id сессії клієнта	string, uuid	так	"00684a7f-3d5c-43f4-b4d1-ea994226be9c"
invoiceId	id інвойсу	string, uuid	так	"6e391161-94ff-41a3-bd22-c6d77509bff6"
data
amount	сума платежу в копійках.	integer	так	`2300`

Параметр amount є обов'язковим, але враховується при розрахунку це поле лише для інвойсів з відкритою сумою. Для інших інвойсів сума не залежить від значення цього параметру і комісія буде розраховуватися від суми, вказаної при створенні інвойсу.

{
   "params": {
      "sessionId": "00684a7f-3d5c-43f4-b4d1-ea994226be9c",
      "invoiceId": ""6e391161-94ff-41a3-bd22-c6d77509bff6"
   },
   "data": {
      "amount": 50000
   }
}

Відповідь:

Ключ	Опис	Тип	Приклад

Ключ	Опис	Тип	Приклад
status	Статус. 0 - помилка, 1 - успіх	integer	1
data
commissionAmount	Сума комісії	integer	`102`
commission
percents	відсоток комісії	integer	2
fixed	фіксоване значення комісії	integer	100

{
    "status": 1,
    "data": {
        "commission": {
            "percents": 2,
            "fixed": 100
        },
        "commissionAmount": 1100
    }
}

Платіжна документація

Отримання даних по комісії (Invoice showCommission)

Related pages