Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
webhook-event
balance

Balance account state change

Triggered every time a balance account is activated or deactivated.

  • Event type: balances#account-state-change
  • Profile level subscriptions: Not 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.

postWebhookbalances#account-state-change

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

OR

Example payload

{
  "schema_version": "4.0.0",
  "subscription_id": "01234567-89ab-cdef-0123-456789abcdef",
  "event_type": "balances#account-state-change",
  "sent_at": "2020-01-01T12:34:56.123Z",
  "data": {
    "resource": {
      "type": "balance-account",
      "id": 123,
      "profile_id": 555,
      "state": "INACTIVE"
    },
    "occurred_at": "2020-01-01T12:34:56.789Z"
  }
}

Response

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

statusstring

Example response

{
  "status": "ok"
}