{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/developer/webhooks/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["glossary","admonition","tabs","tab","partial"]},"type":"markdown"},"seo":{"title":"Essential webhooks","siteUrl":"https://docs.wise.com","projectTitle":"Wise Platform","description":"Wise Platform offer domestic and cross-border payments tools for technology platforms, banks and fininical institutions.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"essential-webhooks","__idx":0},"children":["Essential webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The webhooks considered essential for your integration depend on your ",{"$$mdtype":"Tag","name":"Glossary","attributes":{"term":"Integration model","def":"The way in which a partner integrates with Wise Platform. Corresponds to the correspondent services, embedded finance, or enterprise partnership use cases."},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/developer/webhooks/subscribe-to-webhooks"},"children":["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."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"success","name":"Additional webhooks"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See our full ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event"},"children":["Webhook event reference"]}," for details about all webhooks available on Wise Platform."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"transfer-webhooks","__idx":1},"children":["Transfer webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applicable to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["all partner integrations"]},", regardless of integration model."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventtransfersstatechange"},"children":["Transfer state change"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventtransferspayoutfailure"},"children":["Transfer payout failure"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventtransfersrefund"},"children":["Transfer refund"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventtransfersactivecases"},"children":["Transfers active cases"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-payloads","__idx":2},"children":["Example payloads"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Transfer state change","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"resource\": {\n      \"type\": \"transfer\",\n      \"id\": 111,\n      \"profile_id\": 222,\n      \"account_id\": 333\n    },\n    \"current_state\": \"processing\",\n    \"previous_state\": \"incoming_payment_waiting\",\n    \"occurred_at\": \"2020-01-01T12:34:56.789Z\"\n  },\n  \"subscription_id\": \"01234567-89ab-cdef-0123-456789abcdef\",\n  \"event_type\": \"transfers#state-change\",\n  \"schema_version\": \"4.0.0\",\n  \"sent_at\": \"2020-01-01T12:34:56.123Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Payout failure","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"transfer_id\": 111,\n    \"profile_id\": 222,\n    \"failure_reason_code\": \"WRONG_ID_NUMBER\",\n    \"failure_description\": \"Invalid recipient's ID document number\",\n    \"occurred_at\": \"2023-08-10T10:17:23.123Z\"\n  },\n  \"subscription_id\": \"01234567-89ab-cdef-0123-456789abcdef\",\n  \"event_type\": \"transfers#payout-failure\",\n  \"schema_version\": \"4.0.0\",\n  \"sent_at\": \"2023-08-10T10:17:28.123Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Transfer refund","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"resource\": {\n      \"type\": \"transfer\",\n      \"id\": 111,\n      \"profile_id\": 222,\n      \"account_id\": 333,\n      \"refund_amount\": 5000,\n      \"refund_currency\": \"EUR\"\n    },\n    \"occurred_at\": \"2024-01-01T12:34:56.789Z\"\n  },\n  \"subscription_id\": \"01234567-89ab-cdef-0123-456789abcdef\",\n  \"event_type\": \"transfers#refund\",\n  \"schema_version\": \"4.0.0\",\n  \"sent_at\": \"2024-01-01T12:34:56.123Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Transfers active cases","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"schema_version\": \"4.0.0\",\n  \"subscription_id\": \"01234567-89ab-cdef-0123-456789abcdef\",\n  \"event_type\": \"transfers#active-cases\",\n  \"sent_at\": \"2026-01-01T12:34:56.123Z\",\n  \"data\": {\n    \"resource\": {\n      \"type\": \"transfer\",\n      \"id\": 111,\n      \"profile_id\": 222,\n      \"account_id\": 333\n    },\n    \"active_cases\": [\n      \"deposit_amount_less_invoice\"\n    ]\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"funding-webhooks","__idx":3},"children":["Funding webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When funding transfers, use the funding-related webhooks to track balance and payin events."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applicable to ",{"$$mdtype":"Tag","name":"Glossary","attributes":{"term":"Correspondent partner","def":"The term used to refer to Wise Platform partners who are regulated financial institutions using the Wise infrastructure to facilitate international transactions on behalf of their customers."},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Correspondent"]}]}," and ",{"$$mdtype":"Tag","name":"Glossary","attributes":{"term":"Enterprise partner","def":"The term used to refer to enterprise-level businesses who use Wise Platform to manage their own funds in their Wise business account."},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enterprise"]}]}," integration models."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventbalancesupdate"},"children":["Balance update"]},": Subscribe if funding transfers from a multi-currency balance account."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/product/send-money/funding/direct-debit/create-payment-instrument"},"children":["Create payment instrument status change"]},": Subscribe if funding transfers via direct debit."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/product/send-money/funding/direct-debit/create-payin"},"children":["Payin status change"]},": Subscribe if funding transfers via direct debit."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-payloads-1","__idx":4},"children":["Example payloads"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"balance-update-credit","__idx":5},"children":["Balance update credit"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"resource\": {\n      \"id\": 2,\n      \"profile_id\": 2,\n      \"type\": \"balance-account\"\n    },\n    \"amount\": 70,\n    \"balance_id\": 111,\n    \"channel_name\": \"TRANSFER\",\n    \"currency\": \"GBP\",\n    \"occurred_at\": \"2023-03-08T14:55:38.123Z\",\n    \"post_transaction_balance_amount\": 88.93,\n    \"step_id\": 1234567,\n    \"transaction_type\": \"credit\",\n    \"transfer_reference\": \"BNK-1234567\"\n  },\n  \"subscription_id\": \"f2264fe5-a0f5-4dab-a1b4-6faa87761425\",\n  \"event_type\": \"balances#update\",\n  \"schema_version\": \"4.0.0\",\n  \"sent_at\": \"2023-03-08T14:55:39.456Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"payment-instrument-status-changes","__idx":6},"children":["Payment instrument status changes"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Connected status payload","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a payment instrument is successfully connected:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"subscription_id\": \"36f45c7e-e4bf-4342-88fc-ead33500f9b8\",\n  \"event_type\": \"payment-instruments#status-change\",\n  \"schema_version\": \"0.0.1\",\n  \"sent_at\": \"2025-01-19T17:43:23Z\",\n  \"data\": {\n    \"resource\": {\n      \"id\": \"7f0f9dda-7755-4b4f-bd53-637129291308\"\n    },\n    \"from_status\": \"PENDING\",\n    \"to_status\": \"CONNECTED\",\n    \"occurred_at\": \"2025-01-19T17:43:22Z\"\n  }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Disconnected status payload","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a payment instrument becomes disconnected, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["disconnect_reason"]}," field is included in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.resource"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"subscription_id\": \"36f45c7e-e4bf-4342-88fc-ead33500f9b8\",\n  \"event_type\": \"payment-instruments#status-change\",\n  \"schema_version\": \"0.0.1\",\n  \"sent_at\": \"2025-01-20T14:22:18Z\",\n  \"data\": {\n    \"resource\": {\n      \"id\": \"7f0f9dda-7755-4b4f-bd53-637129291308\",\n      \"disconnect_reason\": \"REFER_TO_PAYER\"\n    },\n    \"from_status\": \"CONNECTED\",\n    \"to_status\": \"DISCONNECTED\",\n    \"occurred_at\": \"2025-01-20T14:22:17Z\"\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"payin-status-changes","__idx":7},"children":["Payin status changes"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Processing status payload","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a payin enters the processing state:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"subscription_id\": \"36f45c7e-e4bf-4342-88fc-ead33500f9b8\",\n  \"event_type\": \"payment-instruments-payins#status-change\",\n  \"schema_version\": \"0.0.1\",\n  \"sent_at\": \"2025-01-19T10:15:23Z\",\n  \"data\": {\n    \"resource\": {\n      \"id\": \"67136333-0b4d-4f72-49bf-24088f687416\",\n      \"payment_instrument_id\": \"67133810-d4f6-47b4-a948-09b2d8438b43\"\n    },\n    \"from_status\": null,\n    \"to_status\": \"PROCESSING\",\n    \"occurred_at\": \"2025-01-19T10:15:22Z\"\n  }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Settled status payload","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a payin successfully settles:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"subscription_id\": \"36f45c7e-e4bf-4342-88fc-ead33500f9b8\",\n  \"event_type\": \"payment-instruments-payins#status-change\",\n  \"schema_version\": \"0.0.1\",\n  \"sent_at\": \"2025-01-22T14:30:46Z\",\n  \"data\": {\n    \"resource\": {\n      \"id\": \"67136333-0b4d-4f72-49bf-24088f687416\",\n      \"payment_instrument_id\": \"67133810-d4f6-47b4-a948-09b2d8438b43\"\n    },\n    \"from_status\": \"CONFIRMED\",\n    \"to_status\": \"SETTLED\",\n    \"occurred_at\": \"2025-01-22T14:30:45Z\"\n  }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Failed status payload","disable":false},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a payin fails, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failure_reason"]}," field is included in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.resource"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"subscription_id\": \"36f45c7e-e4bf-4342-88fc-ead33500f9b8\",\n  \"event_type\": \"payment-instruments-payins#status-change\",\n  \"schema_version\": \"0.0.1\",\n  \"sent_at\": \"2025-01-20T16:45:19Z\",\n  \"data\": {\n    \"resource\": {\n      \"id\": \"78247444-1c5e-5083-5acf-35199f798c527\",\n      \"payment_instrument_id\": \"67133810-d4f6-47b4-a948-09b2d8438b43\",\n      \"failure_reason\": \"REFER_TO_PAYER\"\n    },\n    \"from_status\": \"PROCESSING\",\n    \"to_status\": \"FAILED\",\n    \"occurred_at\": \"2025-01-20T16:45:18Z\"\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"manage-balances-webhooks","__idx":8},"children":["Manage balances webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applicable to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Correspondent"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enterprise"]}," integration models."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventbalancesupdate"},"children":["Balance update"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-payloads-2","__idx":9},"children":["Example payloads"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Balance update credit","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"resource\": {\n      \"id\": 2,\n      \"profile_id\": 2,\n      \"type\": \"balance-account\"\n    },\n    \"amount\": 70,\n    \"balance_id\": 111,\n    \"channel_name\": \"TRANSFER\",\n    \"currency\": \"GBP\",\n    \"occurred_at\": \"2023-03-08T14:55:38.123Z\",\n    \"post_transaction_balance_amount\": 88.93,\n    \"step_id\": 1234567,\n    \"transaction_type\": \"credit\",\n    \"transfer_reference\": \"BNK-1234567\"\n  },\n  \"subscription_id\": \"f2264fe5-a0f5-4dab-a1b4-6faa87761425\",\n  \"event_type\": \"balances#update\",\n  \"schema_version\": \"4.0.0\",\n  \"sent_at\": \"2023-03-08T14:55:39.456Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Balance update debit","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"resource\": {\n      \"id\": 2,\n      \"profile_id\": 2,\n      \"type\": \"balance-account\"\n    },\n    \"amount\": 9.6,\n    \"balance_id\": 111,\n    \"channel_name\": \"TRANSFER\",\n    \"currency\": \"GBP\",\n    \"occurred_at\": \"2023-03-08T15:26:07.891Z\",\n    \"post_transaction_balance_amount\": 106.93,\n    \"step_id\": 1234567,\n    \"transaction_type\": \"debit\",\n    \"transfer_reference\": \"47500002\"\n  },\n  \"subscription_id\": \"f2264fe5-a0f5-4dab-a1b4-6faa87761425\",\n  \"event_type\": \"balances#update\",\n  \"schema_version\": \"4.0.0\",\n  \"sent_at\": \"2023-03-08T15:26:07.234Z\"\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"receive-money-webhooks","__idx":10},"children":["Receive money webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When using the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/product/receive-money"},"children":["international receive product"]},", use these webhooks to receive notifications when an account receives an incoming transfer."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applicable to partners on the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Correspondent"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enterprise"]}," integration models."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventincomingtransfercredited"},"children":["Incoming transfer credited"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventswiftmessagereceived"},"children":["Swift message received"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See our ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/product/receive-money/incoming-transfer-notifications"},"children":["Incoming transfers guide"]}," for more details."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-payload","__idx":11},"children":["Example payload"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Incoming transfer credited"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"schema_version\": \"4.0.0\",\n  \"subscription_id\": \"01234567-89ab-cdef-0123-456789abcdef\",\n  \"event_type\": \"incoming-transfer#credited\",\n  \"sent_at\": \"2026-10-21T12:34:58.123Z\",\n  \"data\": {\n    \"incoming_transfer_id\": \"01234567-89ab-cdef-0123-456789abcdef\",\n    \"occurred_at\": \"2026-08-21T12:34:56.789Z\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"issue-cards-webhooks","__idx":12},"children":["Issue cards webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When using the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/product/issue-cards"},"children":["issue cards product"]},", receive notifications every time a card order status updates or a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/product/issue-cards/card-transaction"},"children":["card status changes"]},", including the initial card status."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applicable to partners on the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Correspondent"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enterprise"]}," integration models."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventcardscardstatuschange"},"children":["Card status changes"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventcardscardorderstatuschange"},"children":["Card order status changes"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-payloads-3","__idx":13},"children":["Example payloads"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Card status change","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"schema_version\": \"4.0.0\",\n  \"subscription_id\": \"ABCD-1234-ABCD-1234-ABCD\",\n  \"event_type\": \"cards#card-status-change\",\n  \"sent_at\": \"2022-08-22T07:59:50.123Z\",\n  \"data\": {\n    \"resource\": {\n      \"profile_id\": 123456,\n      \"client_id\": \"your-bank\",\n      \"card_token\": \"ABCD-1234-ABCD-1234-ABCD\",\n      \"type\": \"card\"\n    },\n    \"card_status\": \"FROZEN\",\n    \"changed_by\": \"internal_system\",\n    \"occurred_at\": \"2022-08-22T07:49:50.789Z\"\n  }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Card order status change","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"schema_version\": \"4.0.0\",\n  \"subscription_id\": \"01234567-89ab-cdef-0123-456789abcdef\",\n  \"event_type\": \"cards#card-order-status-change\",\n  \"sent_at\": \"2023-01-01T12:34:56.123Z\",\n  \"data\": {\n    \"resource\": {\n      \"profile_id\": 123456,\n      \"type\": \"card\",\n      \"client_id\": \"your-bank\",\n      \"card_token\": \"35050a4a-9521-426e-8109-1396e3687a3e\",\n      \"card_program\": \"VISA_DEBIT_CONSUMER_UK_1_PHYSICAL_CARDS_API\"\n    },\n    \"order_id\": \"1001L\",\n    \"order_status\": \"PRODUCED\",\n    \"delivery_vendor\": \"DHL\",\n    \"occurred_at\": \"2023-01-01T12:24:56.789Z\"\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"profile-and-kyc-webhooks","__idx":14},"children":["Profile and KYC webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applicable to the ",{"$$mdtype":"Tag","name":"Glossary","attributes":{"term":"Embedded finance","def":"The term used to refer to regulated financial institutions and fintech platforms who offer Wise services to their customers by embedding Wise features and capabilities directly into their applications. Sometimes called Embedded partners or Embedded integrations."},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Embedded finance"]}]}," integration model."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventprofilesstatechange"},"children":["Profile state change"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventprofilesverificationstatechange"},"children":["Profile verification state change"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventkycreviewsstatechange"},"children":["KYC review state change"]},": For partners using the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/kyc-review/kycreviewcreate"},"children":["KYC review endpoint"]}," only."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-payloads-4","__idx":15},"children":["Example payloads"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Profile state change","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"schema_version\": \"4.0.0\",\n  \"subscription_id\": \"f5b51f77-e14a-433b-9f7c-fc2834ffcff5\",\n  \"event_type\": \"profiles#state-change\",\n  \"sent_at\": \"2020-01-01T12:34:56.123Z\",\n  \"data\": {\n    \"resource\": {\n      \"id\": 1234,\n      \"type\": \"profile\"\n    },\n    \"current_state\": \"WITHDRAW_ONLY\",\n    \"occurred_at\": \"2020-01-01T12:34:56.789Z\",\n    \"requested_by_customer\": false\n  }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Verification state change","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"schema_version\": \"4.0.0\",\n  \"subscription_id\": \"01234567-89ab-cdef-0123-456789abcdef\",\n  \"event_type\": \"profiles#verification-state-change\",\n  \"sent_at\": \"2026-01-01T12:34:56.123Z\",\n  \"data\": {\n    \"resource\": {\n      \"type\": \"profile\",\n      \"id\": 111\n    },\n    \"current_state\": \"verified\",\n    \"occurred_at\": \"2026-01-01T12:34:56.789Z\"\n  }\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"KYC review state change","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"schema_version\": \"5.0.0\",\n  \"subscription_id\": \"8df95817-8085-40aa-9bda-e3bf46e7a21a\",\n  \"event_type\": \"kyc-reviews#state-change\",\n  \"sent_at\": \"2024-09-03T16:29:42.123Z\",\n  \"data\": {\n    \"resource\": {\n      \"id\": \"46e1a5c4-4a9b-4563-39d3-18174d3ac0f8\",\n      \"state\": \"WAITING_CUSTOMER_INPUT\",\n      \"prevState\": \"WAITING_CUSTOMER_INPUT\",\n      \"profileId\": 22016766,\n      \"requiredBy\": \"2024-09-03T16:22:02.258Z\",\n      \"createdAt\": \"2024-09-03T16:22:02.258Z\",\n      \"updatedAt\": \"2024-09-03T16:29:41.148Z\",\n      \"triggerReferences\": [\n        {\n          \"type\": \"QUOTE\",\n          \"triggerData\": {\n            \"id\": \"ba83s43a-f623-46f0-956d-196c13e2ab01\"\n          }\n        }\n      ],\n      \"requirements\": [\n        [\n          {\n            \"key\": \"ID_DOCUMENT\",\n            \"state\": \"NOT_PROVIDED\",\n            \"apiCollectionSupported\": true,\n            \"additionalRequirements\": [\n              {\n                \"reasons\": {},\n                \"attributes\": {}\n              }\n            ],\n            \"versions\": [\n              {}\n            ]\n          }\n        ]\n      ],\n      \"requirementChanges\": [\n        {\n          \"key\": \"ID_DOCUMENT\",\n          \"newState\": \"IN_REVIEW\",\n          \"prevState\": \"NOT_PROVIDED\",\n          \"additionalRequirements\": [\n            {\n              \"additionalRequirementId\": \"8b789c45-60ae-475d-b667-c8714db9a6a4\",\n              \"newState\": \"IN_REVIEW\",\n              \"prevState\": \"NOT_PROVIDED\"\n            }\n          ]\n        }\n      ]\n    }\n  }\n}\n","lang":"json"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"support-case-webhooks","__idx":16},"children":["Support case webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If submitting support requests via API, subscribe to the support case change webhook to be notified about comments and status changes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Applicable to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["all partner integrations"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/webhook-event/eventpartnersupportcasechanged"},"children":["Partner support case changed"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-payload-1","__idx":17},"children":["Example payload"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"schema_version\": \"4.0.0\",\n  \"subscription_id\": \"017631af-326c-4a69-93f3-bd1ce987a743\",\n  \"event_type\": \"partner-support#case-changed\",\n  \"sent_at\": \"2023-06-23T09:45:36.123Z\",\n  \"data\": {\n    \"resource\": {\n      \"type\": \"partner-support-case\",\n      \"case_id\": 136,\n      \"case_type\": \"GENERAL_ENQUIRY\",\n      \"details\": {\n        \"transfer_id\": 12345678,\n        \"user_id\": 12345678,\n        \"profile_id\": 12345678\n      },\n      \"status\": \"PENDING\"\n    },\n    \"type\": \"NEW_CASE\",\n    \"occurred_at\": \"2023-06-23T09:45:34.789Z\"\n  }\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Essential webhooks","id":"essential-webhooks","depth":1},{"value":"Transfer webhooks","id":"transfer-webhooks","depth":2},{"value":"Example payloads","id":"example-payloads","depth":3},{"value":"Funding webhooks","id":"funding-webhooks","depth":2},{"value":"Example payloads","id":"example-payloads-1","depth":3},{"value":"Balance update credit","id":"balance-update-credit","depth":4},{"value":"Payment instrument status changes","id":"payment-instrument-status-changes","depth":4},{"value":"Payin status changes","id":"payin-status-changes","depth":4},{"value":"Manage balances webhooks","id":"manage-balances-webhooks","depth":2},{"value":"Example payloads","id":"example-payloads-2","depth":3},{"value":"Receive money webhooks","id":"receive-money-webhooks","depth":2},{"value":"Example payload","id":"example-payload","depth":3},{"value":"Issue cards webhooks","id":"issue-cards-webhooks","depth":2},{"value":"Example payloads","id":"example-payloads-3","depth":3},{"value":"Profile and KYC webhooks","id":"profile-and-kyc-webhooks","depth":2},{"value":"Example payloads","id":"example-payloads-4","depth":3},{"value":"Support case webhooks","id":"support-case-webhooks","depth":2},{"value":"Example payload","id":"example-payload-1","depth":3}],"frontmatter":{"seo":{"title":"Essential webhooks"}},"lastModified":"2026-07-01T12:04:37.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer/webhooks/essential-webhooks","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}