Uber Developers

Refund Notification

WEBHOOK: POSThttps://<YOUR_WEBHOOK_URI> event_type: event.refund_request

A webhook of type event..refund_Request will be sent when a refund is requested for an order.

¶ Sample Webhook

The fields may vary based on different statuses and situations. For accurate field definitions, please refer to the Fields Definition and verify them on your own.

{
  "created": "2023-07-06T05:09:07.173Z",
  "data": {
    "created_at": "2023-07-06T05:09:07.173Z",
    "currency_code": "GBP",
    "id": "6817a070-115e-4ca9-8266-c245fe18a2d6",
    "refund_fees": [
      {
        "category": "DELIVERY",
        "fee_code": "UBER_DELIVERY_FEE",
        "value": 7500
      },
      {
        "category": "DELIVERY",
        "fee_code": "PARTNER_FEE",
        "value": 0
      },
      {
        "category": "TAX",
        "fee_code": "PARTNER_TAX",
        "value": 0
      }
    ],
    "refund_order_items": [
      {
        "partner_refund_amount": 4000,
        "party_at_fault": "UBER",
        "reason": "UBER_DAMAGED_ITEM",
        "refund_items": [
          {
            "name": "Donuts",
            "quantity": 1
          }
        ],
        "uber_refund_amount": 4000
      }
    ],
    "total_partner_refund": 4000,
    "total_uber_refund": 11500
  },
  "delivery_id": "del_G_8_eeo4Q5WrYpYkATt6SA",
  "external_id": "",
  "external_store_id": "Store abc",
  "id": "evt_nyNh-zBTR-uxdQjq5kYxhg",
  "kind": "event.refund_request",
  "live_mode": true
}

¶ Fields Definition

Field	Description
`created`	Timestamp indicating when the event was generated.
`delivery_id`	The identifier of the delivery the event applies to.
`data`	The webhook details. Please refer the Data Object Definition for more information.
`id`	Unique identifier for this event instance.
`kind`	The kind of event in more detail (event.courier_update).
`live_mode`	Flag indicating if the event applies to a live vs a test delivery.
`external_store_id`	Unique identifier used by partner to refer a store or location.
`external_id`	Unique identifier used by your partner to refer a delivery.

¶ Data Object Definition

The data object contains more detailed information about the webhook.

Field	Description
`id`	Unique identifier of the refund request.
`created_at`	Date/Time at which the refund webhook was created.
`currency_code`	Three-letter ISO currency code, in uppercase i.e. USD.
`total_partner_refund`	Total monetary amount that the partner is liable to their customers in cents ( ¹/₁₀₀ of currency unit ) i.e.: 1234.
`total_uber_refund`	Total monetary amount that Uber will adjust on the billing details report & invoice in cents ( ¹/₁₀₀ of currency unit ) i.e.: 1834.
`refund_fees.fee_code`	`UBER_DELIVERY_FEE`: This is the fee collected by Uber Direct from the partner for this given order. `PARTNER_FEE`: This is the fee collected by the partner from the end customer for this given order. `PARTNER_TAX`: This is the tax collected by the partner from the end customer for this given order.
`refund_fees.value`	The amount of the refund fee of the given category.
`refund_fees.category`	`DELIVERY`: Delivery related fees. `TAX`: Tax related fees.
`refund_order_items.refund_items.name`	Name of the item.
`refund_order_items.refund_items.quantity`	Quantity of the item.
`refund_order_items.party_at_fault`	Value will be `UBER` or `PARTNER`.
`refund_order_items.partner_refund_amount`	The monetary value of items that the partner is liable towards their customers in cents ( ¹/₁₀₀ of currency unit ). i.e.: $10.99 => 1099.
`refund_order_items.uber_refund_amount`	The monetary value of items that Uber will adjust on the billing details report & invoice in cents ( ¹/₁₀₀ of currency unit ). i.e.: $10.99 => 1099.
`refund_order_items.reason`	Predefined string of refund reasons. Possible values could include: `PARTNER_NEVER_RECEIVED_ORDER` `PARTNER_ENTIRE_ORDER_WRONG` `PARTNER_MISSING_ITEMS` `PARTNER_DAMAGED_ITEM` `PARTNER_ORDER_DELIVERED_LATE` `PARTNER_HAD_TO_PREPARE_ORDER_AGAIN` `PARTNER_RETURN_TRIP_ISSUE` `PARTNER_NEVER_PICK_UP` `PARTNER_SAFETY_ISSUE` `UBER_NEVER_RECEIVED_ORDER` `UBER_ENTIRE_ORDER_WRONG` `UBER_MISSING_ITEMS` `UBER_DAMAGED_ITEM` `UBER_ORDER_DELIVERED_LATE` `UBER_HAD_TO_PREPARE_ORDER_AGAIN` `UBER_RETURN_TRIP_ISSUE` `UBER_NEVER_PICK_UP` `UBER_SAFETY_ISSUE` `REFUND_REJECTED`