Sign in
webhook-event
balance

Hold limit breach update

Triggered whenever a hold limit breach is opened or closed for a profile. A hold limit breach occurs when a balance exceeds the regulatory hold limit (applicable in countries such as Singapore and Malaysia). See the Webhooks guide for setup instructions, signature verification, and best practices.

Events may not be delivered in the order they occurred. Use data.occurred_at to reconcile the order. See the Event Ordering guide for details.

Use data.state to determine whether the breach has been opened or closed, and data.closing_reason to understand how it was resolved.

  • Event type: hold-limit-breach#update
  • Profile level subscriptions: Supported
  • Application level subscriptions: Supported
postWebhookhold-limit-breach#update

Headers

X-Signature-SHA256string

RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the Wise public key to ensure the request is authentic and has not been tampered with.

X-Delivery-Idstring uuid

Unique identifier for this webhook delivery attempt.

X-Test-Notificationboolean

Present with the value true if this is a test notification sent to verify your callback URL during subscription setup.

Payload

schema_version'4.0.0'

Version of the event schema. Determined by the schema_version on your webhook subscription.

subscription_idstring uuid

ID of the webhook subscription that triggered this event

event_typestring

Event type identifier

sent_atstring date-time

Timestamp when the event was sent

Example payload

{
  "schema_version": "4.0.0",
  "subscription_id": "01234567-89ab-cdef-0123-456789abcdef",
  "event_type": "hold-limit-breach#update",
  "sent_at": "2024-06-01T08:00:00Z",
  "data": {
    "resource": {
      "type": "hold-limit-breach",
      "hold_limit_breach_id": 1001,
      "profile_id": 12321323
    },
    "amount": 500.5,
    "currency": "SGD",
    "state": "CLOSED",
    "closing_reason": "MANUALLY_RESOLVED",
    "created_at": "2024-06-01T08:00:00Z",
    "updated_at": "2024-06-01T08:00:00Z",
    "occurred_at": "2024-06-01T08:00:00Z"
  }
}

Response

Return any 2xx status to acknowledge receipt of the event.

statusstring

Example response

{
  "status": "ok"
}

Changes