Close an account holder

post/closeAccountHolder

Changes the status of an account holder to Closed. This state is final. If an account holder is closed, you can't process transactions, pay out funds, or reopen it. If payments are made to an account of an account holder with a Closed status, the payments are sent to your liable account.

Endpoint destination URL

https://cal-test.adyen.com/cal/services/Account/v5/closeAccountHolder

Request Parameters

Required

Optional

The code of the Account Holder to be closed.

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
accountHolderStatusobject
The new status of the Account Holder.
Show children Hide children
eventsarray[object]
A list of events scheduled for the account holder.
Show children Hide children
eventstring
The event.

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

executionDatestring
The date on which the event will take place.
reasonstring
The reason why this event has been created.
payoutStateobject
The payout state of the account holder.
Show children Hide children
allowPayoutboolean
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.
disableReasonstring
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.
disabledboolean
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.
notAllowedReasonstring
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.
payoutLimitobject
The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
tierNumberinteger
The payout tier that the account holder occupies.
processingStateobject
The processing state of the account holder.
Show children Hide children
disableReasonstring
The reason why processing has been disabled.
disabledboolean
Indicates whether the processing of payments is allowed.
processedFromobject
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
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
processedToobject
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
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
tierNumberinteger
The processing tier that the account holder occupies.
statusstring
The status of the account holder.

Permitted values: Active, Inactive, Suspended, Closed.

statusReasonstring
The reason why the status was assigned to the account holder.
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
Show children Hide children
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
Show children Hide children
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
202 - Accepted
The request has been accepted for processing, but the processing has not been completed.
Show more Show less
accountHolderStatusobject
The new status of the Account Holder.
Show children Hide children
eventsarray[object]
A list of events scheduled for the account holder.
Show children Hide children
eventstring
The event.

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

executionDatestring
The date on which the event will take place.
reasonstring
The reason why this event has been created.
payoutStateobject
The payout state of the account holder.
Show children Hide children
allowPayoutboolean
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.
disableReasonstring
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.
disabledboolean
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.
notAllowedReasonstring
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.
payoutLimitobject
The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.
Show children Hide children
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
tierNumberinteger
The payout tier that the account holder occupies.
processingStateobject
The processing state of the account holder.
Show children Hide children
disableReasonstring
The reason why processing has been disabled.
disabledboolean
Indicates whether the processing of payments is allowed.
processedFromobject
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
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
processedToobject
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
currencystring
Min length: 3Max length: 3
The three-character ISO currency code.
valueinteger
The amount of the transaction, in minor units.
tierNumberinteger
The processing tier that the account holder occupies.
statusstring
The status of the account holder.

Permitted values: Active, Inactive, Suspended, Closed.

statusReasonstring
The reason why the status was assigned to the account holder.
invalidFieldsarray[object]
Contains field validation errors that would prevent requests from being processed.
Show children Hide children
errorCodeinteger
The validation error code.
errorDescriptionstring
A description of the validation error.
fieldTypeobject
The type of error field.
Show children Hide children
fieldstring
The full name of the property.
fieldNamestring
The type of the field.
shareholderCodestring
The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
400 - Bad Request
A problem reading or understanding the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
Show more Show less
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Close an account holder

Request Parameters

Response parameters

HTTP Responses

200 - OK

202 - Accepted

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error