logo
API docs by Redocly

Інструкція з інтеграції API для створення замовлення на веб-сайті (106)

Download OpenAPI specification:Download

Дана інструкція надає докладне керівництво для розробників веб-сайтів з інтеграції виклику API для створення замовлення на боці мерчанта та передачі інформації в чекаут

Створення замовлення

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

header Parameters
X-Token
required
string

токен з https://web.monobank.ua (натисніть «Інтернет» -> «Управління еквайрингом» -> Створіть токен і дотримуйтесь інструкцій)

Content-Type
string

application/json

Request Body schema: application/json
required
order_ref
required
string

ID замовлення або ID корзини замовлення, який формується мерчантом

amount
required
number

Загальна сума замовлення

ccy
number

Цифровий ISO-код валюти (за замовчуванням 980 - грн.)

count
required
number

Кількість товарів у чеку

required
Array of objects

Масив товарів у замовленні, кожен товар має наступні параметри

dlv_method_list
Array of strings

Масив доступних способів доставки для замовлення pickup - самовивіз, courier - кур'єр, np_brnm - Нова Пошта(відділення), np_box - Нова Пошта(поштомати))

payment_method_list
Array of strings

Масив доступних способів оплати для замовлення card - карта, payment_on_delivery - оплата при доставці, part_purchase - Покупка частинами

dlv_pay_merchant
boolean

Флаг оплати доставки магазином (за замовчуванням - оплачує клієнт)

payments_number
number

Кількість платежів покупки частинами (обов'язково для payment_methods=["part_purchase"]) мінімум 3 частини, іначе ПЧ не відображаеться

callback_url
string

урл, куди буде повертатись інформація по замовленню

return_url
string

урл, куди буде повертатись клієнт - після замовлення

hold
boolean

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

Responses

Request samples

Content type
application/json
{
  • "order_ref": "NhSI1WhoFTKn",
  • "amount": 320,
  • "ccy": 980,
  • "count": 1,
  • "products": [],
  • "dlv_method_list": [
    ],
  • "payment_method_list": [
    ],
  • "dlv_pay_merchant": false,
  • "payments_number": 3,
  • "callback_url": "https://your-site.com/callback",
  • "return_url": "https://your-site.com/",
  • "hold": true
}

Response samples

Content type
application/json
{}

Отримання статусу замовлення по ід

path Parameters
order_ref
string

ІД замовлення

header Parameters
X-Token
required
string

токен з https://web.monobank.ua (натисніть «Інтернет» -> «Управління еквайрингом» -> Створіть токен і дотримуйтесь інструкцій)

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Інформацією про замовлення

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}