CAcabify
parcels

Add a tip for a parcel delivery.

Note: This feature is not available to all clients. Please contact us before using it.

Adds a tip for the driver in the event of a successful delivery. The tip can be set at any point before the parcel is delivered. The tip amount must be formatted according to ISO 4217 (e.g. €6.30 → 630 in EUR).

post/v1/parcels/{parcel_id}/tip

Request

  • Base URL
    https://logistics.api.cabify-sandbox.com
  • URL
    https://logistics.api.cabify-sandbox.com/v1/parcels/{parcel_id}/tip
  • Auth
    HTTP bearer

Path parameters

parcel_idstring uuid required

UUID of the parcel to tip.

Request body

amountinteger required

Tip amount in the smallest currency unit, following the ISO 4217 standard (e.g. €6.30 → 630).

Example request

{
  "amount": 100
}

Response

Tip created successfully.

parcel_idstring uuid

UUID of the parcel this tip is associated with.

amountinteger

Tip amount in the smallest currency unit, following the ISO 4217 standard (e.g. €6.30 → 630).

currencystring

ISO 4217 currency code.

Example response

{
  "parcel_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "amount": 100,
  "currency": "ARS"
}

Changes

No recorded changes to this operation across all 1 revision of this API.