Оплата по токену

Створення платежу за токеном картки

HEADER PARAMETERS:

  • X-Token

    required

    string

    Токен з особистого кабінету https://web.monobank.ua/ або тестовий токен з https://api.monobank.ua/

  • X-Cms

    string

    Назва CMS, якщо ви розробляєте платіжний модуль для CMS

  • X-Cms-Version

    string

    Версія CMS, якщо ви розробляєте платіжний модуль для CMS

REQUEST BODY SCHEMA: application/json

  • cardToken

    required

    string

    Токен картки

  • amount

    required

    integer

    Сума у мінімальних одиницях

  • ccy

    required

    integer

    ISO 4217 код валюти

  • redirectUrl

    string

    Адреса для повернення (GET) - на цю адресу буде переадресовано користувача за умови проведення 3DS

  • webHookUrl

    string

    Адреса для CallBack (POST) – на цю адресу буде надіслано дані про стан платежу при зміні статусу, окрім статусу expired. Зміст тіла запиту ідентичний відповіді запиту “Статус рахунку”. Гарантії доставки повідомлень одне за одним не надається. Тобто, може бути ситуація, коли вебхук про успішну оплату (status=success) прийде раніше за вебхук про обробку цієї оплати (status=processing). Краще орієнтуватись на поле modifiedDate при аналізі поточного статусу рахунку. Вебхук із більшим modifiedDate буде актуальним

  • initiationKind

    required

    string

    Тип проведення платежу:

    merchant - платіж з ініціативи мерчанта, наприклад, регулярний платіж — коли клієнт не бере участі у підтвердженні платежу

    client - платіж за вимогою клієнта, наприклад, клієнт виконує оплату зі збереженої картки

  • merchantPaymInfo

    object (MerchantPaymInfoItem)

    Інформаційні дані замовлення, яке буде оплачуватись. Обовʼязково вказувати при активній звʼязці з ПРРО (звʼязка створюється у веб-кабінеті https://web.monobank.ua)

    merchantPaymInfo {

    • reference

      string

      Номер чека, замовлення, тощо; визначається мерчантом

    • destination

      string

      Призначення платежу

    • comment

      string

      Службове інформаційне поле

    • customerEmails

      array of string

      Масив пошт, на які потрібно відправити фіскальний чек, якщо у мерчанта активна звʼязка з checkbox

      customerEmails [

      • item

        string

    • discounts

      array of object

      Масив знижок або надбавок на всю корзину, які будуть передані в checkbox для фіскалізації, якщо звʼязку з checkbox активовано

      discounts [

      • type

        required

        string

        Тип знижки або надбавки

        DISCOUNT — знижка

        EXTRA_CHARGE — надбавка

      • mode

        required

        string

        Режим знижки або надбавки

        PERCENT — відсоток від basketOrder.sum * basketOrder.qty

        VALUE — числове значення

      • value

        required

        number

        Значення, яке буде фігурувати в розрахунках

    • basketOrder

      array of object

      Склад замовлення, використовується для відображення кошика замовлення, обовʼязково вказувати при активній звʼязці з ПРРО (звʼязка створюється у веб-кабінеті https://web.monobank.ua)

      basketOrder [

      • name

        required

        string

        Назва товару

      • qty

        required

        number

        Кількість одиниць товару

      • sum

        required

        integer

        Сума у мінімальних одиницях валюти за одиницю товару; якщо ви торгуєте табуретками, ціна якої 21 гривня, і у вас замовлення на 2 табуретки, то qty=2, sum=2100, amount=4200, total=4200

      • total

        integer

        Сума у мінімальних одиницях валюти за всю кількість товарів; якщо ви торгуєте табуретками, ціна якої 21 гривня, і у вас замовлення на 2 табуретки, то qty=2, sum=2100, amount=4200, total=4200

      • icon

        string

        Лінк на зображення товару

      • unit

        string

        Назва одиниці вимiру товару

      • code

        required

        string

        Код товару, обов’язковий для фіскалізації

      • barcode

        string

        Значення штрих-коду, може бути потрібно для фіскалізації

      • header

        string

        Текст, що передує назві товару, може бути потрібний для фіскалізації

      • footer

        string

        Текст, після товару, може бути потрібний для фіскалізації

      • tax

        array of integer

        Масив податкових ставок, які було обрано на порталі Checkbox при реєстрації каси. При використанні ПРРО monopay податкові ставки наразі не застосовуються

        tax [

        • item

          integer

      • uktzed

        string

        Код УКТ ЗЕД

      • discounts

        array of object

        Масив знижок або надбавок на цю позицію в корзині, які будуть передані в checkbox для фіскалізації, якщо звʼязку з checkbox активовано

        discounts [

        • type

          required

          string

          Тип знижки або надбавки

          DISCOUNT — знижка

          EXTRA_CHARGE — надбавка

        • mode

          required

          string

          Режим знижки або надбавки

          PERCENT — відсоток від basketOrder.sum * basketOrder.qty

          VALUE — числове значення

        • value

          required

          number

          Значення, яке буде фігурувати в розрахунках

  • paymentType

    string

    Тип операції. Для значення hold термін складає 9 днів. Якщо через 9 днів холд не буде фіналізовано — він скасовується

post

/api/merchant/wallet/payment

Request samples
Payload
200 Дані платежу
400 Один із вхідних параметрів невалідний
403 Токен невалідний
405 Http-метод невалідний
429 Занадто багато запитів
500 Під час виконання запиту виникла непередбачена помилка
Response samples
200
400
403
405
429
500
Список карток у гаманці