PayoutState

This object contains information on the current payout state of the account holder.

Field Type Required Description
allowPayout Boolean (error) Indicates whether a payout is allowed.
disabled Boolean (error) Indicates whether the payout schedule is disabled for all accounts of this account holder.
disableReason String (error) If the payout schedule was disabled, this value stores the disabling reason.
payoutLimit Amount (error)

In case the payout is allowed but limited, this value stores the maximum allowed value to be paid out.

tierNumber Integer (error)

V3 This object was added in the version 3.

The tier, in which the account holder currently resides.