AccountPayoutState class abstract

AccountPayoutState

Properties:

  • allowPayout - Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.
  • disableReason - The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the disabled field is true, this field can be used to explain why.
  • disabled - Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, allowPayout will be false and no payouts will be permitted for any of the account holder's accounts. If this field is false, allowPayout may or may not be enabled, depending on other factors.
  • notAllowedReason - The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen.
  • payoutLimit - The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.
  • tierNumber - The payout tier that the account holder occupies.
Annotations
  • @BuiltValue.new()

Constructors

AccountPayoutState([void updates(AccountPayoutStateBuilder b)])
factory

Properties

allowPayout → bool?
Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts.
no setter
disabled → bool?
Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, allowPayout will be false and no payouts will be permitted for any of the account holder's accounts. If this field is false, allowPayout may or may not be enabled, depending on other factors.
no setter
disableReason → String?
The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the disabled field is true, this field can be used to explain why.
no setter
hashCode → int
The hash code for this object.
no setterinherited
notAllowedReason → String?
The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen.
no setter
payoutLimit → Amount?
The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tierNumber → int?
The payout tier that the account holder occupies.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(AccountPayoutStateBuilder)) → AccountPayoutState
Rebuilds the instance.
inherited
toBuilder() → AccountPayoutStateBuilder
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<AccountPayoutState>
no setter