Partner-Fault Refund Webhook Callback

post

https://example.com/partner-fault-refund

Beta

Sent by Deliveroo to your configured webhook endpoint when a partner-fault
refund has been applied to an order. The request is signed with the
x-deliveroo-sequence-guid and x-deliveroo-hmac-sha256 headers, which you
should use to verify authenticity before processing.

Acknowledge the callback with any 2xx status code. If we receive a non-2xx
response we treat it as a failure and retry the delivery.

See the Partner-Fault Refund Webhook guide
for signature verification, idempotency, responses, and retry behaviour.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

refund_id

string

Deliveroo's unique identifier for this refund. Use this as your idempotency key — deduplicate on this field (see Responding, failures & retries).

order_id

string

The order the refund relates to, as the market segment followed by the order DRN id (e.g. gb:ec42e5fc-5587-46df-b79a-99b007c5c71f).

location_id

string

The partner's location ID for the site the order belongs to.

brand_id

string

The partner's brand identifier.

reason_code

string

The refund-level reason code. Always present; may be an empty string.

applied_at

date-time

Date and time in the RFC3339 (ISO-8601) format, in UTC, when the refund was applied.

currency

string

The order-level currency as the international 3-letter code defined by the ISO 4217 standard.

refund_amount

int64

Total refund amount for the claim, in the minor unit of the currency (e.g. pence, cents). This should equal the sum of the item-level refund amounts.

items

array of objects

The per-line breakdown of what was refunded.

Items

Headers

x-deliveroo-sequence-guid

string

required

Deliveroo sequential globally unique identifier (GUID) for the delivery attempt. Please implement it as case-insensitive.

x-deliveroo-hmac-sha256

string

required

On registration, we'll provide you with a webhook secret. We'll use the webhook secret and the sequential globally unique identifier (GUID) to generate a hash of the payload. When you receive a POST request, you will be able to compute a hash and verify that it's a genuine, authorized request sent from Deliveroo. Please implement it as case-insensitive.

Responses

2XX

Your server returns any 2xx status code to acknowledge the callback.

4XX

Your server can return 4XX codes to signal its issues with the request.

5XX

Your server can return 5XX codes to signal its internal issues.

Language

Loading…