For the complete documentation index, see llms.txt. This page is also available as Markdown.

COD (cash on delivery)

Чекліст допомагає самостійно перевірити, чи коректно налаштована передача параметрів COD в API.

COD / Оплата при отриманні — це послуга, яка дозволяє оплачувати товар під час отримання відправлення. Через API послуга додається як додатковий сервіс до відправлення у блоці services з кодом serviceCode: "COD".

Перед запуском інтеграції потрібно підписати договір з NovaPost на використання послуги COD.

Для використання сервісу треба заповнити наступні обов’язкові поля:

Назва
Опис поля

serviceCode

Код сервісу, що вказує на наявність послуги «Оплата при отриманні».

Завжди "COD" для даного типу оплати.

amount

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

  • у блоці services — як загальна сума COD;

  • у блоці bankAccount — як сума для перерахування на рахунок.

contractNumber

Якщо існує кілька договорів, необхідно вказати той що потрібно.

payerType

Визначає платника послуги, у прикладі це одержувач.

currencyCode

Валюта транзакції. Визначається за договором відправника.

bankAccountId

Ідентифікаційний податковий номер або еквівалентний ідентифікатор (ЄДРПОУ, ІПН, NIP, IČO). Значення поля CompanyTin відправника юридичної особи.

bankAccountName

IBAN

commissionPayer

Визначає платника комісії COD: Одержувач/Відправник.

Приклад:

"services": [
  {
    "shipmentParcelRowNumber": null,
    "serviceCode": "COD",
    "amount": 10,
    "contractNumber": null,
    "payerType": "Recipient",
    "additionalParameters": {
      "cod": {
        "cash": null,
        "card": null,
        "bankAccount": {
          "amount": 10,
          "currencyCode": "PLN",
          "bankAccountId": "1234567890",
          "bankAccountName": "PL12345678901234567890123456",
          "description": "test S",
          "commissionPayer": "Recipient"
        }
      }
    }
  }
]

Last updated