Sign in

v1

latestOpenAPI 3.1.02026-07-201774202.6 KB
Account holders

Update payout or processing state

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

post/updateAccountHolderState

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.

submittedAsyncboolean

Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:

  • true: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
  • false: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.