---
title: "Bulk settlement payment received"
method: POST
path: "bulk-settlement#payment-received"
tags: ["webhook-event", "bulk-settlement"]
---

# Bulk settlement payment received

`POST bulk-settlement#payment-received` (webhook)

Triggered when a bulk settlement fund is received. Once there is a match, meaning the amount for this settlement journal is fully settled, the `amount_matched` is set to `true`. If it is not matched, check the difference between `source_amount` and `target_amount` to determine how much more needs to be paid.

This event can also be triggered when our operations team reallocates funds between settlements. Therefore, the `received_amount` in version 2.0.0 of the webhook is inaccurate. Please use the latest version, 4.0.0. Version 2.0.0 is deprecated.

* Event type: `bulk-settlement#payment-received`
* 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](/guides/developer/webhooks/event-ordering) for details.

See the [Webhooks guide](/guides/developer/webhooks) for setup instructions, signature verification, and best practices.

## Headers

- `X-Signature-SHA256` string
- `X-Delivery-Id` string, uuid
- `X-Test-Notification` boolean

## Payload

- union
  - V40027
    - `schema_version` '4.0.0' — Version of the event schema. Determined by the `schema_version` on your [webhook subscription](/api-reference/webhook).
    - `subscription_id` string, uuid — ID of the webhook subscription that triggered this event.
    - `event_type` string — Event type identifier
    - `sent_at` string, date-time — Timestamp when the event was sent.
    - `data` object
      - `resource` object
        - `settlement_reference` string — Reference on settlement journal
        - `source_currency` string — Settlement currency
        - `source_amount` number — The amount Wise paid out on behalf of partner.
        - `target_amount` number — Total settlement fund received for this settlement journal.
        - `amount_matched` boolean — Whether amount received matches what is expected.
      - `occurred_at` string, date-time — When the settlement fund was received.
  - V3003
    - `schema_version` '3.0.0' — Version of the event schema. Determined by the `schema_version` on your [webhook subscription](/api-reference/webhook).
    - `subscription_id` string, uuid — ID of the webhook subscription that triggered this event
    - `event_type` string — Event type identifier
    - `sent_at` string, date-time — Timestamp when the event was sent
    - `data` object
      - `resource` object
        - `settlement_reference` string — Reference on settlement journal
        - `source_currency` string — Settlement currency
        - `source_amount` number — The amount Wise paid out on behalf of partner
        - `target_amount` number — Total settlement fund received for this settlement journal
        - `amount_matched` boolean — Whether amount received matches what is expected
      - `occurred_at` string, date-time — When the settlement fund was received
  - V20024
    - `schema_version` '2.0.0' — Version of the event schema. Determined by the `schema_version` on your [webhook subscription](/api-reference/webhook).
    - `subscription_id` string, uuid — ID of the webhook subscription that triggered this event
    - `event_type` string — Event type identifier
    - `sent_at` string, date-time — Timestamp when the event was sent
    - `data` object
      - `resource` object
        - `settlement_reference` string — Reference on settlement journal
        - `source_currency` string — Settlement currency
        - `received_amount` number — Please be aware that this field is unreliable. Always refer to the `target_amount` field for the total amount paid, and check the difference between `source_amount` and `target_amount` to see how much more needs to be paid.
        - `source_amount` number — The amount Wise paid out on behalf of partner
        - `target_amount` number — Total settlement fund received for this settlement journal
        - `amount_matched` boolean — Whether amount received matches what is expected
      - `occurred_at` string, date-time — When the settlement fund was received

## Acknowledgement `200`

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

- object
  - `status` string

---

[API](https://skmtc.net/wise/apis/platform-api.md) · [All operations](https://skmtc.net/wise/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wise/platform-api/revisions/4907a1d269ab/schema)