---
title: "Changes to Update a sweep"
method: PATCH
path: "/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}"
---

# Changes to Update a sweep

`PATCH /balanceAccounts/{balanceAccountId}/sweeps/{sweepId}`

> Every recorded change to this endpoint, newest first.

## Timeline

Changed in 15 of 51 revisions.

- **2026-05-19** (v2) `87544766dc8e` — 2 info
- **2026-01-21** (v2) `0d06f978a8b5` — 20 info
- **2025-11-19** (v2) `4cd18d5551af` — 1 warning, 1 info
- **2025-09-09** (v2) `dd6159049c95` — 6 breaking, 3 info
- **2025-07-29** (v2) `9fede8325f6d` — 1 warning, 1 info
- **2025-03-20** (v2) `e69e67d2e692` — 1 warning, 1 info
- **2024-11-20** (v2) `61259c9969a5` — 1 info
- **2024-11-13** (v2) `5c1b264dd7b8` — 1 warning, 1 info
- **2024-10-10** (v2) `80dfacd37eec` — 4 warning, 4 info
- **2024-06-20** (v2) `f874764bcf8b` — 1 warning, 1 info
- **2024-04-26** (v2) `6f1fad79c6c0` — 1 warning, 5 info
- **2024-01-16** (v2) `24691235e721` — 1 info
- **2023-11-14** (v2) `12a0c6036e6b` — 10 warning
- **2023-10-19** (v2) `78e297a2eb6f` — 1 breaking, 3 warning, 4 info
- **2023-08-09** (v2) `ad8e1da0fe30` — 2 warning

## Changes

- **2026-05-19** (v2) `87544766dc8e` — 2 info
  - api tag `Custom payout schedules (sweeps)` added
  - api tag `Balance accounts` removed
- **2026-01-21** (v2) `0d06f978a8b5` — 20 info
  - removed the enum value `approvalExpired` of the request read-only property `reason`
  - removed the enum value `balanceAccountTemporarilyBlockedByTransactionRule` of the request read-only property `reason`
  - removed the enum value `declined` of the request read-only property `reason`
  - removed the enum value `declinedByTransactionRule` of the request read-only property `reason`
  - removed the enum value `pending` of the request read-only property `reason`
  - removed the enum value `pendingApproval` of the request read-only property `reason`
  - removed the enum value `pendingExecution` of the request read-only property `reason`
  - removed the enum value `refusedByCustomer` of the request read-only property `reason`
  - removed the enum value `scaFailed` of the request read-only property `reason`
  - removed the enum value `schemeAdvice` of the request read-only property `reason`
  - removed the `approvalExpired` enum value from the `reason` response property for the response status `200`
  - removed the `balanceAccountTemporarilyBlockedByTransactionRule` enum value from the `reason` response property for the response status `200`
  - removed the `declined` enum value from the `reason` response property for the response status `200`
  - removed the `declinedByTransactionRule` enum value from the `reason` response property for the response status `200`
  - removed the `pending` enum value from the `reason` response property for the response status `200`
  - removed the `pendingApproval` enum value from the `reason` response property for the response status `200`
  - removed the `pendingExecution` enum value from the `reason` response property for the response status `200`
  - removed the `refusedByCustomer` enum value from the `reason` response property for the response status `200`
  - removed the `scaFailed` enum value from the `reason` response property for the response status `200`
  - removed the `schemeAdvice` enum value from the `reason` response property for the response status `200`
- **2025-11-19** (v2) `4cd18d5551af` — 1 warning, 1 info
  - added the new `schemeAdvice` enum value to the `reason` response property for the response status `200`
  - added the new `schemeAdvice` enum value to the request property `reason`
- **2025-09-09** (v2) `dd6159049c95` — 6 breaking, 3 info
  - the `sweepAmount/currency` response property's maxLength was unset from `3` for the response status `200`
  - the `targetAmount/currency` response property's maxLength was unset from `3` for the response status `200`
  - the `triggerAmount/currency` response property's maxLength was unset from `3` for the response status `200`
  - the `sweepAmount/currency` response property's minLength was decreased from `3` to `0` for the response status `200`
  - the `targetAmount/currency` response property's minLength was decreased from `3` to `0` for the response status `200`
  - the `triggerAmount/currency` response property's minLength was decreased from `3` to `0` for the response status `200`
  - the `sweepAmount/currency` request property's minLength was decreased from `3` to `0`
  - the `targetAmount/currency` request property's minLength was decreased from `3` to `0`
  - the `triggerAmount/currency` request property's minLength was decreased from `3` to `0`
- **2025-07-29** (v2) `9fede8325f6d` — 1 warning, 1 info
  - added the new `approvalExpired` enum value to the `reason` response property for the response status `200`
  - added the new `approvalExpired` enum value to the request property `reason`
- **2025-03-20** (v2) `e69e67d2e692` — 1 warning, 1 info
  - added the new `pending` enum value to the `reason` response property for the response status `200`
  - added the new `pending` enum value to the request property `reason`
- **2024-11-20** (v2) `61259c9969a5` — 1 info
  - added the optional property `reasonDetail` to the response with the `200` status
- **2024-11-13** (v2) `5c1b264dd7b8` — 1 warning, 1 info
  - added the new `refusedByCustomer` enum value to the `reason` response property for the response status `200`
  - added the new `refusedByCustomer` enum value to the request property `reason`
- **2024-10-10** (v2) `80dfacd37eec` — 4 warning, 4 info
  - added the new `accountHierarchyNotActive` enum value to the `reason` response property for the response status `200`
  - added the new `directDebitNotSupported` enum value to the `reason` response property for the response status `200`
  - added the new `pendingExecution` enum value to the `reason` response property for the response status `200`
  - added the new `transferInstrumentDoesNotExist` enum value to the `reason` response property for the response status `200`
  - added the new `accountHierarchyNotActive` enum value to the request property `reason`
  - added the new `directDebitNotSupported` enum value to the request property `reason`
  - added the new `pendingExecution` enum value to the request property `reason`
  - added the new `transferInstrumentDoesNotExist` enum value to the request property `reason`
- **2024-06-20** (v2) `f874764bcf8b` — 1 warning, 1 info
  - added the new `declined` enum value to the `reason` response property for the response status `200`
  - added the new `declined` enum value to the request property `reason`
- **2024-04-26** (v2) `6f1fad79c6c0` — 1 warning, 5 info
  - added the new `pendingApproval` enum value to the `reason` response property for the response status `200`
  - added the new optional request property `reference`
  - added the new optional request property `referenceForBeneficiary`
  - added the new `pendingApproval` enum value to the request property `reason`
  - added the optional property `reference` to the response with the `200` status
  - added the optional property `referenceForBeneficiary` to the response with the `200` status
- **2024-01-16** (v2) `24691235e721` — 1 info
  - the endpoint scheme security `clientKey` was added to the API
- **2023-11-14** (v2) `12a0c6036e6b` — 10 warning
  - removed the optional property `response/paths` from the response with the `400` status
  - removed the optional property `response/paths` from the response with the `401` status
  - removed the optional property `response/paths` from the response with the `403` status
  - removed the optional property `response/paths` from the response with the `422` status
  - removed the optional property `response/paths` from the response with the `500` status
  - removed the optional property `response/rootPath` from the response with the `400` status
  - removed the optional property `response/rootPath` from the response with the `401` status
  - removed the optional property `response/rootPath` from the response with the `403` status
  - removed the optional property `response/rootPath` from the response with the `422` status
  - removed the optional property `response/rootPath` from the response with the `500` status
- **2023-10-19** (v2) `78e297a2eb6f` — 1 breaking, 3 warning, 4 info
  - removed the enum value `directDebit` of the request property `priorities/items/`
  - added the new `balanceAccountTemporarilyBlockedByTransactionRule` enum value to the `reason` response property for the response status `200`
  - added the new `declinedByTransactionRule` enum value to the `reason` response property for the response status `200`
  - added the new `scaFailed` enum value to the `reason` response property for the response status `200`
  - added the new `balanceAccountTemporarilyBlockedByTransactionRule` enum value to the request property `reason`
  - added the new `declinedByTransactionRule` enum value to the request property `reason`
  - added the new `scaFailed` enum value to the request property `reason`
  - removed the `directDebit` enum value from the `priorities/items/` response property for the response status `200`
- **2023-08-09** (v2) `ad8e1da0fe30` — 2 warning
  - removed the request property `balanceAccountId`
  - removed the request property `transferInstrumentId`

---

[Operation](https://skmtc.dev/adyen/apis/balanceplatformservice/docs/balanceAccounts/:balanceAccountId/sweeps/:sweepId/patch.md) · [API](https://skmtc.dev/adyen/apis/balanceplatformservice.md) · [Page](https://skmtc.dev/adyen/apis/balanceplatformservice/changes/balanceAccounts/:balanceAccountId/sweeps/:sweepId/patch)
