メインコンテンツへスキップ

Webhooks for refunds

When a refund is initiated by DoorDash, a merchant / developer, a customer, or a Dasher, a refund webhook will be fired.

API: Drive

This doc covers the Drive API. If you're using the Drive API, see the reference guide for Drive (classic) refund webhooks.

The refund webhook may contain item-level information if the issue is related to missing or incorrect items. Only deliveries that include information about the items in the delivery (via the items field are eligible for item-level refunds.

Refunds may be provided as an amount or a percentage.

Fields

event dataTypeDescription
reasonStringReason for the refund of the delivery
reason_commentsStringReason details
amountIntTotal refund back to merchant
currency_codeString3 digit currency code
amount_detailsObjectAn object with the details of the refund amounts/percentages
customer_refund_detailsStringAn object with the details of the refund amounts/percentages (only for support-as-a-service (SaaS) merchants)
amount_details object dataTypeDescription
order_valueInt
tipInt
delivery_chargeInt
additional_amountInt
itemsObjectAn object with the details of the individual items and any applicable refunds
items object dataTypeDescription
nameString
barcodeString
quantityInt
external_idString
amountInt
reasonString
reason_commentsString

Example payloads

Refund with amount

{
"event_data": {
"reason": "item_level_refund",
"reason_comments": "",
"amount": "0",
"currency_code": "USD",
"amount_details": {
"order_value": 0,
"tip": 0,
"delivery_charge": 0,
"additional_amount": 0,
"items": [
{
"name": "Chicken burrito with extra chicken",
"barcode": "12342830041",
"quantity": 1,
"external_id": "123-123443434b",
"amount": 0,
"reason": "missing_incorrect_item",
"reason_comments": "item_level_missing"
}
]
},
"order_details": {
"order_value": 2500,
"tip": 300,
"delivery_charge": 599
},
"customer_refund_details": {
"itemRefunds": {
"items": [
{
"name": "Chicken burrito with extra chicken",
"barcode": "12342830041",
"quantity": 1,
"external_id": "123-123443434b",
"amount": 850
}
]
}
}
}
}

Refund with percentage

{
"event_data": {
"reason": "delivered_late",
"reason_comments": "order_ready_dasher_late_time_period_1",
"amount": "750",
"currency_code": "USD",
"amount_details": {
"order_value": 750,
"tip": 0,
"delivery_charge": 0,
"additional_amount": 0
},
"order_details": {
"order_value": 5000,
"tip": 200,
"delivery_charge": 599
},
"customer_refund_details": {
"percentageRefunds": {
"order_value_percent": 15,
"tip_percent": 0,
"delivery_charge_percent": 0
}
}
}
}