Account holders

Update payout or processing state

Changed on

Disables or enables the processing or payout state of an account holder.

post/updateAccountHolderState

Request

  • Base URL
    https://cal-test.adyen.com/cal/services/Account/v5
  • URL
    https://cal-test.adyen.com/cal/services/Account/v5/updateAccountHolderState
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Request body

accountHolderCodestring required

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

disableboolean required

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

reasonstring

The reason that the state is being updated.

Required if the state is being disabled.

stateType'LimitedPayout' | 'LimitedProcessing' | 'LimitlessPayout' | 'LimitlessProcessing' | 'Payout' | 'Processing' required

The state to be updated.

Permitted values are: Processing, Payout

Response

OK - the request has succeeded.

accountHolderCodestring

The code of the Account Holder.

pspReferencestring

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

resultCodestring

The result code.

Changes

    • warning

      added the new linkedViasVirtualAccount enum value to the /// response property for the response status

    • warning

      added the new linkedViasVirtualAccount enum value to the /// response property for the response status

    • warning

      added the new payoutMethod enum value to the /// response property for the response status

    • warning

      added the new payoutMethod enum value to the /// response property for the response status