Укр
Оплата послуг доставки
integration

Оплата послуг доставки через API Nova Post

API Nova Post дозволяє налаштувати готівкові та безготівкові платежі за послуги доставки. Процес оплати можна налаштувати під різноманітні випадки, адже методи оплати забезпечують можливість оплати з боку відправника, отримувача або третьої особи.

Методи оплати за послуги доставки

API підтримує три основних типи платників послуг доставки: відправник, одержувач, третя особа.

  • Оплата відправником

    Можливі способи оплати залежать від статуса клієнта, якщо відправник:

    • 1
      Приватна особа: оплата здійснюється онлайн через застосунок, готівкою або карткою при передачі відправлення в Nova Post.
    • 2
      Бізнес-клієнт, що має договір з Nova Post: безготівкова оплата за умовами договору з Nova Post або готівкою/карткою при передачі відправлення.

    Доступно за всіма напрямками доставки.

  • Оплата одержувачем

    Одержувач оплачує вартість доставки при отриманні відправлення*. Якщо одержувач:

    • 1
      Приватна особа: онлайн через застосунок, готівкою або картою у відділенні.
    • 2
      Бізнес-клієнт, що має договір з Nova Post: безготівкова оплата за умовами договору з Nova Post або готівкою/карткою під час отримання.

    *Оплата одержувачем наразі доступна не для всіх напрямків доставки в Європі. Для уточнення можливості оплати одержувачем за вашим напрямком доставки зверніться до свого менеджера.

  • Оплата третьою особою

    Платник послуги – юридична особа, яка має контракт з NovaPost, відповідні дозволи на сплату послуг як третя особа та не є при цьому ані відправником, ані одержувачем.

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

    Для підключення цієї можливості клієнтам необхідно звернутися до свого менеджера в NovaPost.

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

payerType визначає, хто відповідальний за оплату послуг доставки. Можливі значення:

  • 1
    Sender: Відправник оплачує доставку
  • 2
    Recipient: Отримувач оплачує доставку
  • 3
    ThirdPerson: Оплату здійснює третя сторона

    При виборі цього варіанту потрібно заповнити поле payerContractNumber.

payerContractNumber: є обов'язковим:

  • 1
    коли обрано ThirdPerson як тип платника. Воно має містити номер контракту платника. Для клієнтів з України можна вказати ідентифікаційний код (ЄДРПОУ) замість номера контракту.
  • 2
    коли обрано Sender/Recipient як тип платника і використовується безготівковий спосіб оплати. Якщо ця інформація не буде надана, оплата автоматично перемикається на готівкову.

Забезпечте коректність введеної інформації, оскільки вона є важливою для правильного оброблення платежу. Це дозволить вам успішно інтегрувати оплату третьою особою у ваші API-запити та забезпечити гнучкість при здійсненні оплат за доставку.

Детальну інформацію про ці поля можна знайти у вкладці Schema, натиснувши на Multiline description поруч з параметрами.

Кроки для доступу до документації API на порталі з документацією: Створення відправлень → Shipment → Create documents.

Приклади запитів

  • Приклад запиту для оплати відправником

    {
      "status": "ReadyToShip",
      "clientOrder": "1234567890",
      "note": "Documents shipment",
      "payerType": "Sender",               // Платником виступає відправник
      "payerContractNumber": "123456789",  // Контрактний номер відправника для безготівкової оплати
      "invoice": {
        "incoterm": "DAP",
        "currencyCode": "EUR",
        "totalCost": 500.00
      }
    }

    Опис полів:

    • 1
      payerType: "Sender" — визначає, що платником є відправник
    • 2
      payerContractNumber — контрактний номер відправника для безготівкової оплати
    • 3
      invoice —  об'єкт, що містить деталі інвойсу, включаючи incoterm та валюту

  • Приклад запиту для оплати отримувачем

    {
      "status": "ReadyToShip",
      "clientOrder": "0987654321",
      "note": "Books delivery",
      "payerType": "Recipient",            // Платником виступає отримувач
      "invoice": {
        "incoterm": "DAP",
        "currencyCode": "USD",
        "totalCost": 300.00
      }
    }

    Опис полів:

    • 1
      payerType: "Recipient" — визначає, що платником є отримувач
    • 2
      invoice — об'єкт, що містить деталі інвойсу для митного оформлення.

  • Приклад запиту для оплати третьою особою

    {
      "status": "ReadyToShip",
      "clientOrder": "1122334455",
      "note": "Electronics shipment",
      "payerType": "ThirdPerson",          // Платником виступає третя особа
      "payerContractNumber": "987654321",  // Номер контракту третьої особи для безготівкової оплати
      "invoice": {
        "incoterm": "DAP",
        "currencyCode": "EUR",
        "totalCost": 1000.00
      }
    }

    Опис полів:

    • 1
      payerType: "ThirdPerson" — визначає, що платником є третя особа.
    • 2
      payerContractNumber —  номер контракту третьої особи, яка здійснюватиме оплату.

      Це поле є обов'язковим, коли обрано ThirdPerson як тип платника. Воно має містити номер контракту платника. Для клієнтів з України можна вказати ідентифікаційний код (ЄДРПОУ) замість номера контракту.

Деталі щодо кожного з параметрів та додаткових можливостей можна знайти у документації API.

Інтегруйте функції оплати у свої системи та надайте клієнтам комфортний сервіс.