Skip to content

Hold limit breach update
Webhook

Request

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).

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

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.

See the Webhooks guide for setup instructions, signature verification, and best practices.

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.

Example:t7FMhk3OARMgwqz0LJXO...
X-Delivery-Idstring, (uuid)

Unique identifier for this webhook delivery attempt.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890
X-Test-Notificationboolean

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

Example:true
Bodyapplication/json
schema_versionstring

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

Value:"4.0.0"
Example:"4.0.0"
subscription_idstring, (uuid)

ID of the webhook subscription that triggered this event.

Example:"01234567-89ab-cdef-0123-456789abcdef"
event_typestring

Event type identifier

Example:"hold-limit-breach#update"
sent_atstring, (date-time)

Timestamp when the event was sent.

Example:"2024-06-01T08:00:00Z"
dataobject
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": "OPEN",
    "closing_reason": null,
    "created_at": "2024-06-01T08:00:00Z",
    "updated_at": "2024-06-01T08:00:00Z",
    "occurred_at": "2024-06-01T08:00:00Z"
  }
}

Responses

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

Bodyapplication/json
statusstring
Example:"ok"
Response
{
  "status": "ok"
}