Skip to content

Balance update
Webhook

Request

Triggered every time a multi-currency account is credited or debited.

  • Event type: balances#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, and data.step_id to order events within a single transaction. For tracking events related to a single transaction such as a cancelled card transaction, use data.step_id 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"
Discriminator
subscription_idstring, (uuid)

ID of the webhook subscription that triggered this event.

Example:"f2264fe5-a0f5-4dab-a1b4-6faa87761425"
event_typestring

Event type identifier

Example:"balances#update"
sent_atstring, (date-time)

Timestamp when the event was sent.

Example:"2023-03-08T14:55:39.456Z"
dataobject
Payload
{
  "schema_version": "4.0.0",
  "subscription_id": "f2264fe5-a0f5-4dab-a1b4-6faa87761425",
  "event_type": "balances#update",
  "sent_at": "2023-03-08T14:55:39.456Z",
  "data": {
    "resource": {
      "type": "balance-account",
      "id": 2,
      "profile_id": 2
    },
    "amount": 70,
    "balance_id": 111,
    "channel_name": "TRANSFER",
    "currency": "GBP",
    "occurred_at": "2023-03-08T14:55:38.123Z",
    "post_transaction_balance_amount": 88.93,
    "step_id": 1234567,
    "transaction_type": "credit",
    "transfer_reference": "BNK-1234567"
  }
}

Responses

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

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