Changes the status of an account holder to Suspended.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
The request has succeeded.
Show more Show lessThe new status of the Account Holder.
A list of events scheduled for the account holder.
The event.
Permitted values:
InactivateAccount,RefundNotPaidOutTransfers. For more information, refer to Verification checks.
The payout state of the account holder.
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.
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.
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.
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.
The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.
The amount of the transaction, in minor units.
The processing state of the account holder.
The lower bound of the processing tier (i.e., an account holder must have processed at least this amount of money in order to be placed into this tier).
The amount of the transaction, in minor units.
The upper bound of the processing tier (i.e., an account holder must have processed less than this amount of money in order to be placed into this tier).
The amount of the transaction, in minor units.
The status of the account holder.
Permitted values:
Active,Inactive,Suspended,Closed.
Contains field validation errors that would prevent requests from being processed.
The type of error field.
The request has been accepted for processing, but the processing has not been completed.
Show more Show lessThe new status of the Account Holder.
A list of events scheduled for the account holder.
The event.
Permitted values:
InactivateAccount,RefundNotPaidOutTransfers. For more information, refer to Verification checks.
The payout state of the account holder.
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.
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.
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.
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.
The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.
The amount of the transaction, in minor units.
The processing state of the account holder.
The lower bound of the processing tier (i.e., an account holder must have processed at least this amount of money in order to be placed into this tier).
The amount of the transaction, in minor units.
The upper bound of the processing tier (i.e., an account holder must have processed less than this amount of money in order to be placed into this tier).
The amount of the transaction, in minor units.
The status of the account holder.
Permitted values:
Active,Inactive,Suspended,Closed.
Contains field validation errors that would prevent requests from being processed.
The type of error field.