Webhook Events

return.submitted

Sent when a deposit return is submitted to the payment rail.

postWebhookreturn.submitted

Payload

idstring required

Unique identifier for the event. Stable across retries.

type'return.submitted' 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",
    "status": "sent",
    "deposit_id": "550e8400-e29b-41d4-a716-446655440004",
    "amount": "100.50",
    "currency": "USD",
    "initiated_at": "2026-01-15T10:30:00Z",
    "sent_at": "2026-01-15T10:35:00Z",
    "rail": "ach",
    "metadata": {
      "invoice_id": "INV-2026-0042"
    }
  },
  "date": "2026-01-15T10:30:00Z"
}

Response

Event received successfully.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.