---
title: "Update a RecurringTopUp"
method: PATCH
path: "/balanceAccounts/{balanceAccountId}/recurringTopUps/{topUpId}"
tags: ["Recurring top ups"]
---

# Update a RecurringTopUp

`PATCH /balanceAccounts/{balanceAccountId}/recurringTopUps/{topUpId}`

Update the configuration of an existing recurring top up.

For more information, refer to [Manage recurring top-ups](https://docs.adyen.com/issuing/add-manage-funds/top-ups/manage-recurring-top-ups).

## Path parameters

- `balanceAccountId` string, required
- `topUpId` string, required

## Request body

- PatchableCreateRecurringTopUp
  - `description` string — Your description for the recurring top-up. Maximum length is 140 characters. If you set a longer description, it will be cut off at 140 characters.
  - `referenceForBeneficiary` string, nullable — A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both parties involved in the funds movement. Supported characters: **a-z**, **A-Z**, **0-9**.
  - `status` 'active' | 'inactive', nullable — The status of the recurring top-up. If not provided, by default, this is set to **active**. Possible values: * **active**: the top up is enabled and funds will be pulled in. * **inactive**: the top up is disabled and cannot be triggered.
  - `topUpAmount` PatchableTopUpAmount
    - `fixed` object, nullable — The fixed amount with which you want to top up the balance account.
      - `currency` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
      - `value` integer — The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
    - `target` object, nullable — The target balance for the balance account that the top-up must achieve.
      - `currency` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
      - `value` integer — The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
  - `trigger` PatchableTrigger
    - `schedule` object, nullable — Contains the details about the schedule that determines when the top up is executed.
      - `type` 'weekdays' | 'weekly' | 'monthly'
    - `threshold` PatchableAmountDTO
      - `currency` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
      - `value` integer — The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

## Response `200`

OK - the request has succeeded.

- RecurringTopUp
  - `counterparty` TopUpCounterparty, required
    - `transferInstrumentId` string, required — The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) that is funding the top-up.
  - `description` string, required — Your description for the recurring top-up. Maximum length is 140 characters. If you set a longer description, it will be cut off at 140 characters.
  - `id` string, required — The unique identifier of the top up.
  - `referenceForBeneficiary` string — A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both parties involved in the funds movement. Supported characters: **a-z**, **A-Z**, **0-9**.
  - `status` 'active' | 'inactive' — The status of the recurring top-up. If not provided, by default, this is set to **active**. Possible values: * **active**: the top up is enabled and funds will be pulled in. * **inactive**: the top up is disabled and cannot be triggered.
  - `topUpAmount` TopUpAmount, required
    - `fixed` AmountDTO
      - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
      - `value` integer, required — The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
    - `target` AmountDTO
      - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
      - `value` integer, required — The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
  - `trigger` Trigger, required
    - `schedule` Schedule
      - `type` 'weekdays' | 'weekly' | 'monthly', required
    - `threshold` AmountDTO, required
      - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
      - `value` integer, required — The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

## Other responses

- `400` — Bad Request - a problem reading or understanding the request.
- `401` — Unauthorized - authentication required.
- `403` — Forbidden - insufficient permissions to process the request.
- `422` — Unprocessable Entity - a request validation error.

---

[API](https://skmtc.net/adyen/apis/balanceplatformservice.md) · [All operations](https://skmtc.net/adyen/apis/balanceplatformservice/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adyen/balanceplatformservice/revisions/8761ac1a9aab/schema)