Skip to content
Developer docs
⌘ K
Dashboard ↗

Webhook events

order.refunded

Receive this event when Grizzlee records order.refunded.

Example payload

This illustrative payload follows the current event validator. Amounts use minor units.

json
{
  "id": "00000000-0000-4000-8000-000000000001",
  "companyId": "company-example",
  "type": "order.refunded",
  "data": {
    "type": "order.refunded",
    "eventId": "payment-example",
    "orderId": "order-example",
    "refundedTotalCents": 10000,
    "refundedCommissionableCents": 10000,
    "fullRefund": true,
    "occurredAt": "2026-10-11T12:00:00.000Z",
    "partners": [
      {
        "partnerId": "partner-example",
        "partnerExternalId": "merchant-partner-001"
      }
    ]
  },
  "createdAt": "2026-10-11T12:00:00.000Z"
}

Payload fields

FieldTypeRequiredDetails
type"order.refunded"Yes
eventIdstringYes
orderIdstringYes
refundedTotalCentsintegerNominimum 0. maximum 1000000000000
refundedCommissionableCentsintegerNominimum 0. maximum 1000000000000
fullRefundbooleanNo
occurredAtstringYesdate-time
partnersarrayYes
partnerIdstringNo
partnerExternalIdstringNo

partners[]

FieldTypeRequiredDetails
partners.partnerIdstringYes
partners.partnerExternalIdstringYes

Payload schema

json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "const": "order.refunded"
    },
    "eventId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "orderId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "refundedTotalCents": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000000000
    },
    "refundedCommissionableCents": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000000000
    },
    "fullRefund": {
      "type": "boolean"
    },
    "occurredAt": {
      "type": "string",
      "format": "date-time"
    },
    "partners": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "partnerId": {
            "type": "string",
            "minLength": 1
          },
          "partnerExternalId": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "partnerId",
          "partnerExternalId"
        ],
        "additionalProperties": true
      }
    },
    "partnerId": {
      "type": "string",
      "minLength": 1
    },
    "partnerExternalId": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "type",
    "eventId",
    "orderId",
    "occurredAt",
    "partners"
  ],
  "additionalProperties": true
}

Handle delivery

Verify the signature over the raw body before parsing JSON. Check that the body ID matches Grizzlee-Event-Id. Process each ID once, since delivery can repeat.