Sign in
Webhook Events

return.failed

Sent when a deposit return has failed.

postWebhookreturn.failed

Payload

idstring required

Unique identifier for the event. Stable across retries.

type'return.failed' required

Event type in resource.action format.

api_versionstring required

API version the payload was rendered at. Stable across retries and redeliveries.

datestring date-time required

ISO 8601 UTC timestamp when the event was created.

Example payload

{
  "id": "550e8400-e29b-41d4-a716-446655440008",
  "api_version": "2026-05-01",
  "payload": {
    "id": "550e8400-e29b-41d4-a716-446655440005",
    "deposit_id": "550e8400-e29b-41d4-a716-446655440004",
    "amount": "100.50",
    "currency": "EUR",
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-15T10:35:00Z"
  },
  "date": "2026-01-15T10:30:00Z"
}

Response

Event received successfully.

Changes