Adyen · Schema
SweepConfigurationV2
SweepConfigurationV2 schema from Adyen API
PaymentsFinancial ServicesFintech
Properties
| Name | Type | Description |
|---|---|---|
| counterparty | object | The destination or the source of the funds, depending on the `type`. Either a `balanceAccountId`, `transferInstrumentId`, or `merchantAccount` is required. |
| currency | string | 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]( |
| 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 14 |
| id | string | The unique identifier of the sweep. |
| schedule | object | 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. |
| status | string | 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 conf |
| sweepAmount | object | The amount that must be pushed out or pulled in. You can configure either `sweepAmount` or `targetAmount`, not both. |
| targetAmount | object | The amount that must be available in the balance account after the sweep. You can configure either `sweepAmount` or `targetAmount`, not both. |
| triggerAmount | object | 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** |
| type | string | 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 destina |