Eng
Payment for delivery
integration

Payment for Delivery Services via Nova Post API

The Nova Post API allows you to configure both cash and non-cash payments for delivery services. The payment process can be customized for various scenarios, as payment methods support payments made by the sender, the recipient, or a third party.

Payment Methods for Delivery Services

The API supports three main types of payers for delivery services: sender, recipient, third party

  • Payment by the Sender

    The available payment methods depend on the customer's status. If the sender is:

    • 1
      An individual: Payment can be made online through the app, or in cash or by card when handing over the shipment to Nova Post.
    • 2
      A business client with a contract with Nova Post: Payment can be made via non-cash payment under the terms of the contract with Nova Post, or in cash/card when handing over the shipment.

    This option is available for all delivery destinations.

  • Payment by the Recipient

    The recipient pays the delivery cost upon receiving the shipment*: If the recipient is:

    • 1
      An individual: Payment can be made online through the app, or in cash or by card at the branch.
    • 2
      A business client with a contract with Nova Post: Payment can be made via non-cash payment under the terms of the contract with Nova Post, or in cash/card upon receipt.

    *Recipient payment is not currently available for all European delivery destinations. Please contact your account manager to find out if cash on delivery is available for your delivery destination.

  • Payment by a Third Party

    The payer is a legal entity that has a contract with Nova Post and the appropriate permissions to pay for services as a third party. This payer is neither the sender nor the recipient.

    The third party can be designated as the payer either by the company creating the shipment on behalf of its clients, or by clients who have an agreement with the legal entity to cover delivery costs. This service is convenient for corporate clients, partners, or marketplaces that want to cover delivery costs for their clients or partners.

    To enable this option, clients must contact their Nova Post manager.

Field Descriptions for Configuring the Payment Method

payerType defines who is responsible for paying for delivery services. Possible values:

  • 1
    Sender: The sender pays for the delivery
  • 2
    Recipient: The recipient pays for the delivery
  • 3
    ThirdPerson: A third party pays for the delivery

    If this option is selected, the payerContractNumber field must be filled in.

payerContractNumber is mandatory:

  • 1
    When ThirdPerson is selected as the payer type. It must contain the payer's contract number. For clients from Ukraine, it is also acceptable to provide the tax identification number (EDRPOU) instead of the contract number.
  • 2
    When Sender or Recipient  is selected as the payer type, and a non-cash payment method is used. If this information is not provided, the payment method will automatically default to cash.

Ensure that the entered information is accurate, as it is essential for processing the payment correctly. This will allow you to successfully integrate third-party payments into your API requests and provide flexibility in managing delivery payments.

Detailed information about these fields can be found in the Schema tab by clicking on the Multiline description next to the parameters.

Steps to access the API documentation on the documentation portal: Shipment Creation → Shipment → Create documents.

Examples of Requests

  • Example request for payment by the sender

    {
      "status": "ReadyToShip",
      "clientOrder": "1234567890",
      "note": "Documents shipment",
      "payerType": "Sender",               // The payer is the sender
      "payerContractNumber": "123456789",  // The sender’s contract number for non-cash payment
      "invoice": {
        "incoterm": "DAP",
        "currencyCode": "EUR",
        "totalCost": 500.00
      }
    }

    Field descriptions:

    • 1
      payerType: "Sender" — defines that the payer is the sender.
    • 2
      payerContractNumber — the sender’s contract number for non-cash payment.
    • 3
      invoice —  An object that contains invoice details, including incoterm and currency.

  • Example request for payment by the recipient

    {
      "status": "ReadyToShip",
      "clientOrder": "0987654321",
      "note": "Books delivery",
      "payerType": "Recipient",            // The payer is the recipient
      "invoice": {
        "incoterm": "DAP",
        "currencyCode": "USD",
        "totalCost": 300.00
      }
    }

    Field descriptions:

    • 1
      payerType: "Recipient" — defines that the payer is the recipient.
    • 2
      invoice — an object that contains invoice details for customs clearance.

  • Example request for payment by a third party

    {
      "status": "ReadyToShip",
      "clientOrder": "1122334455",
      "note": "Electronics shipment",
      "payerType": "ThirdPerson",          // The payer is a third party
      "payerContractNumber": "987654321",  // The contract number of the third party for non-cash payment
      "invoice": {
        "incoterm": "DAP",
        "currencyCode": "EUR",
        "totalCost": 1000.00
      }
    }

    Field descriptions:

    • 1
      payerType: "ThirdPerson" — defines that the payer is a third party.
    • 2
      payerContractNumber —  The contract number of the third party who will make the payment.

      This field is mandatory when "ThirdPerson" is selected as the payer type. It must contain the payer’s contract number. For clients from Ukraine, it is also acceptable to provide the tax identification number (EDRPOU) instead of the contract number.

Details about each parameter and additional capabilities can be found in the API documentation. 

Integrate the payment features into your systems and provide a convenient service to your customers.