UpdateSweepConfigurationV2 class abstract

UpdateSweepConfigurationV2

Properties:

  • category - 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.
  • counterparty - The destination or the source of the funds, depending on the sweep type. Either a balanceAccountId, transferInstrumentId, or merchantAccount is required.
  • currency - The three-character ISO currency code in uppercase. For example, EUR. The sweep currency must match any of the balances currencies.
  • description - 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.
  • id - The unique identifier of the sweep.
  • priorities - 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, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on. The request will be accepted as long as at least one of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide [\"wire\",\"regular\"], and wire is not supported but regular is, the request will still be accepted and processed. Possible values: * regular: For normal, low-value transactions. * fast: A faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * wire: The fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * instant: For instant funds transfers within the United States and in SEPA locations. * crossBorder: For high-value transfers to a recipient in a different country. * internal: For transfers to an Adyen-issued business bank account (by bank account number/IBAN). Set category to bank. For more details, see optional priorities setup for marketplaces or platforms.
  • reason - The reason for disabling the sweep.
  • reasonDetail - The human readable reason for disabling the sweep.
  • reference - Your reference for the sweep configuration.
  • referenceForBeneficiary - The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.
  • schedule - 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 - 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.
  • sweepAmount - The amount that must be pushed out or pulled in. You can configure either sweepAmount or targetAmount, not both.
  • targetAmount - The amount that must be available in the balance account after the sweep. You can configure either sweepAmount or targetAmount, not both.
  • triggerAmount - 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.
  • type - 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.
Annotations
  • @BuiltValue.new()

Constructors

UpdateSweepConfigurationV2([void updates(UpdateSweepConfigurationV2Builder b)])
factory

Properties

category → UpdateSweepConfigurationV2CategoryEnum?
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.
no setter
counterparty → SweepCounterparty?
The destination or the source of the funds, depending on the sweep type. Either a balanceAccountId, transferInstrumentId, or merchantAccount is required.
no setter
currency → String?
The three-character ISO currency code in uppercase. For example, EUR. The sweep currency must match any of the balances currencies.
no setter
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 140 characters.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String?
The unique identifier of the sweep.
no setter
priorities → BuiltList<UpdateSweepConfigurationV2PrioritiesEnum>?
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, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on. The request will be accepted as long as at least one of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide [\"wire\",\"regular\"], and wire is not supported but regular is, the request will still be accepted and processed. Possible values: * regular: For normal, low-value transactions. * fast: A faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * wire: The fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * instant: For instant funds transfers within the United States and in SEPA locations. * crossBorder: For high-value transfers to a recipient in a different country. * internal: For transfers to an Adyen-issued business bank account (by bank account number/IBAN). Set category to bank. For more details, see optional priorities setup for marketplaces or platforms.
no setter
reason → UpdateSweepConfigurationV2ReasonEnum?
The reason for disabling the sweep.
no setter
reasonDetail → String?
The human readable reason for disabling the sweep.
no setter
reference → String?
Your reference for the sweep configuration.
no setter
referenceForBeneficiary → String?
The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schedule → SweepSchedule?
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.
no setter
status → UpdateSweepConfigurationV2StatusEnum?
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.
no setter
sweepAmount → Amount?
The amount that must be pushed out or pulled in. You can configure either sweepAmount or targetAmount, not both.
no setter
targetAmount → Amount?
The amount that must be available in the balance account after the sweep. You can configure either sweepAmount or targetAmount, not both.
no setter
triggerAmount → Amount?
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.
no setter
type → UpdateSweepConfigurationV2TypeEnum?
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.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(UpdateSweepConfigurationV2Builder)) → UpdateSweepConfigurationV2
Rebuilds the instance.
inherited
toBuilder() → UpdateSweepConfigurationV2Builder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<UpdateSweepConfigurationV2>
no setter