Cash on Delivery

Used to define payment transactions to be collected from the recipient during consignment delivery.

Service Information

  • Service Type: CASH_ON_DELIVERY
  • Description: Enables collection of the specified amount from the recipient when the consignment is delivered

Details Parameters

Parameter Type Required Description
amount float/integer Yes Payment amount to be collected from the recipient
accountNumber string No Postal check number used for PTT shipments

Usage

{
    "special_services": [
        {
            "service_type": "CASH_ON_DELIVERY",
            "details": {
                "amount": 134.52,
                "accountNumber": "12312312"
            }
        }
    ]
}

Important Notes

  • The amount parameter can be sent as an integer or decimal number
  • The accountNumber parameter is only used for PTT shipments
  • Not every carrier may support cash on delivery service

Example Usages

// Basic usage
{
    "service_type": "CASH_ON_DELIVERY",
    "details": {
        "amount": 100.50
    }
}

// Usage for PTT
{
    "service_type": "CASH_ON_DELIVERY",
    "details": {
        "amount": 150,
        "accountNumber": "12345678"
    }
}