Skip to main content

This enumeration type lists the different possible instrument statuses that can be returned with the getPayoutSettings method.

Note: Payout splits can only be modified for accounts in ACTIVE state.

Type that uses InstrumentStatusEnum

PayoutInstrument

Call that uses InstrumentStatusEnum

GET
/payout_settings

Enumerations

Value
Description
PENDING
This enumerated value indicates that this account must be verified before it can be used.
ACTIVE
This enumerated value indicates that payouts are enabled on this account.
VERIFICATION_FAILED
This enumerated value indicates that verification has failed for this account and payouts are disabled. This account must be verified and updated by the seller before it can be used.
INACTIVE
This enumerated value indicates that this account has become inactive and payouts are disabled. This account must be verified and updated by the seller before it can be used.