Account v6 - Update payout or processing state

Request parameters

Required Optional

accountHolderCode string Required

The code of the Account Holder on which to update the state.

disable boolean Required

If true, disable the requested state. If false, enable the requested state.

reason string

The reason that the state is being updated.

Required if the state is being disabled.

stateType string Required

The state to be updated.

Permitted values are: Processing, Payout

Response parameters

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.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
accountHolderCode string

The code of the Account Holder.

accountHolderStatus object

The status of the Account Holder.

Show children Hide children

events array [object]

A list of events scheduled for the account holder.

Show children Hide children

event string

The event.

Permitted values: InactivateAccount, RefundNotPaidOutTransfers. For more information, refer to Verification checks.

executionDate string

The date on which the event will take place.

reason string

The reason why this event has been created.

payoutState object

The payout state of the account holder.

Show children Hide children

allowPayout boolean

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 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.

disabled boolean

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 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.

payoutLimit object

The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.

Show children Hide children

currency string

Min length: 3 Max length: 3

The three-character ISO currency code.

value integer

The amount of the transaction, in minor units.

tierNumber integer

The payout tier that the account holder occupies.

processingState object

The processing state of the account holder.

Show children Hide children

disableReason string

The reason why processing has been disabled.

disabled boolean

Indicates whether the processing of payments is allowed.

processedFrom object

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).

Show children Hide children

currency string

Min length: 3 Max length: 3

The three-character ISO currency code.

value integer

The amount of the transaction, in minor units.

processedTo object

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).

Show children Hide children

currency string

Min length: 3 Max length: 3

The three-character ISO currency code.

value integer

The amount of the transaction, in minor units.

tierNumber integer

The processing tier that the account holder occupies.

status string

The status of the account holder.

Permitted values: Active, Inactive, Suspended, Closed.

statusReason string

The reason why the status was assigned to the account holder.

invalidFields array [object]

Contains field validation errors that would prevent requests from being processed.

Show children Hide children

errorCode integer

The validation error code.

errorDescription string

A description of the validation error.

fieldType object

The type of error field.

Show children Hide children

field string

The full name of the property.

fieldName string

The type of the field.

shareholderCode string

The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.

pspReference string

The reference of a request. Can be used to uniquely identify the request.

resultCode string

The result code.
202 - Accepted

The request has been accepted for processing, but the processing has not been completed.
Show more Show less
accountHolderCode string

The code of the Account Holder.

accountHolderStatus object

The status of the Account Holder.

Show children Hide children

events array [object]

A list of events scheduled for the account holder.

Show children Hide children

event string

The event.

Permitted values: InactivateAccount, RefundNotPaidOutTransfers. For more information, refer to Verification checks.

executionDate string

The date on which the event will take place.

reason string

The reason why this event has been created.

payoutState object

The payout state of the account holder.

Show children Hide children

allowPayout boolean

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 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.

disabled boolean

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 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.

payoutLimit object

The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.

Show children Hide children

currency string

Min length: 3 Max length: 3

The three-character ISO currency code.

value integer

The amount of the transaction, in minor units.

tierNumber integer

The payout tier that the account holder occupies.

processingState object

The processing state of the account holder.

Show children Hide children

disableReason string

The reason why processing has been disabled.

disabled boolean

Indicates whether the processing of payments is allowed.

processedFrom object

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).

Show children Hide children

currency string

Min length: 3 Max length: 3

The three-character ISO currency code.

value integer

The amount of the transaction, in minor units.

processedTo object

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).

Show children Hide children

currency string

Min length: 3 Max length: 3

The three-character ISO currency code.

value integer

The amount of the transaction, in minor units.

tierNumber integer

The processing tier that the account holder occupies.

status string

The status of the account holder.

Permitted values: Active, Inactive, Suspended, Closed.

statusReason string

The reason why the status was assigned to the account holder.

invalidFields array [object]

Contains field validation errors that would prevent requests from being processed.

Show children Hide children

errorCode integer

The validation error code.

errorDescription string

A description of the validation error.

fieldType object

The type of error field.

Show children Hide children

field string

The full name of the property.

fieldName string

The type of the field.

shareholderCode string

The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.

pspReference string

The reference of a request. Can be used to uniquely identify the request.

resultCode string

The result code.
400 - Bad Request

A problem reading or understanding the request.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
401 - Unauthorized

Authentication required.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
403 - Forbidden

Insufficient permissions to process the request.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
422 - Unprocessable Entity

A request validation error.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
500 - Internal Server Error

The server could not process the request.
Show more Show less
errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.

Update payout or processing state

Endpoint destination URL

Request parameters

Response parameters

HTTP Responses

200 - OK

202 - Accepted

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error