Синхронна оплата

Апі для синхронної оплати, доступ до апі надається через службу турботи та вимагає наявності певного ряду сертифікатів. Один із обʼєктів cardData, applePay, googlePay є обовʼязковим

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

  • amount

    required

    integer

    Сума оплати у мінімальних одиницях (копійки для гривні)

  • ccy

    required

    integer

    ISO 4217 код валюти, за замовчуванням 980 (гривня)

  • merchantPaymInfo

    object

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

    merchantPaymInfo {

    • reference

      string

      Номер чека, замовлення, тощо, який було вказано мерчантом при створенні рахунку

    • destination

      string

      Призначення платежу, визначається продавцем

  • cardData

    object

    Дані для оплати карткою

    cardData {

    • pan

      required

      string

      Номер картки

    • type

      required

      string

    • exp

      required

      string

      Термін дії картки у форматі mmyy

    • cvv

      string

      Cvv

    • eciIndicator

      required

      string

      Electronic Commerce Indicator, значення результату аутентифікації

    • cavv

      string

      Cardholder Authentication Verification Value

    • tavv

      string

      Token authentication verification value

    • dsTranId

      string

      XID (DSTranID)

    • tReqID

      string

      Token requestor ID

    • mit

      string

      Merchant Initiated Transaction Indicator

      1 - Merchant Initiated Transaction

      2 - Customer Initiated Transaction

    • sst

      number

      Subsequent Transaction

    • tid

      string

      Trace Id (ID first operation)

  • applePay

    object

    Дані з криптоконтейнеру Apple Pay

    applePay {

    • token

      required

      string

      Токен картки

    • exp

      required

      string

      Термін дії картки у форматі mmyy

    • eciIndicator

      required

      string

      Electronic Commerce Indicator, значення результату аутентифікації

    • cryptogram

      string

      TAVV криптограма

  • googlePay

    object

    Дані з криптоконтейнеру Google Pay

    googlePay {

    • token

      required

      string

      Токен картки

    • exp

      required

      string

      Термін дії картки у форматі mmyy

    • eciIndicator

      required

      string

      Electronic Commerce Indicator, значення результату аутентифікації

    • cryptogram

      string

      TAVV криптограма

post

/api/merchant/invoice/sync-payment

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