Creates a sweep that results in moving funds from or to a balance account.
A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.
The unique identifier of the balance account.
The type of transfer that results from the sweep.
Possible values:
bank: Sweep to a transfer instrument.
internal: Transfer to another balance account within your platform.
Required when setting priorities.
The destination or the source of the funds, depending on the sweep type.
Either a balanceAccountId, transferInstrumentId, or merchantAccount is required.
The three-character ISO currency code in uppercase. For example, EUR.
The sweep currency must match any of the balances currencies.
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.
The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority listed first, and if that's not possible, it moves on to the next option in the order of provided priorities.
Possible values:
regular: For normal, low-value transactions.
fast: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions.
wire: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions.
instant: Instant way to transfer funds in SEPA countries.
crossBorder: High-value transfer to a recipient in a different country.
internal: Transfer to an Adyen-issued business bank account (by bank account number/IBAN).
Set category to bank. For more details, see optional priorities setup.
The schedule when the triggerAmount is evaluated. If the balance meets the threshold, funds are pushed out of or pulled in to the balance account.
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.
The amount that must be pushed out or pulled in. You can configure either sweepAmount or targetAmount, not both.
The amount that must be available in the balance account after the sweep. You can configure either sweepAmount or targetAmount, not both.
The threshold amount that triggers the sweep. If not provided, by default, the amount is set to zero. The triggerAmount is evaluated according to the specified schedule.type.
For type pull, if the balance is less than or equal to the triggerAmount, funds are pulled in to the balance account.
For type push, if the balance is more than or equal to the triggerAmount, funds are pushed out of the balance account.
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.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.