COD (cash on delivery)

The checklist helps you independently verify whether COD parameter transmission in the API is configured correctly.

COD / Cash on Delivery is a service that allows payment for goods at the time of shipment delivery. Through the API, this service is added as an additional shipment service within the services block using serviceCode: "COD".

Before starting the integration, it is necessary to sign an agreement with NovaPost for using the COD service.\

To use the service, the following required fields must be completed:

Field name	Description
serviceCode	Service code indicating that the shipment includes the Cash on Delivery service. Always "COD" for this payment type.
amount	The total amount that the recipient must pay within the COD service. It is specified twice: in the services block — as the total COD amount; in the bankAccount block — as the amount to be transferred to the account.
contractNumber	If multiple contracts exist, the required one must be specified.
payerType	Defines the payer of the service; in this example, it is the recipient.
currencyCode	Transaction currency. It is determined according to the sender's contract.
bankAccountId	Tax identification number or equivalent identifier (EDRPOU, TIN, NIP, IČO). The value corresponds to the sender company's companyTin field.
bankAccountName	IBAN
commissionPayer	Defines the COD commission payer: Recipient / Sender.

Example:

"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"
        }
      }
    }
  }
]