| Name | Type | Description | Notes |
|---|---|---|---|
| counterparty | SweepCounterparty | ||
| currency | kotlin.String | The three-character ISO currency code in uppercase. For example, EUR. The sweep currency must match any of the balances currencies. | |
| schedule | SweepSchedule | ||
| category | inline | 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`. | [optional] |
| description | kotlin.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. | [optional] |
| priorities | inline | 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. | [optional] |
| reason | inline | The reason for disabling the sweep. | [optional] [readonly] |
| status | inline | 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. | [optional] |
| sweepAmount | Amount | [optional] | |
| targetAmount | Amount | [optional] | |
| triggerAmount | Amount | [optional] | |
| type | inline | 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. | [optional] |
| Name | Value |
|---|---|
| category | bank, internal, platformPayment |
| Name | Value |
|---|---|
| priorities | crossBorder, fast, instant, internal, regular, wire |
| Name | Value |
|---|---|
| reason | amountLimitExceeded, approved, balanceAccountTemporarilyBlockedByTransactionRule, counterpartyAccountBlocked, counterpartyAccountClosed, counterpartyAccountNotFound, counterpartyAddressRequired, counterpartyBankTimedOut, counterpartyBankUnavailable, declinedByTransactionRule, error, notEnoughBalance, refusedByCounterpartyBank, routeNotFound, scaFailed, unknown |
| Name | Value |
|---|---|
| status | active, inactive |
| Name | Value |
|---|---|
| type | pull, push |