Skip to content
Last updated

Essential webhooks

The webhooks considered essential for your integration depend on your integration model

and which products you are using. This page lists Wise Platform's most essential webhooks, who they apply to, and under what circumstances.

Once subscribed to a webhook, you'll receive event notification payloads you can use to keep your system and customers updated, as well as trigger automated actions.

Additional webhooks

See our full Webhook event reference for details about all webhooks available on Wise Platform.

Transfer webhooks

When sending money, use transfer webhooks to track the status of transfers and get alerted if there is a payout failure or a refund event.

Applicable to all partner integrations, regardless of integration model.

Example payloads

{
  "data": {
    "resource": {
      "type": "transfer",
      "id": 111,
      "profile_id": 222,
      "account_id": 333
    },
    "current_state": "processing",
    "previous_state": "incoming_payment_waiting",
    "occurred_at": "2020-01-01T12:34:56.789Z"
  },
  "subscription_id": "01234567-89ab-cdef-0123-456789abcdef",
  "event_type": "transfers#state-change",
  "schema_version": "4.0.0",
  "sent_at": "2020-01-01T12:34:56.123Z"
}

Funding webhooks

When funding transfers, use the funding-related webhooks to track balance and payin events.

Applicable to Correspondent

and Enterprise integration models.

Example payloads

Balance update credit

{
  "data": {
    "resource": {
      "id": 2,
      "profile_id": 2,
      "type": "balance-account"
    },
    "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"
  },
  "subscription_id": "f2264fe5-a0f5-4dab-a1b4-6faa87761425",
  "event_type": "balances#update",
  "schema_version": "4.0.0",
  "sent_at": "2023-03-08T14:55:39.456Z"
}

Payment instrument status changes

When a payment instrument is successfully connected:

{
  "subscription_id": "36f45c7e-e4bf-4342-88fc-ead33500f9b8",
  "event_type": "payment-instruments#status-change",
  "schema_version": "0.0.1",
  "sent_at": "2025-01-19T17:43:23Z",
  "data": {
    "resource": {
      "id": "7f0f9dda-7755-4b4f-bd53-637129291308"
    },
    "from_status": "PENDING",
    "to_status": "CONNECTED",
    "occurred_at": "2025-01-19T17:43:22Z"
  }
}

Payin status changes

When a payin enters the processing state:

{
  "subscription_id": "36f45c7e-e4bf-4342-88fc-ead33500f9b8",
  "event_type": "payment-instruments-payins#status-change",
  "schema_version": "0.0.1",
  "sent_at": "2025-01-19T10:15:23Z",
  "data": {
    "resource": {
      "id": "67136333-0b4d-4f72-49bf-24088f687416",
      "payment_instrument_id": "67133810-d4f6-47b4-a948-09b2d8438b43"
    },
    "from_status": null,
    "to_status": "PROCESSING",
    "occurred_at": "2025-01-19T10:15:22Z"
  }
}

Manage balances webhooks

For partners with multi-currency accounts, use the balance update webhook to get notified when either credit or debit events occur on a balance account.

Applicable to Correspondent and Enterprise integration models.

Example payloads

{
  "data": {
    "resource": {
      "id": 2,
      "profile_id": 2,
      "type": "balance-account"
    },
    "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"
  },
  "subscription_id": "f2264fe5-a0f5-4dab-a1b4-6faa87761425",
  "event_type": "balances#update",
  "schema_version": "4.0.0",
  "sent_at": "2023-03-08T14:55:39.456Z"
}

Receive money webhooks

When using the international receive product, use these webhooks to receive notifications when an account receives an incoming transfer.

Applicable to partners on the Correspondent and Enterprise integration models.

See our Incoming transfers guide for more details.

Example payload

Incoming transfer credited:

{
  "schema_version": "4.0.0",
  "subscription_id": "01234567-89ab-cdef-0123-456789abcdef",
  "event_type": "incoming-transfer#credited",
  "sent_at": "2026-10-21T12:34:58.123Z",
  "data": {
    "incoming_transfer_id": "01234567-89ab-cdef-0123-456789abcdef",
    "occurred_at": "2026-08-21T12:34:56.789Z"
  }
}

Issue cards webhooks

When using the issue cards product, receive notifications every time a card order status updates or a card status changes, including the initial card status.

Applicable to partners on the Correspondent and Enterprise integration models.

Example payloads

{
  "schema_version": "4.0.0",
  "subscription_id": "ABCD-1234-ABCD-1234-ABCD",
  "event_type": "cards#card-status-change",
  "sent_at": "2022-08-22T07:59:50.123Z",
  "data": {
    "resource": {
      "profile_id": 123456,
      "client_id": "your-bank",
      "card_token": "ABCD-1234-ABCD-1234-ABCD",
      "type": "card"
    },
    "card_status": "FROZEN",
    "changed_by": "internal_system",
    "occurred_at": "2022-08-22T07:49:50.789Z"
  }
}

Profile and KYC webhooks

When creating profiles for your customers during customer onboarding, use the profile and KYC webhooks to be notified when a profile is ready to use or becomes inactive for some reason.

Applicable to the Embedded finance

integration model.

Example payloads

{
  "schema_version": "4.0.0",
  "subscription_id": "f5b51f77-e14a-433b-9f7c-fc2834ffcff5",
  "event_type": "profiles#state-change",
  "sent_at": "2020-01-01T12:34:56.123Z",
  "data": {
    "resource": {
      "id": 1234,
      "type": "profile"
    },
    "current_state": "WITHDRAW_ONLY",
    "occurred_at": "2020-01-01T12:34:56.789Z",
    "requested_by_customer": false
  }
}

Support case webhooks

If submitting support requests via API, subscribe to the support case change webhook to be notified about comments and status changes.

Applicable to all partner integrations.

Example payload

{
  "schema_version": "4.0.0",
  "subscription_id": "017631af-326c-4a69-93f3-bd1ce987a743",
  "event_type": "partner-support#case-changed",
  "sent_at": "2023-06-23T09:45:36.123Z",
  "data": {
    "resource": {
      "type": "partner-support-case",
      "case_id": 136,
      "case_type": "GENERAL_ENQUIRY",
      "details": {
        "transfer_id": 12345678,
        "user_id": 12345678,
        "profile_id": 12345678
      },
      "status": "PENDING"
    },
    "type": "NEW_CASE",
    "occurred_at": "2023-06-23T09:45:34.789Z"
  }
}