Adyen · JSON Structure

Accounts Update Account Holder State Request Structure

UpdateAccountHolderStateRequest schema from Adyen API

Type: object Properties: 4 Required: 3
PaymentsFinancial ServicesFintech

UpdateAccountHolderStateRequest is a JSON Structure definition published by Adyen, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

accountHolderCode disable reason stateType

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/accounts-update-account-holder-state-request-structure.json",
  "description": "UpdateAccountHolderStateRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "accountHolderCode": {
      "description": "The code of the Account Holder on which to update the state.",
      "type": "string"
    },
    "disable": {
      "description": "If true, disable the requested state.  If false, enable the requested state.",
      "type": "boolean"
    },
    "reason": {
      "description": "The reason that the state is being updated.\n>Required if the state is being disabled.",
      "type": "string"
    },
    "stateType": {
      "description": "The state to be updated.\n>Permitted values are: `Processing`, `Payout`",
      "enum": [
        "LimitedPayout",
        "LimitedProcessing",
        "LimitlessPayout",
        "LimitlessProcessing",
        "Payout",
        "Processing"
      ],
      "type": "string"
    }
  },
  "required": [
    "accountHolderCode",
    "stateType",
    "disable"
  ],
  "name": "UpdateAccountHolderStateRequest"
}