Webhook events

credit.restored

Receive this event when Grizzlee records credit.restored.

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": "credit.restored",
  "data": {
    "partnerId": "partner-example",
    "partnerExternalId": "merchant-partner-001",
    "id": "credit-example",
    "companyId": "company-example",
    "eventId": "payment-example",
    "orderId": "order-example",
    "currency": "CAD",
    "amountCents": 500,
    "restoredCents": 500,
    "createdAt": "2026-10-11T12:00:00.000Z",
    "restoredDeltaCents": 500
  },
  "createdAt": "2026-10-11T12:00:00.000Z"
}

Payload fields

Field	Type	Required	Details
`partnerId`	string	Yes
`partnerExternalId`	string	Yes
`id`	string	Yes
`companyId`	string	Yes
`eventId`	string	Yes
`orderId`	string	Yes
`currency`	"CAD", "USD", "EUR", "GBP"	Yes
`amountCents`	integer	Yes	minimum 0. maximum 1000000000000
`restoredCents`	integer	Yes	minimum 0. maximum 1000000000000
`createdAt`	string	Yes	date-time
`restoredDeltaCents`	integer	Yes	minimum 0. maximum 1000000000000

Payload schema

json

{
  "type": "object",
  "properties": {
    "partnerId": {
      "type": "string",
      "minLength": 1
    },
    "partnerExternalId": {
      "type": "string",
      "minLength": 1
    },
    "id": {
      "type": "string",
      "minLength": 1
    },
    "companyId": {
      "type": "string",
      "minLength": 1
    },
    "eventId": {
      "type": "string",
      "minLength": 1
    },
    "orderId": {
      "type": "string",
      "minLength": 1
    },
    "currency": {
      "type": "string",
      "enum": [
        "CAD",
        "USD",
        "EUR",
        "GBP"
      ]
    },
    "amountCents": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000000000
    },
    "restoredCents": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000000000
    },
    "createdAt": {
      "type": "string",
      "format": "date-time"
    },
    "restoredDeltaCents": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000000000
    }
  },
  "required": [
    "partnerId",
    "partnerExternalId",
    "id",
    "companyId",
    "eventId",
    "orderId",
    "currency",
    "amountCents",
    "restoredCents",
    "createdAt",
    "restoredDeltaCents"
  ],
  "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.