---
title: "Sweep deleted"
method: POST
path: "balancePlatform.balanceAccountSweep.deleted"
tags: ["Balance account"]
---

# Sweep deleted

`POST balancePlatform.balanceAccountSweep.deleted` (webhook)

Adyen sends this webhook when you successfully [delete a sweep](https://docs.adyen.com/api-explorer/balanceplatform/latest/delete/balanceAccounts/_balanceAccountId_/sweeps/_sweepId_).

## Payload

- SweepConfigurationNotificationRequest
  - `data` SweepConfigurationNotificationData, required
    - `accountId` string — The unique identifier of the balance account for which the sweep was configured.
    - `balancePlatform` string — The unique identifier of the balance platform.
    - `sweep` SweepConfigurationV2
      - `counterparty` SweepCounterparty, required
        - `balanceAccountId` string — The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). > If you are updating the counterparty from a transfer instrument to a balance account, set `transferInstrumentId` to **null**.
        - `merchantAccount` string — The merchant account that will be the source of funds. You can only use this parameter with sweeps of `type` **pull** and if you are processing payments with Adyen.
        - `transferInstrumentId` string — The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` . To set up automated top-up sweeps to balance accounts in your [marketplace](https://docs.adyen.com/marketplaces/top-up-balance-account/#before-you-begin) or [platform](https://docs.adyen.com/platforms/top-up-balance-account/#before-you-begin), use this parameter in combination with a `merchantAccount` and a sweep `type` of **pull**. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature.> If you are updating the counterparty from a balance account to a transfer instrument, set `balanceAccountId` to **null**.
      - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances).
      - `description` string — The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters.
      - `id` string, required — The unique identifier of the sweep.
      - `reason` 'accountHierarchyNotActive' | 'amountLimitExceeded' | 'approved' | 'counterpartyAccountBlocked' | 'counterpartyAccountClosed' | 'counterpartyAccountNotFound' | 'counterpartyAddressRequired' | 'counterpartyBankTimedOut' | 'counterpartyBankUnavailable' | 'directDebitNotSupported' | 'error' | 'notEnoughBalance' | 'refusedByCounterpartyBank' | 'routeNotFound' | 'transferInstrumentDoesNotExist' | 'unknown' — The reason for disabling the sweep.
      - `reasonDetail` string — The human readable reason for disabling the sweep.
      - `reference` string — Your reference for the sweep configuration.
      - `referenceForBeneficiary` string — The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.
      - `schedule` SweepSchedule, required
        - `cronExpression` string — A [cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that is used to set the sweep schedule. The schedule uses the time zone of the balance account. For example, **30 17 * * MON** schedules a sweep every Monday at 17:30. The expression must have five values separated by a single space in the following order: * Minute: **0-59** * Hour: **0-23** * Day of the month: **1-31** * Month: **1-12** or **JAN-DEC** * Day of the week: **0-7** (0 and 7 are Sunday) or **MON-SUN**. The following non-standard characters are supported: *****, **L**, **#**, **W** and **/**. See [crontab guru](https://crontab.guru/) for more examples. Required when `type` is **cron**.
        - `type` 'daily' | 'weekly' | 'monthly' | 'balance' | 'cron', required — The schedule type. Possible values: * **cron**: push out funds based on a `cronExpression`. * **daily**: push out funds daily at 07:00 AM CET. * **weekly**: push out funds every Monday at 07:00 AM CET. * **monthly**: push out funds every first of the month at 07:00 AM CET. * **balance**: execute the sweep instantly if the `triggerAmount` is reached.
      - `status` 'active' | 'inactive' — The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered.
      - `sweepAmount` Amount
        - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.
        - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
      - `targetAmount` Amount
        - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.
        - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
      - `triggerAmount` Amount
        - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount.
        - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units).
      - `type` 'pull' | 'push' — The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account.
  - `environment` string, required — The environment from which the webhook originated. Possible values: **test**, **live**.
  - `timestamp` string, date-time — When the event was queued.
  - `type` 'balancePlatform.balanceAccountSweep.created' | 'balancePlatform.balanceAccountSweep.updated' | 'balancePlatform.balanceAccountSweep.deleted', required — Type of webhook.

## Acknowledgement `200`

OK - the request has succeeded.

- BalancePlatformNotificationResponse
  - `notificationResponse` string — Respond with any **2xx** HTTP status code to [accept the webhook](https://docs.adyen.com/development-resources/webhooks/#accept-webhooks).

---

[API](https://skmtc.dev/adyen/apis/configuration-webhooks.md) · [All operations](https://skmtc.dev/adyen/apis/configuration-webhooks/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adyen/configuration-webhooks/revisions/74e0766552b1/schema)