openapi: 3.1.0
info:
  version: '6'
  x-publicVersion: true
  title: Adyen Account acceptDispute Holders API
  description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```"
  x-timestamp: '2023-05-30T15:27:20Z'
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://cal-test.adyen.com/cal/services/Account/v6
tags:
- name: Holders
paths:
  /checkAccountHolder:
    post:
      tags:
      - Holders
      summary: Adyen Trigger Verification
      description: Triggers the verification of an account holder even if the checks are not yet required for the volume that they are currently processing.
      x-addedInVersion: '5'
      operationId: post-checkAccountHolder
      x-groupName: Verification
      x-sortIndex: 3
      x-methodName: checkAccountHolder
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/post-checkAccountHolder-basic'
            schema:
              $ref: '#/components/schemas/PerformVerificationRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              examples:
                post-checkAccountHolder200Example:
                  summary: Default post-checkAccountHolder 200 response
                  x-microcks-default: true
                  value:
                    invalidFields:
                    - example_value
                    pspReference: REF-001
                    resultCode: CODE123
          description: OK - the request has succeeded.
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              examples:
                post-checkAccountHolder202Example:
                  summary: Default post-checkAccountHolder 202 response
                  x-microcks-default: true
                  value:
                    invalidFields:
                    - example_value
                    pspReference: REF-001
                    resultCode: CODE123
          description: Accepted - the request has been accepted for processing, but the processing has not been completed.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-checkAccountHolder401Example:
                  summary: Default post-checkAccountHolder 401 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-checkAccountHolder422Example:
                  summary: Default post-checkAccountHolder 422 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-checkAccountHolder500Example:
                  summary: Default post-checkAccountHolder 500 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /closeAccountHolder:
    post:
      tags:
      - Holders
      summary: Adyen Close an Account Holder
      description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) 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`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status), the payments are sent to your liable account.
      operationId: post-closeAccountHolder
      x-groupName: Account holders
      x-sortIndex: 7
      x-methodName: closeAccountHolder
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/post-closeAccountHolder-basic'
            schema:
              $ref: '#/components/schemas/CloseAccountHolderRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseAccountHolderResponse'
              examples:
                post-closeAccountHolder200Example:
                  summary: Default post-closeAccountHolder 200 response
                  x-microcks-default: true
                  value:
                    accountHolderStatus: active
                    invalidFields:
                    - example_value
                    pspReference: REF-001
                    resultCode: CODE123
          description: OK - the request has succeeded.
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloseAccountHolderResponse'
              examples:
                post-closeAccountHolder202Example:
                  summary: Default post-closeAccountHolder 202 response
                  x-microcks-default: true
                  value:
                    accountHolderStatus: active
                    invalidFields:
                    - example_value
                    pspReference: REF-001
                    resultCode: CODE123
          description: Accepted - the request has been accepted for processing, but the processing has not been completed.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-closeAccountHolder401Example:
                  summary: Default post-closeAccountHolder 401 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-closeAccountHolder422Example:
                  summary: Default post-closeAccountHolder 422 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-closeAccountHolder500Example:
                  summary: Default post-closeAccountHolder 500 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /createAccountHolder:
    post:
      tags:
      - Holders
      summary: Adyen Create an Account Holder
      description: Creates an account holder that [represents the sub-merchant's entity](https://docs.adyen.com/marketplaces-and-platforms/classic/account-structure#your-platform) in your platform. The details that you need to provide in the request depend on the sub-merchant's legal entity type. For more information, refer to [Account holder and accounts](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#legal-entity-types).
      operationId: post-createAccountHolder
      x-groupName: Account holders
      x-sortIndex: 1
      x-methodName: createAccountHolder
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              business:
                $ref: '#/components/examples/post-createAccountHolder-business'
              individual:
                $ref: '#/components/examples/post-createAccountHolder-individual'
            schema:
              $ref: '#/components/schemas/CreateAccountHolderRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccountHolderResponse'
              examples:
                post-createAccountHolder200Example:
                  summary: Default post-createAccountHolder 200 response
                  x-microcks-default: true
                  value:
                    accountCode: CODE123
                    accountHolderCode: CODE123
                    accountHolderDetails: example_value
                    accountHolderStatus: active
                    description: A sample description for this resource.
                    invalidFields:
                    - example_value
                    legalEntity: Business
                    primaryCurrency: USD
                    pspReference: REF-001
                    resultCode: CODE123
                    verification: example_value
                    verificationProfile: example_value
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-createAccountHolder401Example:
                  summary: Default post-createAccountHolder 401 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-createAccountHolder422Example:
                  summary: Default post-createAccountHolder 422 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-createAccountHolder500Example:
                  summary: Default post-createAccountHolder 500 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /getAccountHolder:
    post:
      tags:
      - Holders
      summary: Adyen Get an Account Holder
      description: Returns the details of an account holder.
      operationId: post-getAccountHolder
      x-groupName: Account holders
      x-sortIndex: 2
      x-methodName: getAccountHolder
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              accountCode:
                $ref: '#/components/examples/post-getAccountHolder-accountCode'
              accountHolderCode:
                $ref: '#/components/examples/post-getAccountHolder-accountHolderCode'
            schema:
              $ref: '#/components/schemas/GetAccountHolderRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountHolderResponse'
              examples:
                post-getAccountHolder200Example:
                  summary: Default post-getAccountHolder 200 response
                  x-microcks-default: true
                  value:
                    accountHolderCode: CODE123
                    accountHolderDetails: example_value
                    accountHolderStatus: active
                    accounts:
                    - example_value
                    description: A sample description for this resource.
                    invalidFields:
                    - example_value
                    legalEntity: Business
                    migrationData: example_value
                    primaryCurrency: USD
                    pspReference: REF-001
                    resultCode: CODE123
                    systemUpToDateTime: '2025-03-15T14:30:00Z'
                    verification: example_value
                    verificationProfile: example_value
          description: OK - the request has succeeded.
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountHolderResponse'
              examples:
                post-getAccountHolder202Example:
                  summary: Default post-getAccountHolder 202 response
                  x-microcks-default: true
                  value:
                    accountHolderCode: CODE123
                    accountHolderDetails: example_value
                    accountHolderStatus: active
                    accounts:
                    - example_value
                    description: A sample description for this resource.
                    invalidFields:
                    - example_value
                    legalEntity: Business
                    migrationData: example_value
                    primaryCurrency: USD
                    pspReference: REF-001
                    resultCode: CODE123
                    systemUpToDateTime: '2025-03-15T14:30:00Z'
                    verification: example_value
                    verificationProfile: example_value
          description: Accepted - the request has been accepted for processing, but the processing has not been completed.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-getAccountHolder401Example:
                  summary: Default post-getAccountHolder 401 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-getAccountHolder422Example:
                  summary: Default post-getAccountHolder 422 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-getAccountHolder500Example:
                  summary: Default post-getAccountHolder 500 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /suspendAccountHolder:
    post:
      tags:
      - Holders
      summary: Adyen Suspend an Account Holder
      description: Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) to **Suspended**.
      operationId: post-suspendAccountHolder
      x-groupName: Account holders
      x-sortIndex: 5
      x-methodName: suspendAccountHolder
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/post-suspendAccountHolder-basic'
            schema:
              $ref: '#/components/schemas/SuspendAccountHolderRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuspendAccountHolderResponse'
              examples:
                post-suspendAccountHolder200Example:
                  summary: Default post-suspendAccountHolder 200 response
                  x-microcks-default: true
                  value:
                    accountHolderStatus: active
                    invalidFields:
                    - example_value
                    pspReference: REF-001
                    resultCode: CODE123
          description: OK - the request has succeeded.
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuspendAccountHolderResponse'
              examples:
                post-suspendAccountHolder202Example:
                  summary: Default post-suspendAccountHolder 202 response
                  x-microcks-default: true
                  value:
                    accountHolderStatus: active
                    invalidFields:
                    - example_value
                    pspReference: REF-001
                    resultCode: CODE123
          description: Accepted - the request has been accepted for processing, but the processing has not been completed.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-suspendAccountHolder401Example:
                  summary: Default post-suspendAccountHolder 401 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-suspendAccountHolder422Example:
                  summary: Default post-suspendAccountHolder 422 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-suspendAccountHolder500Example:
                  summary: Default post-suspendAccountHolder 500 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /unSuspendAccountHolder:
    post:
      tags:
      - Holders
      summary: Adyen Unsuspend an Account Holder
      description: "Changes the [status of an account holder](https://docs.adyen.com/marketplaces-and-platforms/classic/account-holders-and-accounts#account-holder-statuses) from **Suspended** to **Inactive**. \nAccount holders can have a **Suspended** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status) if you suspend them through the [`/suspendAccountHolder`](https://docs.adyen.com/api-explorer/#/Account/v5/post/suspendAccountHolder) endpoint or if a verification deadline expires.\n\nYou can only unsuspend account holders if they do not have verification checks with a **FAILED** [`status`](https://docs.adyen.com/api-explorer/#/Account/latest/post/getAccountHolder__resParam_verification-accountHolder-checks-status)."
      operationId: post-unSuspendAccountHolder
      x-groupName: Account holders
      x-sortIndex: 6
      x-methodName: unSuspendAccountHolder
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/post-unSuspendAccountHolder-basic'
            schema:
              $ref: '#/components/schemas/UnSuspendAccountHolderRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnSuspendAccountHolderResponse'
              examples:
                post-unSuspendAccountHolder200Example:
                  summary: Default post-unSuspendAccountHolder 200 response
                  x-microcks-default: true
                  value:
                    accountHolderStatus: active
                    invalidFields:
                    - example_value
                    pspReference: REF-001
                    resultCode: CODE123
          description: OK - the request has succeeded.
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnSuspendAccountHolderResponse'
              examples:
                post-unSuspendAccountHolder202Example:
                  summary: Default post-unSuspendAccountHolder 202 response
                  x-microcks-default: true
                  value:
                    accountHolderStatus: active
                    invalidFields:
                    - example_value
                    pspReference: REF-001
                    resultCode: CODE123
          description: Accepted - the request has been accepted for processing, but the processing has not been completed.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-unSuspendAccountHolder401Example:
                  summary: Default post-unSuspendAccountHolder 401 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-unSuspendAccountHolder422Example:
                  summary: Default post-unSuspendAccountHolder 422 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-unSuspendAccountHolder500Example:
                  summary: Default post-unSuspendAccountHolder 500 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /updateAccountHolder:
    post:
      tags:
      - Holders
      summary: Adyen Update an Account Holder
      description: "Updates the `accountHolderDetails` and `processingTier` of an account holder, and adds bank accounts and shareholders.\n\nWhen updating `accountHolderDetails`, parameters that are not included in the request are left unchanged except for the following object:\n\n* `metadata`: Updating the metadata replaces the entire object. This means that to update an existing key-value pair, you must provide the changes, as well as other existing key-value pairs.\n\nWhen updating any field in the following objects, you must submit all the fields required for validation:\n\n * `address`\n\n* `fullPhoneNumber`\n\n* `bankAccountDetails.BankAccountDetail`\n\n* `businessDetails.shareholders.ShareholderContact`\n\n For example, to update the `address.postalCode`, you must also submit the `address.country`, `.city`, `.street`, `.postalCode`, and possibly `.stateOrProvince` so that the address can be validated.\n\nTo add a bank account or shareholder, provide the bank account or shareholder details without a `bankAccountUUID` or a `shareholderCode`.\n\n"
      operationId: post-updateAccountHolder
      x-groupName: Account holders
      x-sortIndex: 3
      x-methodName: updateAccountHolder
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              addShareholders:
                $ref: '#/components/examples/post-updateAccountHolder-addShareholders'
              bankAccountDetails:
                $ref: '#/components/examples/post-updateAccountHolder-bankAccountDetails'
              businessDetails:
                $ref: '#/components/examples/post-updateAccountHolder-businessDetails'
              general:
                $ref: '#/components/examples/post-updateAccountHolder-general'
            schema:
              $ref: '#/components/schemas/UpdateAccountHolderRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAccountHolderResponse'
              examples:
                post-updateAccountHolder200Example:
                  summary: Default post-updateAccountHolder 200 response
                  x-microcks-default: true
                  value:
                    accountHolderCode: CODE123
                    accountHolderDetails: example_value
                    accountHolderStatus: active
                    description: A sample description for this resource.
                    invalidFields:
                    - example_value
                    legalEntity: Business
                    primaryCurrency: USD
                    pspReference: REF-001
                    resultCode: CODE123
                    verification: example_value
                    verificationProfile: example_value
          description: OK - the request has succeeded.
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateAccountHolderResponse'
              examples:
                post-updateAccountHolder202Example:
                  summary: Default post-updateAccountHolder 202 response
                  x-microcks-default: true
                  value:
                    accountHolderCode: CODE123
                    accountHolderDetails: example_value
                    accountHolderStatus: active
                    description: A sample description for this resource.
                    invalidFields:
                    - example_value
                    legalEntity: Business
                    primaryCurrency: USD
                    pspReference: REF-001
                    resultCode: CODE123
                    verification: example_value
                    verificationProfile: example_value
          description: Accepted - the request has been accepted for processing, but the processing has not been completed.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-updateAccountHolder401Example:
                  summary: Default post-updateAccountHolder 401 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-updateAccountHolder422Example:
                  summary: Default post-updateAccountHolder 422 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-updateAccountHolder500Example:
                  summary: Default post-updateAccountHolder 500 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /updateAccountHolderState:
    post:
      tags:
      - Holders
      summary: Adyen Update Payout or Processing State
      description: Disables or enables the processing or payout state of an account holder.
      operationId: post-updateAccountHolderState
      x-groupName: Account holders
      x-sortIndex: 4
      x-methodName: updateAccountHolderState
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/post-updateAccountHolderState-basic'
            schema:
              $ref: '#/components/schemas/UpdateAccountHolderStateRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountHolderStatusResponse'
              examples:
                post-updateAccountHolderState200Example:
                  summary: Default post-updateAccountHolderState 200 response
                  x-microcks-default: true
                  value:
                    accountHolderCode: CODE123
                    accountHolderStatus: active
                    invalidFields:
                    - example_value
                    pspReference: REF-001
                    resultCode: CODE123
          description: OK - the request has succeeded.
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountHolderStatusResponse'
              examples:
                post-updateAccountHolderState202Example:
                  summary: Default post-updateAccountHolderState 202 response
                  x-microcks-default: true
                  value:
                    accountHolderCode: CODE123
                    accountHolderStatus: active
                    invalidFields:
                    - example_value
                    pspReference: REF-001
                    resultCode: CODE123
          description: Accepted - the request has been accepted for processing, but the processing has not been completed.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-updateAccountHolderState401Example:
                  summary: Default post-updateAccountHolderState 401 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-updateAccountHolderState422Example:
                  summary: Default post-updateAccountHolderState 422 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
              examples:
                post-updateAccountHolderState500Example:
                  summary: Default post-updateAccountHolderState 500 response
                  x-microcks-default: true
                  value:
                    errorCode: CODE123
                    errorType: standard
                    message: example_value
                    pspReference: REF-001
                    status: 500
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /accountHolders:
    post:
      tags:
      - Holders
      summary: Adyen Create an Account Holder
      description: 'Creates an account holder linked to a [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities).


        '
      x-addedInVersion: '1'
      operationId: post-accountHolders
      x-sortIndex: 1
      x-methodName: createAccountHolder
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              createAccountHolder:
                $ref: '#/components/examples/post-accountHolders-createAccountHolder'
            schema:
              $ref: '#/components/schemas/AccountHolderInfo'
      responses:
        '200':
          content:
            application/json:
              examples:
                createAccountHolder:
                  $ref: '#/components/examples/post-accountHolders-createAccountHolder-200'
              schema:
                $ref: '#/components/schemas/AccountHolder'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /accountHolders/{id}:
    get:
      tags:
      - Holders
      summary: Adyen Get an Account Holder
      description: Returns an account holder.
      x-addedInVersion: '1'
      operationId: get-accountHolders-id
      x-sortIndex: 3
      x-methodName: getAccountHolder
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the account holder.
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-accountHolders-id-success-200'
              schema:
                $ref: '#/components/schemas/AccountHolder'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - Holders
      summary: Adyen Update an Account Holder
      description: Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.
      x-addedInVersion: '1'
      operationId: patch-accountHolders-id
      x-sortIndex: 2
      x-methodName: updateAccountHolder
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              requestAccountHolderCapability:
                $ref: '#/components/examples/patch-accountHolders-id-requestAccountHolderCapability'
              updateAccountHolderStatus:
                $ref: '#/components/examples/patch-accountHolders-id-updateAccountHolderStatus'
            schema:
              $ref: '#/components/schemas/AccountHolderUpdateRequest'
      parameters:
      - description: The unique identifier of the account holder.
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                requestAccountHolderCapability:
                  $ref: '#/components/examples/patch-accountHolders-id-requestAccountHolderCapability-200'
                updateAccountHolderStatus:
                  $ref: '#/components/examples/patch-accountHolders-id-updateAccountHolderStatus-200'
              schema:
                $ref: '#/components/schemas/AccountHolder'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /accountHolders/{id}/balanceAccounts:
    get:
      tags:
      - Holders
      summary: Adyen Get All Balance Accounts of an Account Holder
      description: "Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`."
      x-addedInVersion: '1'
      operationId: get-accountHolders-id-balanceAccounts
      x-sortIndex: 4
      x-methodName: getAllBalanceAccountsOfAccountHolder
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the account holder.
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: The number of items that you want to skip.
        name: offset
        in: query
        required: false
        schema:
          format: int32
          type: integer
      - description: The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.
        name: limit
        in: query
        required: false
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-accountHolders-id-balanceAccounts-success-200'
              schema:
                $ref: '#/components/schemas/PaginatedBalanceAccountsResponse'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /accountHolders/{id}/taxForms:
    get:
      tags:
      - Holders
      summary: Adyen Get a Tax Form
      description: Generates a tax form for account holders operating in the US. For more information, refer to [Providing tax forms](https://docs.adyen.com/marketplaces-and-platforms/us-tax-forms/).
      x-addedInVersion: '2'
      operationId: get-accountHolders-id-taxForms
      x-sortIndex: 5
      x-methodName: getTaxForm
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the account holder.
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: The type of tax form you want to retrieve. Accepted values are **US1099k** and **US1099nec**
        name: formType
        in: query
        required: true
        schema:
          x-enum:
          - value: US1099k
          - value: US1099nec
          enum:
          - US1099k
          - US1099nec
          type: string
      - description: The tax year in YYYY format for the tax form you want to retrieve
        name: year
        in: query
        required: true
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-accountHolders-id-taxForms-success-200'
              schema:
                $ref: '#/components/schemas/GetTaxFormResponse'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /balancePlatforms/{id}/accountHolders:
    get:
      tags:
      - Holders
      summary: Adyen Get All Account Holders Under a Balance Platform
      description: "Returns a paginated list of all the account holders that belong to the balance platform. To fetch multiple pages, use the query parameters. \n\nFor example, to limit the page to 5 account holders and to skip the first 20, use `/balancePlatforms/{id}/accountHolders?limit=5&offset=20`."
      x-addedInVersion: '1'
      operationId: get-balancePlatforms-id-accountHolders
      x-sortIndex: 2
      x-methodName: getAllAccountHoldersUnderBalancePlatform
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the balance platform.
        name: id
        in: path
        required: true
        schema:
          type: string
      - description: The number of items that you want to skip.
        name: offset
        in: query
        required: false
        schema:
          format: int32
          type: integer
      - description: The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page.
        name: limit
        in: query
        required: false
        schema:
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-balancePlatforms-id-accountHolders-success-200'
              schema:
                $ref: '#/components/schemas/PaginatedAccountHoldersResponse'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    LegalArrangementEntityDetail:
      properties:
        address:
          description: The address of the entity.
          $ref: '#/components/schemas/ViasAddress'
        businessDetails:
          description: Required when creating an entity with `legalEntityType` **Business**, **NonProfit**, **PublicCompany**, or **Partnership**.
          $ref: '#/components/schemas/BusinessDetails'
        email:
          description: The e-mail address of the entity.
          type: string
        fullPhoneNumber:
          description: 'The phone number of the contact provided as a single string.  It will be handled as a landline phone.

            **Examples:** "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"'
          type: string
        individualDetails:
          description: Required when creating an entity with `legalEntityType` **Individual**.
          $ref: '#/components/schemas/IndividualDetails'
        legalArrangementEntityCode:
          description: 'Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity.

            Use only when updating an account holder. If you include this field when creating an account holder, the request will fail.'
          type: string
        legalArrangementEntityReference:
          description: Your reference for the legal arrangement entity.
          type: string
        legalArrangementMembers:
          description: 'An array containing the roles of the entity in the legal arrangement.


            The possible values depend on the legal arrangement `type`.


            - For `type` **Association**: **ControllingPerson** and **Shareholder**.


            - For `type` **Partnership**: **Partner** and **Shareholder**.


            - For `type` **Trust**: **Trustee**, **Settlor**, **Protector**, **Beneficiary**,  and **Shareholder**.


            '
          items:
            enum:
            - Beneficiary
            - ControllingPerson
            - Partner
            - Protector
            - Settlor
            - Shareholder
            - Trustee
            type: string
          type: array
        legalEntityType:
          description: 'The legal entity type.


            Possible values: **Business**, **Individual**, **NonProfit**, **PublicCompany**, or **Partnership**. '
          enum:
          - Business
          - Individual
          - NonProfit
          - Partnership
          - PublicCompany
          type: string
        phoneNumber:
          description: The phone number of the entity.
          $ref: '#/components/schemas/ViasPhoneNumber'
        webAddress:
          description: The URL of the website of the contact.
          type: string
      type: object
    AccountPayoutState:
      properties:
        allowPayout:
          description: 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.
          type: boolean
        disableReason:
          description: 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.
          type: string
        disabled:
          description: 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.
          type: boolean
        notAllowedReason:
          x-addedInVersion: '5'
          description: 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.
          type: string
        payoutLimit:
          description: The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited.
          $ref: '#/components/schemas/Amount'
        tierNumber:
          x-addedInVersion: '3'
          description: The payout tier that the account holder occupies.
          format: int32
          type: integer
      type: object
    KYCLegalArrangementCheckResult:
      properties:
        checks:
          description: A list of the checks and their statuses.
          items:
            $ref: '#/components/schemas/KYCCheckStatusData'
          type: array
        legalArrangementCode:
          description: The unique ID of the legal arrangement to which the check applies.
          type: string
      type: object
    BankAccountDetail:
      properties:
        accountNumber:
          description: 'The bank account number (without separators).

            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        accountType:
          description: 'The type of bank account.

            Only applicable to bank accounts held in the USA.

            The permitted values are: `checking`, `savings`.


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        bankAccountName:
          description: The name of the bank account.
          type: string
        bankAccountReference:
          x-addedInVersion: '5'
          description: Merchant reference to the bank account.
          type: string
        bankAccountUUID:
          description: 'The unique identifier (UUID) of the Bank Account.

            >If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID.


            >If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue.


            >If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail.


            >If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated.

            '
          type: string
        bankBicSwift:
          description: 'The bank identifier code.

            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        bankCity:
          description: 'The city in which the bank branch is located.


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        bankCode:
          description: 'The bank code of the banking institution with which the bank account is registered.


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        bankName:
          description: 'The name of the banking institution with which the bank account is held.


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        branchCode:
          description: 'The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account:

            * United States - Routing number

            * United Kingdom - Sort code

            * Germany - Bankleitzahl

            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        checkCode:
          description: 'The check code of the bank account.


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        countryCode:
          description: 'The two-letter country code in which the bank account is registered.

            >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        currencyCode:
          description: 'The currency in which the bank account deals.

            >The permitted currency codes are defined in ISO-4217 (e.g. ''EUR'').

            '
          type: string
        iban:
          description: 'The international bank account number.

            >The IBAN standard is defined in ISO-13616.


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        ownerCity:
          description: 'The city of residence of the bank account owner.

            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        ownerCountryCode:
          description: 'The country code of the country of residence of the bank account owner.

            >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        ownerDateOfBirth:
          deprecated: true
          description: 'The date of birth of the bank account owner.

            The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31).'
          type: string
        ownerHouseNumberOrName:
          description: 'The house name or number of the residence of the bank account owner.

            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        ownerName:
          description: 'The name of the bank account owner.

            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        ownerNationality:
          description: 'The country code of the country of nationality of the bank account owner.

            >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        ownerPostalCode:
          description: 'The postal code of the residence of the bank account owner.

            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        ownerState:
          description: 'The state of residence of the bank account owner.

            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        ownerStreet:
          description: 'The street name of the residence of the bank account owner.

            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        primaryAccount:
          description: If set to true, the bank account is a primary account.
          type: boolean
        taxId:
          description: 'The tax ID number.


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
        urlForVerification:
          description: 'The URL to be used for bank account verification.

            This may be generated on bank account creation.


            >Refer to [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information) for details on field requirements.'
          type: string
      type: object
    AccountHolderInfo:
      properties:
        balancePlatform:
          description: The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.
          type: string
        capabilities:
          additionalProperties:
            $ref: '#/components/schemas/AccountHolderCapability'
          description: Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.
          type: object
        contactDetails:
          deprecated: true
          description: Contact details of the account holder.
          $ref: '#/components/schemas/ContactDetails'
        description:
          description: Your description for the account holder, maximum 300 characters.
          maxLength: 300
          type: string
        legalEntityId:
          description: The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 'A set of key and value pairs for general use.

            The keys do not have specific names and may be used for storing miscellaneous data as desired.

            > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.'
          type: object
        migratedAccountHolderCode:
          description: The unique identifier of the migrated account holder in the classic integration.
          readOnly: true
          type: string
        reference:
          description: Your reference for the account holder, maximum 150 characters.
          maxLength: 150
          type: string
        timeZone:
          description: 'The time zone of the account holder. For example, **Europe/Amsterdam**.

            Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).'
          type: string
      required:
      - legalEntityId
      type: object
    SignatoryContact:
      properties:
        address:
          description: The address of the person.
          $ref: '#/components/schemas/ViasAddress'
        email:
          description: The e-mail address of the person.
          type: string
        fullPhoneNumber:
          description: 'The phone number of the person provided as a single string.  It will be handled as a landline phone.

            Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"'
          type: string
        jobTitle:
          description: 'Job title of the signatory.


            Example values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.'
          type: string
        name:
          description: The name of the person.
          $ref: '#/components/schemas/ViasName'
        personalData:
          description: Contains information about the person.
          $ref: '#/components/schemas/ViasPersonalData'
        phoneNumber:
          description: The phone number of the person.
          $ref: '#/components/schemas/ViasPhoneNumber'
        signatoryCode:
          description: 'The unique identifier (UUID) of the signatory.

            >**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Signatory will be created with a procedurally-generated UUID.**


            >**If, during an Account Holder create request, a UUID is provided, the creation of the Signatory will fail while the creation of the Account Holder will continue.**


            >**If, during an Account Holder update request, a UUID that is not correlated with an existing Signatory is provided, the update of the Signatory will fail.**


            >**If, during an Account Holder update request, a UUID that is correlated with an existing Signatory is provided, the existing Signatory will be updated.**

            '
          type: string
        signatoryReference:
          description: Your reference for the signatory.
          type: string
        webAddress:
          description: The URL of the person's website.
          type: string
      type: object
    Address:
      properties:
        city:
          description: 'The name of the city. Maximum length: 3000 characters.'
          maxLength: 3000
          type: string
        country:
          description: 'The two-character ISO-3166-1 alpha-2 country code. For example, **US**.

            > If you don''t know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.'
          type: string
        houseNumberOrName:
          description: 'The number or name of the house. Maximum length: 3000 characters.'
          maxLength: 3000
          type: string
        postalCode:
          description: A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
          type: string
        stateOrProvince:
          description: 'The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.

            > Required for the US and Canada.'
          type: string
        street:
          description: 'The name of the street. Maximum length: 3000 characters.

            > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.'
          maxLength: 3000
          type: string
      required:
      - street
      - houseNumberOrName
      - city
      - postalCode
      - country
      type: object
    PlatformPaymentConfiguration:
      properties:
        salesDayClosingTime:
          description: 'Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#sales-day) ends.


            Possible values: Time in **"HH:MM"** format. **HH** ranges from **00** to **07**. **MM** must be **00**.


            Default value: **"00:00"**.'
          format: time
          type: string
        settlementDelayDays:
          description: 'Specifies after how many business days the funds in a [settlement batch](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#settlement-batch) are made available.


            Possible values: **0** to **10**, or **null**.

            * Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement).

            * Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/pass-through-settlement).


            Default value: **null**.'
          format: int32
          type: integer
      type: object
    GetAccountHolderRequest:
      properties:
        accountCode:
          description: 'The code of the account of which to retrieve the details.

            > Required if no `accountHolderCode` is provided.'
          type: string
        accountHolderCode:
          description: 'The code of the account holder of which to retrieve the details.

            > Required if no `accountCode` is provided.'
          type: string
        showDetails:
          x-addedInVersion: '4'
          description: True if the request should return the account holder details
          type: boolean
      type: object
    PayoutScheduleResponse:
      properties:
        nextScheduledPayout:
          description: The date of the next scheduled payout.
          format: date-time
          type: string
        schedule:
          description: 'The payout schedule of the account.

            Permitted values: `DEFAULT`, `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.'
          enum:
          - BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT
          - DAILY
          - DAILY_AU
          - DAILY_EU
          - DAILY_SG
          - DAILY_US
          - HOLD
          - MONTHLY
          - WEEKLY
          - WEEKLY_MON_TO_FRI_AU
          - WEEKLY_MON_TO_FRI_EU
          - WEEKLY_MON_TO_FRI_US
          - WEEKLY_ON_TUE_FRI_MIDNIGHT
          - WEEKLY_SUN_TO_THU_AU
          - WEEKLY_SUN_TO_THU_US
          type: string
      type: object
    KYCLegalArrangementEntityCheckResult:
      properties:
        checks:
          description: A list of the checks and their statuses.
          items:
            $ref: '#/components/schemas/KYCCheckStatusData'
          type: array
        legalArrangementCode:
          description: The unique ID of the legal arrangement to which the entity belongs.
          type: string
        legalArrangementEntityCode:
          description: The unique ID of the legal arrangement entity to which the check applies.
          type: string
      type: object
    SuspendAccountHolderRequest:
      properties:
        accountHolderCode:
          description: The code of the account holder to be suspended.
          type: string
      required:
      - accountHolderCode
      type: object
    AccountHolderDetails:
      properties:
        address:
          description: The address of the account holder.
          $ref: '#/components/schemas/ViasAddress'
        bankAccountDetails:
          description: Array of bank accounts associated with the account holder. For details about the required `bankAccountDetail` fields, see [Required information](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/required-information).
          items:
            $ref: '#/components/schemas/BankAccountDetail'
          type: array
        bankAggregatorDataReference:
          x-addedInVersion: '5'
          description: The opaque reference value returned by the Adyen API during bank account login.
          type: string
        businessDetails:
          description: 'Details about the business or nonprofit account holder.

            Required when creating an account holder with `legalEntity` **Business** or **NonProfit**.'
          $ref: '#/components/schemas/BusinessDetails'
        email:
          description: The email address of the account holder.
          type: string
        fullPhoneNumber:
          description: 'The phone number of the account holder provided as a single string. It will be handled as a landline phone.

            **Examples:** "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"'
          type: string
        individualDetails:
          description: 'Details about the individual account holder.

            Required when creating an account holder with `legalEntity` **Individual**.

            '
          $ref: '#/components/schemas/IndividualDetails'
        lastReviewDate:
          description: Date when you last reviewed the account holder's information, in ISO-8601 YYYY-MM-DD format. For example, **2020-01-31**.
          type: string
        legalArrangements:
          x-addedInVersion: '6'
          description: An array containing information about the account holder's [legal arrangements](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements).
          items:
            $ref: '#/components/schemas/LegalArrangementDetail'
          type: array
        merchantCategoryCode:
          description: 'The Merchant Category Code of the account holder.

            > If not specified in the request, this will be derived from the platform account (which is configured by Adyen).'
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 'A set of key and value pairs for general use by the account holder or merchant.

            The keys do not have specific names and may be used for storing miscellaneous data as desired.

            > The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary.

            > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.'
          type: object
        payoutMethods:
          x-addedInVersion: '5'
          description: Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/marketplaces-and-platforms/classic/payout-to-cards).
          items:
            $ref: '#/components/schemas/PayoutMethod'
          type: array
        principalBusinessAddress:
          description: The principal business address of the account holder.
          $ref: '#/components/schemas/ViasAddress'
        storeDetails:
          x-addedInVersion: '5'
          description: Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-pos).
          items:
            $ref: '#/components/schemas/StoreDetail'
          type: array
        webAddress:
          description: The URL of the website of the account holder.
          type: string
      required:
      - address
      type: object
    CloseAccountHolderResponse:
      properties:
        accountHolderStatus:
          description: The new status of the Account Holder.
          $ref: '#/components/schemas/AccountHolderStatus'
        invalidFields:
          x-addedInVersion: '5'
          description: Contains field validation errors that would prevent requests from being processed.
          items:
            $ref: '#/components/schemas/ErrorFieldType'
          type: array
        pspReference:
          description: The reference of a request. Can be used to uniquely identify the request.
          type: string
        resultCode:
          description: The result code.
          type: string
      type: object
    AccountHolderStatus:
      properties:
        events:
          description: A list of events scheduled for the account holder.
          items:
            $ref: '#/components/schemas/AccountEvent'
          type: array
        payoutState:
          description: The payout state of the account holder.
          $ref: '#/components/schemas/AccountPayoutState'
        processingState:
          description: The processing state of the account holder.
          $ref: '#/components/schemas/AccountProcessingState'
        status:
          description: 'The status of the account holder.

            >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`.'
          enum:
          - Active
          - Closed
          - Inactive
          - Suspended
          type: string
        statusReason:
          description: The reason why the status was assigned to the account holder.
          type: string
      required:
      - status
      type: object
    UnSuspendAccountHolderResponse:
      properties:
        accountHolderStatus:
          description: The new status of the Account Holder.
          $ref: '#/components/schemas/AccountHolderStatus'
        invalidFields:
          x-addedInVersion: '5'
          description: Contains field validation errors that would prevent requests from being processed.
          items:
            $ref: '#/components/schemas/ErrorFieldType'
          type: array
        pspReference:
          description: The reference of a request. Can be used to uniquely identify the request.
          type: string
        resultCode:
          description: The result code.
          type: string
      type: object
    KYCShareholderCheckResult:
      properties:
        checks:
          description: A list of the checks and their statuses.
          items:
            $ref: '#/components/schemas/KYCCheckStatusData'
          type: array
        legalArrangementCode:
          x-addedInVersion: '6'
          description: The unique ID of the legal arrangement to which the shareholder belongs, if applicable.
          type: string
        legalArrangementEntityCode:
          x-addedInVersion: '6'
          description: The unique ID of the legal arrangement entity to which the shareholder belongs, if applicable.
          type: string
        shareholderCode:
          description: The code of the shareholder to which the check applies.
          type: string
      type: object
    VerificationError:
      properties:
        capabilities:
          description: Contains the capabilities that the verification error applies to.
          items:
            enum:
            - acceptExternalFunding
            - acceptPspFunding
            - acceptTransactionInRestrictedCountries
            - acceptTransactionInRestrictedCountriesCommercial
            - acceptTransactionInRestrictedCountriesConsumer
            - acceptTransactionInRestrictedIndustries
            - acceptTransactionInRestrictedIndustriesCommercial
            - acceptTransactionInRestrictedIndustriesConsumer
            - acquiring
            - atmWithdrawal
            - atmWithdrawalCommercial
            - atmWithdrawalConsumer
            - atmWithdrawalInRestrictedCountries
            - atmWithdrawalInRestrictedCountriesCommercial
            - atmWithdrawalInRestrictedCountriesConsumer
            - authorisedPaymentInstrumentUser
            - getGrantOffers
            - issueBankAccount
            - issueCard
            - issueCardCommercial
            - issueCardConsumer
            - localAcceptance
            - payout
            - payoutToTransferInstrument
            - processing
            - receiveFromBalanceAccount
            - receiveFromPlatformPayments
            - receiveFromThirdParty
            - receiveFromTransferInstrument
            - receiveGrants
            - receivePayments
            - sendToBalanceAccount
            - sendToThirdParty
            - sendToTransferInstrument
            - thirdPartyFunding
            - useCard
            - useCardCommercial
            - useCardConsumer
            - useCardInRestrictedCountries
            - useCardInRestrictedCountriesCommercial
            - useCardInRestrictedCountriesConsumer
            - useCardInRestrictedIndustries
            - useCardInRestrictedIndustriesCommercial
            - useCardInRestrictedIndustriesConsumer
            - withdrawFromAtm
            - withdrawFromAtmCommercial
            - withdrawFromAtmConsumer
            - withdrawFromAtmInRestrictedCountries
            - withdrawFromAtmInRestrictedCountriesCommercial
            - withdrawFromAtmInRestrictedCountriesConsumer
            type: string
          type: array
        code:
          description: The verification error code.
          type: string
        message:
          description: A description of the error.
          type: string
        remediatingActions:
          description: Contains the actions that you can take to resolve the verification error.
          items:
            $ref: '#/components/schemas/RemediatingAction'
          type: array
        subErrors:
          description: Contains more granular information about the verification error.
          items:
            $ref: '#/components/schemas/VerificationError-recursive'
          type: array
        type:
          description: "The type of error.\n\n Possible values: **invalidInput**, **dataMissing**."
          enum:
          - dataMissing
          - invalidInput
          - pendingStatus
          type: string
      type: object
    StoreDetail:
      properties:
        address:
          description: The address of the physical store where the account holder will process payments from.
          $ref: '#/components/schemas/ViasAddress'
        fullPhoneNumber:
          description: 'The phone number of the store provided as a single string.  It will be handled as a landline phone.


            Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"'
          type: string
        logo:
          x-addedInVersion: '5'
          description: Store logo for payment method setup.
          type: string
        merchantAccount:
          description: The merchant account to which the store belongs.
          type: string
        merchantCategoryCode:
          description: The merchant category code (MCC) that classifies the business of the account holder.
          type: string
        merchantHouseNumber:
          x-addedInVersion: '5'
          description: Merchant house number for payment method setup.
          type: string
        phoneNumber:
          description: The phone number of the store.
          $ref: '#/components/schemas/ViasPhoneNumber'
        shopperInteraction:
          x-addedInVersion: '5'
          description: 'The sales channel. Possible values: **Ecommerce**, **POS**.'
          enum:
          - Ecommerce
          - POS
          type: string
        splitConfigurationUUID:
          x-addedInVersion: '5'
          description: The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.
          type: string
        status:
          description: 'The status of the store. Possible values: **Pending**, **Active**, **Inactive**, **InactiveWithModifications**, **Closed**.'
          enum:
          - Active
          - Closed
          - Inactive
          - InactiveWithModifications
          - Pending
          type: string
        store:
          description: Adyen-generated unique alphanumeric identifier (UUID) for the store, returned in the response when you create a store. Required when updating an existing store in an `/updateAccountHolder` request.
          type: string
        storeName:
          description: "The name of the account holder's store. This value is shown in shopper statements.\n\n* Length: Between 3 to 22 characters \n\n* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**"
          type: string
        storeReference:
          description: "Your unique identifier for the store. The Customer Area also uses this value for the store description.\n\n * Length: Between 3 to 128 characters\n\n* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**"
          type: string
        virtualAccount:
          x-addedInVersion: '5'
          description: The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.
          type: string
        webAddress:
          x-addedInVersion: '5'
          description: URL of the ecommerce store.
          type: string
      required:
      - merchantCategoryCode
      - address
      - merchantAccount
      type: object
    AccountHolder:
      properties:
        balancePlatform:
          description: The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.
          type: string
        capabilities:
          additionalProperties:
            $ref: '#/components/schemas/AccountHolderCapability'
          description: Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.
          type: object
        contactDetails:
          deprecated: true
          description: Contact details of the account holder.
          $ref: '#/components/schemas/ContactDetails'
        description:
          description: Your description for the account holder, maximum 300 characters.
          maxLength: 300
          type: string
        id:
          description: The unique identifier of the account holder.
          readOnly: true
          type: string
        legalEntityId:
          description: The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 'A set of key and value pairs for general use.

            The keys do not have specific names and may be used for storing miscellaneous data as desired.

            > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.'
          type: object
        migratedAccountHolderCode:
          description: The unique identifier of the migrated account holder in the classic integration.
          readOnly: true
          type: string
        primaryBalanceAccount:
          description: The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.
          type: string
        reference:
          description: Your reference for the account holder, maximum 150 characters.
          maxLength: 150
          type: string
        status:
          description: "The status of the account holder.\n\nPossible values: \n\n * **active**: The account holder is active. This is the default status when creating an account holder. \n\n * **inactive (Deprecated)**: The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details. \n\n * **suspended**: The account holder is permanently deactivated by Adyen. This action cannot be undone. \n\n* **closed**: The account holder is permanently deactivated by you. This action cannot be undone."
          enum:
          - active
          - closed
          - inactive
          - suspended
          type: string
        timeZone:
          description: 'The time zone of the account holder. For example, **Europe/Amsterdam**.

            Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).'
          type: string
        verificationDeadlines:
          description: List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
          items:
            $ref: '#/components/schemas/VerificationDeadline'
          readOnly: true
          type: array
      required:
      - legalEntityId
      - id
      type: object
    Account:
      properties:
        accountCode:
          description: The code of the account.
          type: string
        bankAccountUUID:
          x-addedInVersion: '5'
          description: The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.
          type: string
        beneficiaryAccount:
          description: The beneficiary of the account.
          type: string
        beneficiaryMerchantReference:
          description: The reason that a beneficiary has been set up for this account. This may have been supplied during the setup of a beneficiary at the discretion of the executing user.
          type: string
        description:
          x-addedInVersion: '4'
          description: A description of the account.
          type: string
        metadata:
          x-addedInVersion: '5'
          additionalProperties:
            type: string
          description: 'A set of key and value pairs for general use by the merchant.

            The keys do not have specific names and may be used for storing miscellaneous data as desired.

            > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.'
          type: object
        payoutMethodCode:
          x-addedInVersion: '5'
          description: The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.
          type: string
        payoutSchedule:
          description: The account's payout schedule.
          $ref: '#/components/schemas/PayoutScheduleResponse'
        payoutSpeed:
          x-addedInVersion: '5'
          description: 'Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.'
          enum:
          - INSTANT
          - SAME_DAY
          - STANDARD
          type: string
        status:
          x-addedInVersion: '4'
          description: 'The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`.'
          type: string
      type: object
    GenericResponse:
      properties:
        invalidFields:
          x-addedInVersion: '5'
          description: Contains field validation errors that would prevent requests from being processed.
          items:
            $ref: '#/components/schemas/ErrorFieldType'
          type: array
        pspReference:
          description: The reference of a request. Can be used to uniquely identify the request.
          type: string
        resultCode:
          description: The result code.
          type: string
      type: object
    PerformVerificationRequest:
      properties:
        accountHolderCode:
          description: The code of the account holder to verify.
          type: string
        accountStateType:
          description: 'The state required for the account holder.

            > Permitted values: `Processing`, `Payout`.'
          enum:
          - LimitedPayout
          - LimitedProcessing
          - LimitlessPayout
          - LimitlessProcessing
          - Payout
          - Processing
          type: string
        tier:
          description: The tier required for the account holder.
          format: int32
          type: integer
      required:
      - accountHolderCode
      - accountStateType
      - tier
      type: object
    CapabilitySettings:
      properties:
        amountPerIndustry:
          additionalProperties:
            $ref: '#/components/schemas/Amount'
          description: ''
          type: object
        authorizedCardUsers:
          description: ''
          type: boolean
        fundingSource:
          description: ''
          items:
            enum:
            - credit
            - debit
            - prepaid
            type: string
          type: array
        interval:
          description: ''
          enum:
          - daily
          - monthly
          - weekly
          type: string
        maxAmount:
          description: ''
          $ref: '#/components/schemas/Amount'
      type: object
    ViasPhoneNumber:
      properties:
        phoneCountryCode:
          description: 'The two-character country code of the phone number.

            >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. ''NL'').'
          type: string
        phoneNumber:
          description: 'The phone number.

            >The inclusion of the phone number country code is not necessary.'
          type: string
        phoneType:
          description: 'The type of the phone number.

            >The following values are permitted: `Landline`, `Mobile`, `SIP`, `Fax`.'
          enum:
          - Fax
          - Landline
          - Mobile
          - SIP
          type: string
      type: object
    ContactDetails:
      properties:
        address:
          description: The address of the account holder.
          $ref: '#/components/schemas/Address'
        email:
          description: The email address of the account holder.
          type: string
        phone:
          description: The phone number of the account holder.
          $ref: '#/components/schemas/Phone'
        webAddress:
          description: The URL of the account holder's website.
          type: string
      required:
      - email
      - phone
      - address
      type: object
    MigratedShareholders:
      properties:
        legalEntityCode:
          description: The unique identifier of the legal entity of that shareholder in the balance platform.
          type: string
        shareholderCode:
          description: The unique identifier of the account of the migrated shareholder in the classic integration.
          type: string
      type: object
    UltimateParentCompany:
      properties:
        address:
          description: Address of the ultimate parent company.
          $ref: '#/components/schemas/ViasAddress'
        businessDetails:
          description: Details about the ultimate parent company's business.
          $ref: '#/components/schemas/UltimateParentCompanyBusinessDetails'
        ultimateParentCompanyCode:
          description: Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create an ultimate parent company. Required when updating an existing entry in an `/updateAccountHolder` request.
          type: string
      type: object
    RestServiceError:
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          type: string
        errorCode:
          description: A code that identifies the problem type.
          type: string
        instance:
          description: A unique URI that identifies the specific occurrence of the problem.
          type: string
        invalidFields:
          description: Detailed explanation of each validation error, when applicable.
          items:
            $ref: '#/components/schemas/InvalidField'
          type: array
        requestId:
          description: A unique reference for the request, essentially the same as `pspReference`.
          type: string
        response:
          description: JSON response payload.
          $ref: '#/components/schemas/JSONObject'
        status:
          description: The HTTP status code.
          format: int32
          type: integer
        title:
          description: A short, human-readable summary of the problem type.
          type: string
        type:
          description: A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
          type: string
      required:
      - type
      - errorCode
      - title
      - detail
      - status
      type: object
    MigrationData:
      properties:
        accountHolderId:
          description: The unique identifier of the account holder in the balance platform.
          type: string
        balancePlatform:
          description: The unique identifier of the balance platfrom to which the account holder was migrated.
          type: string
        migrated:
          description: Set to **true** if the account holder has been migrated.
          type: boolean
        migratedAccounts:
          description: Contains the mapping of virtual account codes (classic integration) to the balance account codes (balance platform) associated with the migrated account holder.
          items:
            $ref: '#/components/schemas/MigratedAccounts'
          type: array
        migratedShareholders:
          description: Contains the mapping of shareholders associated with the migrated legal entities.
          items:
            $ref: '#/components/schemas/MigratedShareholders'
          type: array
        migratedStores:
          description: Contains the mapping of business lines and stores associated with the migrated account holder.
          items:
            $ref: '#/components/schemas/MigratedStores'
          type: array
        migrationDate:
          description: The date when account holder was migrated.
          format: date-time
          type: string
      type: object
    IndividualDetails:
      properties:
        name:
          description: 'The name of the individual.

            >Make sure your account holder registers using the name shown on their Photo ID.'
          $ref: '#/components/schemas/ViasName'
        personalData:
          description: Personal information of the individual.
          $ref: '#/components/schemas/ViasPersonalData'
      type: object
    UltimateParentCompanyBusinessDetails:
      properties:
        legalBusinessName:
          description: The legal name of the company.
          type: string
        registrationNumber:
          description: The registration number of the company.
          type: string
        stockExchange:
          description: Market Identifier Code (MIC).
          type: string
        stockNumber:
          description: International Securities Identification Number (ISIN).
          type: string
        stockTicker:
          description: Stock Ticker symbol.
          type: string
      type: object
    KYCSignatoryCheckResult:
      properties:
        checks:
          description: A list of the checks and their statuses.
          items:
            $ref: '#/components/schemas/KYCCheckStatusData'
          type: array
        signatoryCode:
          description: The code of the signatory to which the check applies.
          type: string
      type: object
    KYCCheckResult:
      properties:
        checks:
          description: A list of the checks and their statuses.
          items:
            $ref: '#/components/schemas/KYCCheckStatusData'
          type: array
      type: object
    LegalArrangementDetail:
      properties:
        address:
          description: The address of the legal arrangement.
          $ref: '#/components/schemas/ViasAddress'
        legalArrangementCode:
          description: 'Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement.

            Use only when updating an account holder. If you include this field when creating an account holder, the request will fail.'
          type: string
        legalArrangementEntities:
          description: An array containing information about other entities that are part of the legal arrangement.
          items:
            $ref: '#/components/schemas/LegalArrangementEntityDetail'
          type: array
        legalArrangementReference:
          description: Your reference for the legal arrangement. Must be between 3 to 128 characters.
          type: string
        legalForm:
          description: 'The form of legal arrangement. Required if `type` is **Trust** or **Partnership**.


            The possible values depend on the `type`.


            - For `type` **Trust**:  **CashManagementTrust**, **CorporateUnitTrust**, **DeceasedEstate**, **DiscretionaryInvestmentTrust**, **DiscretionaryServicesManagementTrust**, **DiscretionaryTradingTrust**, **FirstHomeSaverAccountsTrust**, **FixedTrust**, **FixedUnitTrust**, **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, **PooledSuperannuationTrust**, **PublicTradingTrust**, or **UnlistedPublicUnitTrust**.


            - For `type` **Partnership**: **LimitedPartnership**, **FamilyPartnership**, or **OtherPartnership**'
          enum:
          - CashManagementTrust
          - CorporateUnitTrust
          - DeceasedEstate
          - DiscretionaryInvestmentTrust
          - DiscretionaryServicesManagementTrust
          - DiscretionaryTradingTrust
          - FirstHomeSaverAccountsTrust
          - FixedTrust
          - FixedUnitTrust
          - HybridTrust
          - ListedPublicUnitTrust
          - OtherTrust
          - PooledSuperannuationTrust
          - PublicTradingTrust
          - UnlistedPublicUnitTrust
          - LimitedPartnership
          - FamilyPartnership
          - OtherPartnership
          type: string
        name:
          description: 'The legal name of the legal arrangement. Minimum length: 3 characters.'
          type: string
        registrationNumber:
          description: The registration number of the legal arrangement.
          type: string
        taxNumber:
          description: The tax identification number of the legal arrangement.
          type: string
        type:
          description: "The [type of legal arrangement](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/legal-arrangements#types-of-legal-arrangements).\n\nPossible values:\n\n- **Association** \n\n- **Partnership** \n\n- **SoleProprietorship** \n\n- **Trust** \n\n"
          enum:
          - Association
          - Partnership
          - SoleProprietorship
          - Trust
          type: string
      required:
      - type
      - name
      - address
      type: object
    VerificationError-recursive:
      properties:
        capabilities:
          description: Contains the capabilities that the verification error applies to.
          items:
            enum:
            - acceptExternalFunding
            - acceptPspFunding
            - acceptTransactionInRestrictedCountries
            - acceptTransactionInRestrictedCountriesCommercial
            - acceptTransactionInRestrictedCountriesConsumer
            - acceptTransactionInRestrictedIndustries
            - acceptTransactionInRestrictedIndustriesCommercial
            - acceptTransactionInRestrictedIndustriesConsumer
            - acquiring
            - atmWithdrawal
            - atmWithdrawalCommercial
            - atmWithdrawalConsumer
            - atmWithdrawalInRestrictedCountries
            - atmWithdrawalInRestrictedCountriesCommercial
            - atmWithdrawalInRestrictedCountriesConsumer
            - authorisedPaymentInstrumentUser
            - getGrantOffers
            - issueBankAccount
            - issueCard
            - issueCardCommercial
            - issueCardConsumer
            - localAcceptance
            - payout
            - payoutToTransferInstrument
            - processing
            - receiveFromBalanceAccount
            - receiveFromPlatformPayments
            - receiveFromThirdParty
            - receiveFromTransferInstrument
            - receiveGrants
            - receivePayments
            - sendToBalanceAccount
            - sendToThirdParty
            - sendToTransferInstrument
            - thirdPartyFunding
            - useCard
            - useCardCommercial
            - useCardConsumer
            - useCardInRestrictedCountries
            - useCardInRestrictedCountriesCommercial
            - useCardInRestrictedCountriesConsumer
            - useCardInRestrictedIndustries
            - useCardInRestrictedIndustriesCommercial
            - useCardInRestrictedIndustriesConsumer
            - withdrawFromAtm
            - withdrawFromAtmCommercial
            - withdrawFromAtmConsumer
            - withdrawFromAtmInRestrictedCountries
            - withdrawFromAtmInRestrictedCountriesCommercial
            - withdrawFromAtmInRestrictedCountriesConsumer
            type: string
          type: array
        code:
          description: The verification error code.
          type: string
        message:
          description: A description of the error.
          type: string
        type:
          description: "The type of error.\n\n Possible values: **invalidInput**, **dataMissing**."
          enum:
          - dataMissing
          - invalidInput
          - pendingStatus
          type: string
        remediatingActions:
          description: Contains the actions that you can take to resolve the verification error.
          items:
            $ref: '#/components/schemas/RemediatingAction'
          type: array
      required: []
      type: object
    ViasName:
      properties:
        firstName:
          description: The first name.
          maxLength: 80
          type: string
        gender:
          description: 'The gender.

            >The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`.'
          enum:
          - MALE
          - FEMALE
          - UNKNOWN
          maxLength: 1
          type: string
        infix:
          description: 'The name''s infix, if applicable.

            >A maximum length of twenty (20) characters is imposed.'
          maxLength: 20
          type: string
        lastName:
          description: The last name.
          maxLength: 80
          type: string
      type: object
    RemediatingAction:
      properties:
        code:
          description: The remediating action code.
          type: string
        message:
          description: A description of how you can resolve the verification error.
          type: string
      type: object
    UnSuspendAccountHolderRequest:
      properties:
        accountHolderCode:
          description: The code of the account holder to be reinstated.
          type: string
      required:
      - accountHolderCode
      type: object
    AccountEvent:
      properties:
        event:
          description: 'The event.

            >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`.

            For more information, refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process).'
          enum:
          - InactivateAccount
          - RefundNotPaidOutTransfers
          type: string
        executionDate:
          description: The date on which the event will take place.
          format: date-time
          type: string
        reason:
          description: The reason why this event has been created.
          type: string
      type: object
    CapabilityProblemEntity:
      properties:
        documents:
          description: List of document IDs to which the verification errors related to the capabilities correspond to.
          items:
            type: string
          type: array
        id:
          description: The ID of the entity.
          type: string
        owner:
          description: Contains details about the owner of the entity that has an error.
          $ref: '#/components/schemas/CapabilityProblemEntity-recursive'
        type:
          description: "Type of entity. \n\nPossible values: **LegalEntity**, **BankAccount**, **Document**."
          enum:
          - BankAccount
          - Document
          - LegalEntity
          type: string
      type: object
    BusinessDetails:
      properties:
        doingBusinessAs:
          description: The registered name of the company (if it differs from the legal name of the company).
          type: string
        legalBusinessName:
          description: The legal name of the company.
          type: string
        listedUltimateParentCompany:
          description: Information about the parent public company. Required if the account holder is 100% owned by a publicly listed company.
          items:
            $ref: '#/components/schemas/UltimateParentCompany'
          type: array
        registrationNumber:
          x-addedInVersion: '4'
          description: The registration number of the company.
          type: string
        shareholders:
          description: Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [our verification guide](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process#identify-ubos).
          items:
            $ref: '#/components/schemas/ShareholderContact'
          type: array
        signatories:
          description: 'Signatories associated with the company.

            Each array entry should represent one signatory.'
          items:
            $ref: '#/components/schemas/SignatoryContact'
          type: array
        stockExchange:
          x-addedInVersion: '6'
          description: Market Identifier Code (MIC).
          type: string
        stockNumber:
          x-addedInVersion: '6'
          description: International Securities Identification Number (ISIN).
          type: string
        stockTicker:
          x-addedInVersion: '6'
          description: Stock Ticker symbol.
          type: string
        taxId:
          description: The tax ID of the company.
          type: string
      type: object
    KYCCheckSummary:
      properties:
        kycCheckCode:
          x-addedInVersion: '5'
          description: The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-process/verification-codes).
          format: int32
          type: integer
        kycCheckDescription:
          x-addedInVersion: '5'
          description: A description of the check.
          type: string
      type: object
    InvalidField:
      properties:
        message:
          description: Description of the validation error.
          type: string
        name:
          description: The field that has an invalid value.
          type: string
        value:
          description: The invalid value.
          type: string
      required:
      - name
      - value
      - message
      type: object
    SuspendAccountHolderResponse:
      properties:
        accountHolderStatus:
          description: The new status of the Account Holder.
          $ref: '#/components/schemas/AccountHolderStatus'
        invalidFields:
          x-addedInVersion: '5'
          description: Contains field validation errors that would prevent requests from being processed.
          items:
            $ref: '#/components/schemas/ErrorFieldType'
          type: array
        pspReference:
          description: The reference of a request. Can be used to uniquely identify the request.
          type: string
        resultCode:
          description: The result code.
          type: string
      type: object
    GetTaxFormResponse:
      properties:
        content:
          description: The content of the tax form in Base64 format.
          format: byte
          type: string
        contentType:
          description: 'The content type of the tax form.


            Possible values:

            *  **application/pdf**


            '
          enum:
          - application/pdf
          type: string
      required:
      - content
      type: object
    ShareholderContact:
      properties:
        address:
          description: The address of the person.
          $ref: '#/components/schemas/ViasAddress'
        email:
          description: The e-mail address of the person.
          type: string
        fullPhoneNumber:
          description: 'The phone number of the person provided as a single string.  It will be handled as a landline phone.

            Examples: "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"'
          type: string
        jobTitle:
          description: 'Job title of the person. Required when the `shareholderType` is **Controller**.


            Example values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**.'
          type: string
        name:
          description: The name of the person.
          $ref: '#/components/schemas/ViasName'
        personalData:
          description: Contains information about the person.
          $ref: '#/components/schemas/ViasPersonalData'
        phoneNumber:
          description: The phone number of the person.
          $ref: '#/components/schemas/ViasPhoneNumber'
        shareholderCode:
          description: 'The unique identifier (UUID) of the shareholder entry.

            >**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.**


            >**If, during an Account Holder create request, a UUID is provided, the creation of Account Holder will fail with a validation Error..**


            >**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.**


            >**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.**

            '
          type: string
        shareholderReference:
          x-addedInVersion: '5'
          description: Your reference for the shareholder entry.
          type: string
        shareholderType:
          description: "Specifies how the person is associated with the account holder. \n\nPossible values: \n\n* **Owner**: Individuals who directly or indirectly own 25% or more of a company.\n\n* **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization."
          enum:
          - Controller
          - Owner
          - Signatory
          type: string
        webAddress:
          description: The URL of the person's website.
          type: string
      type: object
    VerificationDeadline:
      properties:
        capabilities:
          description: The names of the capabilities to be disallowed.
          items:
            enum:
            - acceptExternalFunding
            - acceptPspFunding
            - acceptTransactionInRestrictedCountries
            - acceptTransactionInRestrictedCountriesCommercial
            - acceptTransactionInRestrictedCountriesConsumer
            - acceptTransactionInRestrictedIndustries
            - acceptTransactionInRestrictedIndustriesCommercial
            - acceptTransactionInRestrictedIndustriesConsumer
            - acquiring
            - atmWithdrawal
            - atmWithdrawalCommercial
            - atmWithdrawalConsumer
            - atmWithdrawalInRestrictedCountries
            - atmWithdrawalInRestrictedCountriesCommercial
            - atmWithdrawalInRestrictedCountriesConsumer
            - authorisedPaymentInstrumentUser
            - getGrantOffers
            - issueBankAccount
            - issueCard
            - issueCardCommercial
            - issueCardConsumer
            - localAcceptance
            - payout
            - payoutToTransferInstrument
            - processing
            - receiveFromBalanceAccount
            - receiveFromPlatformPayments
            - receiveFromThirdParty
            - receiveFromTransferInstrument
            - receiveGrants
            - receivePayments
            - sendToBalanceAccount
            - sendToThirdParty
            - sendToTransferInstrument
            - thirdPartyFunding
            - useCard
            - useCardCommercial
            - useCardConsumer
            - useCardInRestrictedCountries
            - useCardInRestrictedCountriesCommercial
            - useCardInRestrictedCountriesConsumer
            - useCardInRestrictedIndustries
            - useCardInRestrictedIndustriesCommercial
            - useCardInRestrictedIndustriesConsumer
            - withdrawFromAtm
            - withdrawFromAtmCommercial
            - withdrawFromAtmConsumer
            - withdrawFromAtmInRestrictedCountries
            - withdrawFromAtmInRestrictedCountriesCommercial
            - withdrawFromAtmInRestrictedCountriesConsumer
            type: string
          readOnly: true
          type: array
        entityIds:
          description: The unique identifiers of the bank account(s) that the deadline applies to
          items:
            type: string
          readOnly: true
          type: array
        expiresAt:
          description: The date that verification is due by before capabilities are disallowed.
          format: date-time
          readOnly: true
          type: string
      required:
      - expiresAt
      - capabilities
      type: object
    JSONObject:
      type: object
    KYCVerificationResult:
      properties:
        accountHolder:
          description: The results of the checks on the account holder.
          $ref: '#/components/schemas/KYCCheckResult'
        legalArrangements:
          x-addedInVersion: '6'
          description: The results of the checks on the legal arrangements.
          items:
            $ref: '#/components/schemas/KYCLegalArrangementCheckResult'
          type: array
        legalArrangementsEntities:
          x-addedInVersion: '6'
          description: The results of the checks on the legal arrangement entities.
          items:
            $ref: '#/components/schemas/KYCLegalArrangementEntityCheckResult'
          type: array
        payoutMethods:
          x-addedInVersion: '6'
          description: The results of the checks on the payout methods.
          items:
            $ref: '#/components/schemas/KYCPayoutMethodCheckResult'
          type: array
        shareholders:
          description: The results of the checks on the shareholders.
          items:
            $ref: '#/components/schemas/KYCShareholderCheckResult'
          type: array
        signatories:
          description: The results of the checks on the signatories.
          items:
            $ref: '#/components/schemas/KYCSignatoryCheckResult'
          type: array
        ultimateParentCompany:
          x-addedInVersion: '6'
          description: The result of the check on the Ultimate Parent Company.
          items:
            $ref: '#/components/schemas/KYCUltimateParentCompanyCheckResult'
          type: array
      type: object
    ErrorFieldType:
      properties:
        errorCode:
          description: The validation error code.
          format: int32
          type: integer
        errorDescription:
          description: A description of the validation error.
          type: string
        fieldType:
          description: The type of error field.
          $ref: '#/components/schemas/FieldType'
      type: object
    CapabilityProblemEntity-recursive:
      properties:
        documents:
          description: List of document IDs to which the verification errors related to the capabilities correspond to.
          items:
            type: string
          type: array
        id:
          description: The ID of the entity.
          type: string
        type:
          description: "Type of entity. \n\nPossible values: **LegalEntity**, **BankAccount**, **Document**."
          enum:
          - BankAccount
          - Document
          - LegalEntity
          type: string
      required: []
      type: object
    PayoutMethod:
      properties:
        merchantAccount:
          description: The [`merchantAccount`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_merchantAccount) you used in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
          type: string
        payoutMethodCode:
          description: Adyen-generated unique alphanumeric identifier (UUID) for the payout method, returned in the response when you create a payout method. Required when updating an existing payout method in an `/updateAccountHolder` request.
          type: string
        payoutMethodReference:
          description: Your reference for the payout method.
          type: string
        recurringDetailReference:
          description: The [`recurringDetailReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-recurring-recurringDetailReference)  returned in the `/payments` response when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
          type: string
        shopperReference:
          description: The [`shopperReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_shopperReference) you sent in the `/payments` request when you [saved the account holder's card details](https://docs.adyen.com/marketplaces-and-platforms/classic/payouts/manual-payout/payout-to-cards#check-and-store).
          type: string
      required:
      - merchantAccount
      - shopperReference
      - recurringDetailReference
      type: object
    UpdateAccountHolderRequest:
      properties:
        accountHolderCode:
          description: The code of the Account Holder to be updated.
          type: string
        accountHolderDetails:
          description: 'The details to which the Account Holder should be updated.


            Required if a processingTier is not provided.'
          $ref: '#/components/schemas/AccountHolderDetails'
        description:
          x-addedInVersion: '4'
          description: A description of the account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.
          type: string
        legalEntity:
          x-addedInVersion: '5'
          description: 'The legal entity type of the account holder. This determines the information that should be provided in the request.


            Possible values: **Business**, **Individual**, or **NonProfit**.


            * If set to **Business** or **NonProfit**, then `accountHolderDetails.businessDetails` must be provided, with at least one entry in the `accountHolderDetails.businessDetails.shareholders` list.


            * If set to **Individual**, then `accountHolderDetails.individualDetails` must be provided.'
          enum:
          - Business
          - Individual
          - NonProfit
          - Partnership
          - PublicCompany
          type: string
        primaryCurrency:
          x-addedInVersion: '4'
          deprecated: true
          description: The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated.
          type: string
        processingTier:
          x-addedInVersion: '3'
          description: 'The processing tier to which the Account Holder should be updated.

            >The processing tier can not be lowered through this request.


            >Required if accountHolderDetails are not provided.'
          format: int32
          type: integer
        verificationProfile:
          x-addedInVersion: '6'
          description: The identifier of the profile that applies to this entity.
          type: string
      required:
      - accountHolderCode
      type: object
    CreateAccountHolderRequest:
      properties:
        accountHolderCode:
          description: 'Your unique identifier for the prospective account holder.

            The length must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are allowed.'
          type: string
        accountHolderDetails:
          description: The details of the prospective account holder.
          $ref: '#/components/schemas/AccountHolderDetails'
        createDefaultAccount:
          description: 'If set to **true**, an account with the default options is automatically created for the account holder.

            By default, this field is set to **true**.'
          type: boolean
        description:
          x-addedInVersion: '4'
          description: A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.
          type: string
        legalEntity:
          description: 'The legal entity type of the account holder. This determines the information that should be provided in the request.


            Possible values: **Business**, **Individual**, or **NonProfit**.


            * If set to **Business** or **NonProfit**, then `accountHolderDetails.businessDetails` must be provided, with at least one entry in the `accountHolderDetails.businessDetails.shareholders` list.


            * If set to **Individual**, then `accountHolderDetails.individualDetails` must be provided.'
          enum:
          - Business
          - Individual
          - NonProfit
          - Partnership
          - PublicCompany
          type: string
        primaryCurrency:
          x-addedInVersion: '4'
          deprecated: true
          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.
          type: string
        processingTier:
          x-addedInVersion: '3'
          description: The starting [processing tier](https://docs.adyen.com/marketplaces-and-platforms/classic/onboarding-and-verification/precheck-kyc-information) for the prospective account holder.
          format: int32
          type: integer
        verificationProfile:
          x-addedInVersion: '6'
          description: The identifier of the profile that applies to this entity.
          type: string
      required:
      - accountHolderCode
      - legalEntity
      - accountHolderDetails
      type: object
    ServiceError:
      properties:
        errorCode:
          description: The error code mapped to the error message.
          type: string
        errorType:
          description: The category of the error.
          type: string
        message:
          description: A short explanation of the issue.
          type: string
        pspReference:
          description: The PSP reference of the payment.
          type: string
        status:
          description: The HTTP response status.
          format: int32
          type: integer
      type: object
    AccountHolderUpdateRequest:
      properties:
        balancePlatform:
          description: The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.
          type: string
        capabilities:
          additionalProperties:
            $ref: '#/components/schemas/AccountHolderCapability'
          description: Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability.
          type: object
        contactDetails:
          deprecated: true
          description: Contact details of the account holder.
          $ref: '#/components/schemas/ContactDetails'
        description:
          description: Your description for the account holder, maximum 300 characters.
          maxLength: 300
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 'A set of key and value pairs for general use.

            The keys do not have specific names and may be used for storing miscellaneous data as desired.

            > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.'
          type: object
        migratedAccountHolderCode:
          description: The unique identifier of the migrated account holder in the classic integration.
          readOnly: true
          type: string
        primaryBalanceAccount:
          description: The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.
          type: string
        reference:
          description: Your reference for the account holder, maximum 150 characters.
          maxLength: 150
          type: string
        status:
          description: "The status of the account holder.\n\nPossible values: \n\n * **active**: The account holder is active. This is the default status when creating an account holder. \n\n * **inactive (Deprecated)**: The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details. \n\n * **suspended**: The account holder is permanently deactivated by Adyen. This action cannot be undone. \n\n* **closed**: The account holder is permanently deactivated by you. This action cannot be undone."
          enum:
          - active
          - closed
          - inactive
          - suspended
          type: string
        timeZone:
          description: 'The time zone of the account holder. For example, **Europe/Amsterdam**.

            Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).'
          type: string
        verificationDeadlines:
          description: List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
          items:
            $ref: '#/components/schemas/VerificationDeadline'
          readOnly: true
          type: array
      type: object
    FieldType:
      properties:
        field:
          description: The full name of the property.
          type: string
        fieldName:
          description: The type of the field.
          enum:
          - accountCode
          - accountHolderCode
          - accountHolderDetails
          - accountNumber
          - accountStateType
          - accountStatus
          - accountType
          - address
          - balanceAccount
          - balanceAccountActive
          - balanceAccountCode
          - balanceAccountId
          - bankAccount
          - bankAccountCode
          - bankAccountName
          - bankAccountUUID
          - bankBicSwift
          - bankCity
          - bankCode
          - bankName
          - bankStatement
          - branchCode
          - businessContact
          - cardToken
          - checkCode
          - city
          - companyRegistration
          - constitutionalDocument
          - controller
          - country
          - countryCode
          - currency
          - currencyCode
          - dateOfBirth
          - description
          - destinationAccountCode
          - document
          - documentContent
          - documentExpirationDate
          - documentIssuerCountry
          - documentIssuerState
          - documentName
          - documentNumber
          - documentType
          - doingBusinessAs
          - drivingLicence
          - drivingLicenceBack
          - drivingLicenceFront
          - drivingLicense
          - email
          - firstName
          - formType
          - fullPhoneNumber
          - gender
          - hopWebserviceUser
          - houseNumberOrName
          - iban
          - idCard
          - idCardBack
          - idCardFront
          - idNumber
          - identityDocument
          - individualDetails
          - infix
          - jobTitle
          - lastName
          - lastReviewDate
          - legalArrangement
          - legalArrangementCode
          - legalArrangementEntity
          - legalArrangementEntityCode
          - legalArrangementLegalForm
          - legalArrangementMember
          - legalArrangementMembers
          - legalArrangementName
          - legalArrangementReference
          - legalArrangementRegistrationNumber
          - legalArrangementTaxNumber
          - legalArrangementType
          - legalBusinessName
          - legalEntity
          - legalEntityType
          - logo
          - merchantAccount
          - merchantCategoryCode
          - merchantHouseNumber
          - merchantReference
          - microDeposit
          - name
          - nationality
          - originalReference
          - ownerCity
          - ownerCountryCode
          - ownerDateOfBirth
          - ownerHouseNumberOrName
          - ownerName
          - ownerPostalCode
          - ownerState
          - ownerStreet
          - passport
          - passportNumber
          - payoutMethod
          - payoutMethodCode
          - payoutSchedule
          - pciSelfAssessment
          - personalData
          - phoneCountryCode
          - phoneNumber
          - postalCode
          - primaryCurrency
          - reason
          - registrationNumber
          - returnUrl
          - schedule
          - shareholder
          - shareholderCode
          - shareholderCodeAndSignatoryCode
          - shareholderCodeOrSignatoryCode
          - shareholderType
          - shareholderTypes
          - shopperInteraction
          - signatory
          - signatoryCode
          - socialSecurityNumber
          - sourceAccountCode
          - splitAccount
          - splitConfigurationUUID
          - splitCurrency
          - splitValue
          - splits
          - stateOrProvince
          - status
          - stockExchange
          - stockNumber
          - stockTicker
          - store
          - storeDetail
          - storeName
          - storeReference
          - street
          - taxId
          - tier
          - tierNumber
          - transferCode
          - ultimateParentCompany
          - ultimateParentCompanyAddressDetails
          - ultimateParentCompanyAddressDetailsCountry
          - ultimateParentCompanyBusinessDetails
          - ultimateParentCompanyBusinessDetailsLegalBusinessName
          - ultimateParentCompanyBusinessDetailsRegistrationNumber
          - ultimateParentCompanyCode
          - ultimateParentCompanyStockExchange
          - ultimateParentCompanyStockNumber
          - ultimateParentCompanyStockNumberOrStockTicker
          - ultimateParentCompanyStockTicker
          - unknown
          - value
          - verificationType
          - virtualAccount
          - visaNumber
          - webAddress
          - year
          type: string
        shareholderCode:
          description: The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.
          type: string
      type: object
    MigratedStores:
      properties:
        businessLineId:
          description: The unique identifier of the business line associated with the migrated account holder in the balance platform.
          type: string
        storeCode:
          description: The unique identifier of the store associated with the migrated account holder in the classic integration.
          type: string
        storeId:
          description: The unique identifier of the store associated with the migrated account holder in the balance platform.
          type: string
        storeReference:
          description: Your reference for the store in the classic integration. The [Customer Area](https://ca-test.adyen.com/) uses this value for the store description.
          type: string
      type: object
    UpdateAccountHolderResponse:
      properties:
        accountHolderCode:
          description: The code of the account holder.
          type: string
        accountHolderDetails:
          description: Details of the account holder.
          $ref: '#/components/schemas/AccountHolderDetails'
        accountHolderStatus:
          x-addedInVersion: '2'
          description: The new status of the account holder.
          $ref: '#/components/schemas/AccountHolderStatus'
        description:
          x-addedInVersion: '4'
          description: The description of the account holder.
          type: string
        invalidFields:
          x-addedInVersion: '5'
          description: in case the account holder has not been updated, contains account holder fields, that did not pass the validation.
          items:
            $ref: '#/components/schemas/ErrorFieldType'
          type: array
        legalEntity:
          x-addedInVersion: '4'
          description: The legal entity of the account holder.
          enum:
          - Business
          - Individual
          - NonProfit
          - Partnership
          - PublicCompany
          type: string
        primaryCurrency:
          x-addedInVersion: '5'
          deprecated: true
          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.
          type: string
        pspReference:
          description: The reference of a request. Can be used to uniquely identify the request.
          type: string
        resultCode:
          description: The result code.
          type: string
        verification:
          x-addedInVersion: '2'
          description: The details of KYC Verification of the account holder.
          $ref: '#/components/schemas/KYCVerificationResult'
        verificationProfile:
          x-addedInVersion: '6'
          description: The identifier of the profile that applies to this entity.
          type: string
      type: object
    Amount:
      properties:
        currency:
          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
          maxLength: 3
          minLength: 3
          type: string
        value:
          description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
          format: int64
          type: integer
      required:
      - value
      - currency
      type: object
    ViasAddress:
      properties:
        city:
          description: The name of the city. Required if the `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided.
          type: string
        country:
          description: The two-character country code of the address in ISO-3166-1 alpha-2 format. For example, **NL**.
          type: string
        houseNumberOrName:
          description: The number or name of the house.
          type: string
        postalCode:
          description: 'The postal code. Required if the `houseNumberOrName`, `street`, `city`, or `stateOrProvince` are provided.


            Maximum length:


            * 5 digits for addresses in the US.


            * 10 characters for all other countries.'
          type: string
        stateOrProvince:
          description: "The abbreviation of the state or province. Required if the `houseNumberOrName`, `street`, `city`, or `postalCode` are provided. \n\nMaximum length:\n\n* 2 characters for addresses in the US or Canada.\n\n* 3 characters for all other countries.\n"
          type: string
        street:
          description: The name of the street. Required if the `houseNumberOrName`, `city`, `postalCode`, or `stateOrProvince` are provided.
          type: string
      required:
      - country
      type: object
    ViasPersonalData:
      properties:
        dateOfBirth:
          description: The person's date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.
          type: string
        documentData:
          x-addedInVersion: '3'
          description: Array that contains information about the person's identification document. You can submit only one entry per document type.
          items:
            $ref: '#/components/schemas/PersonalDocumentData'
          type: array
        nationality:
          description: 'The nationality of the person represented by a two-character country code,  in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.

            '
          maxLength: 2
          minLength: 2
          type: string
      type: object
    CapabilityProblem:
      properties:
        entity:
          description: Contains the type of the entity and the corresponding ID.
          $ref: '#/components/schemas/CapabilityProblemEntity'
        verificationErrors:
          description: Contains information about the verification error.
          items:
            $ref: '#/components/schemas/VerificationError'
          type: array
      type: object
    AccountSupportingEntityCapability:
      properties:
        allowed:
          description: Indicates whether the supporting entity capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability.
          readOnly: true
          type: boolean
        allowedLevel:
          description: 'The capability level that is allowed for the account holder.


            Possible values: **notApplicable**, **low**, **medium**, **high**.'
          enum:
          - high
          - low
          - medium
          - notApplicable
          readOnly: true
          type: string
        enabled:
          description: Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.
          type: boolean
        id:
          description: The ID of the supporting entity.
          readOnly: true
          type: string
        requested:
          description: Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.
          type: boolean
        requestedLevel:
          description: 'The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring.


            Possible values: **notApplicable**, **low**, **medium**, **high**.'
          enum:
          - high
          - low
          - medium
          - notApplicable
          type: string
        verificationStatus:
          description: 'The status of the verification checks for the supporting entity capability.


            Possible values:


            * **pending**: Adyen is running the verification.


            * **invalid**: The verification failed. Check if the `errors` array contains more information.


            * **valid**: The verification has been successfully completed.


            * **rejected**: Adyen has verified the information, but found reasons to not allow the capability.

            '
          enum:
          - invalid
          - pending
          - rejected
          - valid
          readOnly: true
          type: string
      type: object
    UpdateAccountHolderStateRequest:
      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.

            >Required if the state is being disabled.'
          type: string
        stateType:
          description: 'The state to be updated.

            >Permitted values are: `Processing`, `Payout`'
          enum:
          - LimitedPayout
          - LimitedProcessing
          - LimitlessPayout
          - LimitlessProcessing
          - Payout
          - Processing
          type: string
      required:
      - accountHolderCode
      - stateType
      - disable
      type: object
    MigratedAccounts:
      properties:
        balanceAccountId:
          description: The unique identifier of the account of the migrated account holder in the balance platform.
          type: string
        virtualAccountCode:
          description: The unique identifier of the account of the migrated account holder in the classic integration.
          type: string
      type: object
    Phone:
      properties:
        number:
          description: "The full phone number provided as a single string. \nFor example, **\"0031 6 11 22 33 44\"**, **\"+316/1122-3344\"**, \n\n or **\"(0031) 611223344\"**."
          type: string
        type:
          description: "Type of phone number.\nPossible values: \n**Landline**, **Mobile**.\n"
          enum:
          - landline
          - mobile
          type: string
      required:
      - number
      - type
      type: object
    PersonalDocumentData:
      properties:
        expirationDate:
          description: "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**."
          type: string
        issuerCountry:
          description: "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**."
          maxLength: 2
          minLength: 2
          type: string
        issuerState:
          description: The state where the document was issued (if applicable).
          type: string
        number:
          description: The number in the document.
          type: string
        type:
          description: 'The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.


            To delete an existing entry for a document `type`, send only the `type` field in your request. '
          enum:
          - DRIVINGLICENSE
          - ID
          - PASSPORT
          - SOCIALSECURITY
          - VISA
          type: string
      required:
      - type
      type: object
    KYCUltimateParentCompanyCheckResult:
      properties:
        checks:
          description: A list of the checks and their statuses.
          items:
            $ref: '#/components/schemas/KYCCheckStatusData'
          type: array
        ultimateParentCompanyCode:
          x-addedInVersion: '6'
          description: The code of the Ultimate Parent Company to which the check applies.
          type: string
      type: object
    PaginatedBalanceAccountsResponse:
      properties:
        balanceAccounts:
          description: List of balance accounts.
          items:
            $ref: '#/components/schemas/BalanceAccountBase'
          type: array
        hasNext:
          description: Indicates whether there are more items on the next page.
          type: boolean
        hasPrevious:
          description: Indicates whether there are more items on the previous page.
          type: boolean
      required:
      - balanceAccounts
      - hasPrevious
      - hasNext
      type: object
    GetAccountHolderStatusResponse:
      properties:
        accountHolderCode:
          description: The code of the Account Holder.
          type: string
        accountHolderStatus:
          x-addedInVersion: '2'
          description: The status of the Account Holder.
          $ref: '#/components/schemas/AccountHolderStatus'
        invalidFields:
          x-addedInVersion: '5'
          description: Contains field validation errors that would prevent requests from being processed.
          items:
            $ref: '#/components/schemas/ErrorFieldType'
          type: array
        pspReference:
          description: The reference of a request. Can be used to uniquely identify the request.
          type: string
        resultCode:
          description: The result code.
          type: string
      type: object
    AccountHolderCapability:
      properties:
        allowed:
          description: Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability.
          readOnly: true
          type: boolean
        allowedLevel:
          description: 'The capability level that is allowed for the account holder.


            Possible values: **notApplicable**, **low**, **medium**, **high**.'
          enum:
          - high
          - low
          - medium
          - notApplicable
          readOnly: true
          type: string
        allowedSettings:
          description: A JSON object containing the settings that are allowed for the account holder.
          readOnly: true
          $ref: '#/components/schemas/CapabilitySettings'
        enabled:
          description: Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.
          type: boolean
        problems:
          description: Contains verification errors and the actions that you can take to resolve them.
          items:
            $ref: '#/components/schemas/CapabilityProblem'
          readOnly: true
          type: array
        requested:
          description: Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.
          type: boolean
        requestedLevel:
          description: 'The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring.


            Possible values: **notApplicable**, **low**, **medium**, **high**.'
          enum:
          - high
          - low
          - medium
          - notApplicable
          type: string
        requestedSettings:
          description: A JSON object containing the settings that were requested for the account holder.
          readOnly: true
          $ref: '#/components/schemas/CapabilitySettings'
        transferInstruments:
          description: 'Contains the status of the transfer instruments associated with this capability. '
          items:
            $ref: '#/components/schemas/AccountSupportingEntityCapability'
          readOnly: true
          type: array
        verificationStatus:
          description: 'The status of the verification checks for the capability.


            Possible values:


            * **pending**: Adyen is running the verification.


            * **invalid**: The verification failed. Check if the `errors` array contains more information.


            * **valid**: The verification has been successfully completed.


            * **rejected**: Adyen has verified the information, but found reasons to not allow the capability.

            '
          enum:
          - invalid
          - pending
          - rejected
          - valid
          readOnly: true
          type: string
      type: object
    KYCCheckStatusData:
      properties:
        requiredFields:
          description: A list of the fields required for execution of the check.
          items:
            type: string
          type: array
        status:
          description: 'The status of the check.


            Possible values: **AWAITING_DATA** , **DATA_PROVIDED**, **FAILED**, **INVALID_DATA**, **PASSED**, **PENDING**, **RETRY_LIMIT_REACHED**.'
          enum:
          - AWAITING_DATA
          - DATA_PROVIDED
          - FAILED
          - INVALID_DATA
          - PASSED
          - PENDING
          - PENDING_REVIEW
          - RETRY_LIMIT_REACHED
          - UNCHECKED
          type: string
        summary:
          description: A summary of the execution of the check.
          $ref: '#/components/schemas/KYCCheckSummary'
        type:
          description: "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**: Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n  * **CARD_VERIFICATION**\n\n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**: Used in v6 and later.\n\n* **PCI_VERIFICATION**"
          enum:
          - BANK_ACCOUNT_VERIFICATION
          - CARD_VERIFICATION
          - COMPANY_VERIFICATION
          - IDENTITY_VERIFICATION
          - LEGAL_ARRANGEMENT_VERIFICATION
          - NONPROFIT_VERIFICATION
          - PASSPORT_VERIFICATION
          - PAYOUT_METHOD_VERIFICATION
          - PCI_VERIFICATION
          type: string
      required:
      - type
      - status
      type: object
    BalanceAccountBase:
      properties:
        accountHolderId:
          description: The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.
          type: string
        defaultCurrencyCode:
          description: 'The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.

            The default value is **EUR**.

            > After a balance account is created, you cannot change its default currency.'
          type: string
        description:
          description: A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder.
          maxLength: 300
          type: string
        id:
          description: The unique identifier of the balance account.
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 'A set of key and value pairs for general use.

            The keys do not have specific names and may be used for storing miscellaneous data as desired.

            > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.'
          type: object
        migratedAccountCode:
          description: The unique identifier of the account of the migrated account holder in the classic integration.
          readOnly: true
          type: string
        platformPaymentConfiguration:
          description: Contains key-value pairs to the configure the settlement model in a balance account.
          $ref: '#/components/schemas/PlatformPaymentConfiguration'
        reference:
          description: Your reference for the balance account, maximum 150 characters.
          maxLength: 150
          type: string
        status:
          description: "The status of the balance account, set to **active** by default. \n"
          enum:
          - active
          - closed
          - inactive
          - suspended
          type: string
        timeZone:
          description: 'The time zone of the balance account. For example, **Europe/Amsterdam**.

            Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).'
          type: string
      required:
      - accountHolderId
      - id
      type: object
    CloseAccountHolderRequest:
      properties:
        accountHolderCode:
          description: The code of the Account Holder to be closed.
          type: string
      required:
      - accountHolderCode
      type: object
    PaginatedAccountHoldersResponse:
      properties:
        accountHolders:
          description: List of account holders.
          items:
            $ref: '#/components/schemas/AccountHolder'
          type: array
        hasNext:
          description: Indicates whether there are more items on the next page.
          type: boolean
        hasPrevious:
          description: Indicates whether there are more items on the previous page.
          type: boolean
      required:
      - accountHolders
      - hasPrevious
      - hasNext
      type: object
    GetAccountHolderResponse:
      properties:
        accountHolderCode:
          description: The code of the account holder.
          type: string
        accountHolderDetails:
          description: Details of the account holder.
          $ref: '#/components/schemas/AccountHolderDetails'
        accountHolderStatus:
          x-addedInVersion: '2'
          description: The status of the account holder.
          $ref: '#/components/schemas/AccountHolderStatus'
        accounts:
          description: A list of the accounts under the account holder.
          items:
            $ref: '#/components/schemas/Account'
          type: array
        description:
          x-addedInVersion: '4'
          description: The description of the account holder.
          type: string
        invalidFields:
          x-addedInVersion: '5'
          description: Contains field validation errors that would prevent requests from being processed.
          items:
            $ref: '#/components/schemas/ErrorFieldType'
          type: array
        legalEntity:
          description: The legal entity of the account holder.
          enum:
          - Business
          - Individual
          - NonProfit
          - Partnership
          - PublicCompany
          type: string
        migrationData:
          x-addedInVersion: '5'
          description: Details of the account holder migrated to the balance platform.
          $ref: '#/components/schemas/MigrationData'
        primaryCurrency:
          x-addedInVersion: '4'
          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.
          type: string
        pspReference:
          description: The reference of a request. Can be used to uniquely identify the request.
          type: string
        resultCode:
          description: The result code.
          type: string
        systemUpToDateTime:
          x-addedInVersion: '5'
          description: The time that shows how up to date is the information in the response.
          format: date-time
          type: string
        verification:
          x-addedInVersion: '2'
          description: The details of KYC Verification of the account holder.
          $ref: '#/components/schemas/KYCVerificationResult'
        verificationProfile:
          x-addedInVersion: '6'
          description: The identifier of the profile that applies to this entity.
          type: string
      type: object
    AccountProcessingState:
      properties:
        disableReason:
          description: The reason why processing has been disabled.
          type: string
        disabled:
          description: Indicates whether the processing of payments is allowed.
          type: boolean
        processedFrom:
          description: 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).
          $ref: '#/components/schemas/Amount'
        processedTo:
          description: 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).
          $ref: '#/components/schemas/Amount'
        tierNumber:
          x-addedInVersion: '3'
          description: The processing tier that the account holder occupies.
          format: int32
          type: integer
      type: object
    KYCPayoutMethodCheckResult:
      properties:
        checks:
          description: A list of the checks and their statuses.
          items:
            $ref: '#/components/schemas/KYCCheckStatusData'
          type: array
        payoutMethodCode:
          description: The unique ID of the payoput method to which the check applies.
          type: string
      type: object
    CreateAccountHolderResponse:
      properties:
        accountCode:
          description: The code of a new account created for the account holder.
          type: string
        accountHolderCode:
          description: The code of the new account holder.
          type: string
        accountHolderDetails:
          description: Details of the new account holder.
          $ref: '#/components/schemas/AccountHolderDetails'
        accountHolderStatus:
          x-addedInVersion: '2'
          description: The status of the new account holder.
          $ref: '#/components/schemas/AccountHolderStatus'
        description:
          x-addedInVersion: '4'
          description: The description of the new account holder.
          type: string
        invalidFields:
          x-addedInVersion: '5'
          description: A list of fields that caused the `/createAccountHolder` request to fail.
          items:
            $ref: '#/components/schemas/ErrorFieldType'
          type: array
        legalEntity:
          x-addedInVersion: '4'
          description: The type of legal entity of the new account holder.
          enum:
          - Business
          - Individual
          - NonProfit
          - Partnership
          - PublicCompany
          type: string
        primaryCurrency:
          x-addedInVersion: '5'
          deprecated: true
          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals.
          type: string
        pspReference:
          description: The reference of a request. Can be used to uniquely identify the request.
          type: string
        resultCode:
          description: The result code.
          type: string
        verification:
          x-addedInVersion: '2'
          description: The details of KYC Verification of the account holder.
          $ref: '#/components/schemas/KYCVerificationResult'
        verificationProfile:
          x-addedInVersion: '6'
          description: The identifier of the profile that applies to this entity.
          type: string
      type: object
  examples:
    post-suspendAccountHolder-basic:
      summary: Suspend an account holder
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
    post-updateAccountHolder-businessDetails:
      summary: Update business details
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
        accountHolderDetails:
          businessDetails:
            shareholders:
            - address:
                city: Amsterdam
                country: NL
                houseNumberOrName: '1'
                postalCode: 1111AA
                stateOrProvince: NH
                street: Awesome St
              email: testshareholder2@email.com
              name:
                firstName: Alice
                lastName: Fields
            taxId: BV123456789
          email: test@email.com
          fullPhoneNumber: '+31612345678'
          webAddress: http://www.accountholderwebsite.com
    generic-400:
      summary: Response code 400. Bad Request.
      value:
        status: 400
        errorCode: '702'
        message: 'Unexpected input: I'
        errorType: validation
    generic-422:
      summary: Response code - 422 Unprocessable Entity.
      value:
        type: https://docs.adyen.com/errors/general/invalid-field-value
        title: Invalid Payment Instrument information provided
        status: 422
        detail: The balanceAccountId can only be changed when the status is Inactive or Requested
        requestId: 1W1UI15PLVGC9V8O
        errorCode: '30_031'
    post-updateAccountHolder-general:
      summary: Update account holder details
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
        accountHolderDetails:
          address:
            city: NY
            country: US
            postalCode: '12345'
            stateOrProvince: NH
            street: Teststreet 1
            houseNumberOrName: '100'
          email: test@adyen.com
          individualDetails:
            name:
              firstName: Simon
              lastName: Hopper
            personalData:
              dateOfBirth: '1970-01-01'
              documentData:
              - number: '1234567890'
                type: ID
              nationality: NL
          merchantCategoryCode: '7999'
          fullPhoneNumber: '+31612345678'
          webAddress: http://www.accountholderwebsite.com
    generic-500:
      summary: Response code - 500 Internal Server Error
      value:
        type: https://docs.adyen.com/errors/general/internal
        title: An internal error happened
        status: 500
        detail: Unrecoverable error while trying to create payment instrument
        requestId: 1WAF555PLWNTLYOQ
        errorCode: '00_500'
    generic-403_2:
      summary: Response code - 403 Forbidden.
      value:
        type: https://docs.adyen.com/errors/security/unauthorized
        title: Forbidden
        status: 403
        detail: Not the right permission to access this service.
        errorCode: '00_403'
    post-getAccountHolder-accountCode:
      summary: Get an account holder
      value:
        accountCode: CODE_OF_ACCOUNT
    post-unSuspendAccountHolder-basic:
      summary: Unsuspend an account holder
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
    patch-accountHolders-id-requestAccountHolderCapability-200:
      summary: Account holder capability requested
      description: Example response for requesting the `receivePayments` capability for an account holder
      value:
        balancePlatform: YOUR_BALANCE_PLATFORM
        description: Liable account holder used for international payments and payouts
        legalEntityId: LE322JV223222F5GKQZZ9DS99
        reference: S.Eller-001
        capabilities:
          receivePayments:
            enabled: false
            requested: true
            allowed: false
            verificationStatus: pending
        id: AH3227C223222C5GKR23686TF
        status: active
    post-closeAccountHolder-basic:
      summary: Close an account holder
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
    post-getAccountHolder-accountHolderCode:
      summary: Get an account holder for the account
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
    post-accountHolders-createAccountHolder-200:
      summary: Response for creating an account holder
      description: Example response for creating an account holder
      value:
        balancePlatform: YOUR_BALANCE_PLATFORM
        description: Liable account holder used for international payments and payouts
        legalEntityId: LE322JV223222D5GG42KN6869
        reference: S.Eller-001
        capabilities:
          receiveFromPlatformPayments:
            enabled: true
            requested: true
            allowed: false
            verificationStatus: pending
          receiveFromBalanceAccount:
            enabled: true
            requested: true
            allowed: false
            verificationStatus: pending
          sendToBalanceAccount:
            enabled: true
            requested: true
            allowed: false
            verificationStatus: pending
          sendToTransferInstrument:
            enabled: true
            requested: true
            allowed: false
            requestedSettings:
              interval: daily
              maxAmount:
                currency: EUR
                value: 0
            verificationStatus: pending
        id: AH3227C223222H5J4DCLW9VBV
        status: active
    get-accountHolders-id-success-200:
      summary: Account holder retrieved
      description: Example response when retrieving an account holder
      value:
        balancePlatform: YOUR_BALANCE_PLATFORM
        description: Liable account holder used for international payments and payouts
        legalEntityId: LE322JV223222D5GG42KN6869
        reference: S.Eller-001
        capabilities:
          receiveFromPlatformPayments:
            enabled: true
            requested: true
            allowed: false
            verificationStatus: pending
          receiveFromBalanceAccount:
            enabled: true
            requested: true
            allowed: false
            verificationStatus: pending
          sendToBalanceAccount:
            enabled: true
            requested: true
            allowed: false
            verificationStatus: pending
          sendToTransferInstrument:
            enabled: true
            requested: true
            allowed: false
            transferInstruments:
            - enabled: true
              requested: true
              allowed: false
              id: SE322KH223222F5GXZFNM3BGP
              verificationStatus: pending
            verificationStatus: pending
        id: AH3227C223222C5GXQXF658WB
        status: active
    generic-403:
      summary: Response code 401. Forbidden.
      value:
        status: 403
        errorCode: '10_003'
        message: Failed to authorize user
        errorType: security
    get-accountHolders-id-balanceAccounts-success-200:
      summary: List of balance accounts retrieved
      description: Example response when retrieving a list of balance accounts under an account holder
      value:
        balanceAccounts:
        - accountHolderId: AH32272223222B5CTBMZT6W2V
          defaultCurrencyCode: EUR
          description: S. Hopper - Main Account
          reference: YOUR_REFERENCE-X173L
          timeZone: Europe/Amsterdam
          id: BA32272223222B5CTDNB66W2Z
          status: active
        - accountHolderId: AH32272223222B5CTBMZT6W2V
          defaultCurrencyCode: EUR
          description: S. Hopper - Main Account
          reference: YOUR_REFERENCE-X173L
          timeZone: Europe/Amsterdam
          id: BA32272223222B5CTDQPM6W2H
          status: active
        - accountHolderId: AH32272223222B5CTBMZT6W2V
          defaultCurrencyCode: EUR
          description: S. Hopper - Main Account
          reference: YOUR_REFERENCE-X173L
          timeZone: Europe/Amsterdam
          id: BA32272223222B5CVF5J63LMW
          status: active
        hasNext: true
        hasPrevious: false
    post-createAccountHolder-individual:
      summary: Create an individual account holder
      value:
        accountHolderCode: GENERATE_CODE
        accountHolderDetails:
          email: tim@green.com
          individualDetails:
            name:
              firstName: Tim
              lastName: Green
          address:
            country: US
          webAddress: https://www.your-website.com
        legalEntity: Individual
    get-accountHolders-id-taxForms-success-200:
      summary: Tax form retrieved for an account holder
      description: Example response when retrieving a tax form for an account holder
      value:
        content: JVBERi0xLjcKJcfsj6IKJSVJbnZvY2F0aW9uOiBwYXRoL2dzd2luNjQuZXhlIC1kRGlzcGxh
        contentType: application/pdf
    post-accountHolders-createAccountHolder:
      summary: Create an account holder
      description: Example request for creating an account holder
      value:
        description: Liable account holder used for international payments and payouts
        reference: S.Eller-001
        legalEntityId: LE322JV223222D5GG42KN6869
    post-checkAccountHolder-basic:
      summary: Check the account holder.
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
        accountStateType: Processing
        tier: '2'
    get-balancePlatforms-id-accountHolders-success-200:
      summary: List of account holders retrieved
      description: Example response when retrieving a list of account holders under a balance platform
      value:
        accountHolders:
        - description: Test-305
          legalEntityId: LE3227C223222D5D8S5S33M4M
          reference: LegalEntity internal error test
          id: AH32272223222B5GFSNSXFFL9
          status: active
        - description: Test-751
          legalEntityId: LE3227C223222D5D8S5TT3SRX
          reference: LegalEntity internal error test
          id: AH32272223222B5GFSNVGFFM7
          status: active
        - description: Explorer Holder
          legalEntityId: LE3227C223222D5D8S5TT3SRX
          reference: Account from the Explorer Holder
          id: AH32272223222B5GFWNRFFVR6
          status: active
        hasNext: true
        hasPrevious: true
    post-updateAccountHolder-bankAccountDetails:
      summary: Update bank account details
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
        accountHolderDetails:
          email: tim@green.com
          individualDetails:
            name:
              firstName: Tim
              lastName: Green
          bankAccountDetails:
          - accountNumber: '1678116852'
            branchCode: '053101273'
            countryCode: US
            currencyCode: USD
            ownerName: Tim Green
            ownerHouseNumberOrName: '100'
            ownerStreet: Main Street
            ownerPostalCode: 2894
            ownerCity: Springfield
            ownerState: AZ
            ownerCountryCode: US
    patch-accountHolders-id-requestAccountHolderCapability:
      summary: Request account holder capability
      description: Example request for the `receivePayments` capability for an account holder
      value:
        description: Liable account holder used for international payments and payouts
        reference: S.Eller-001
        capabilities:
          receivePayments:
            requested: true
    post-updateAccountHolder-addShareholders:
      summary: Add shareholders
      value:
        accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
        accountHolderDetails:
          businessDetails:
            shareholders:
            - name:
                firstName: Alice
                lastName: Fields
              address:
                city: San Francisco
                country: US
                houseNumberOrName: '274'
                postalCode: '94107'
                stateOrProvince: CA
                street: Brannan
              email: testshareholder2@email.com
              personalData:
                dateOfBirth: '1970-01-01'
                documentData:
                - number: '1234567890'
                  type: ID
            taxId: '123456789'
          email: test@email.com
          fullPhoneNumber: '+14154890281'
          webAddress: http://www.accountholderwebsite.com
    generic-400_2:
      summary: Response code - 400 Bad request
      value:
        type: https://docs.adyen.com/errors/general/bad-request
        title: Bad request
        status: 400
        detail: Empty input which would have resulted in a null result.
        errorCode: '00_400'
    generic-401:
      summary: Response code - 401 Unauthorized
      value:
        type: https://docs.adyen.com/errors/security/unauthorized
        title: Unauthorized
        status: 401
        detail: Not authorized to access this service.
        errorCode: '00_401'
    post-createAccountHolder-business:
      summary: Create a business account holder
      value:
        accountHolderCode: YOUR_UNIQUE_ACCOUNT_HOLDER_CODE
        accountHolderDetails:
          address:
            country: US
          businessDetails:
            doingBusinessAs: Real Good Restaurant
            legalBusinessName: Real Good Restaurant Inc.
            shareholders:
            - name:
                firstName: John
                lastName: Carpenter
              address:
                country: NL
              email: testshareholder@email.com
          email: test@email.com
          webAddress: https://www.your-website.com
        legalEntity: Business
    patch-accountHolders-id-updateAccountHolderStatus-200:
      summary: Account holder deactivated
      description: Example response for permanently deactivating an account holder
      value:
        balancePlatform: YOUR_BALANCE_PLATFORM
        description: Liable account holder used for international payments and payouts
        legalEntityId: LE322JV223222F5GKQZZ9DS99
        reference: S.Eller-001
        id: AH3227C223222C5GKR23686TF
        status: closed
    post-updateAccountHolderState-basic:
      summary: Update account holder state
      value:
        accountHolderCode: CODE_OF_ACCOUNT_HOLDER
        disable: true
        reason: test reason payout
        stateType: Payout
    patch-accountHolders-id-updateAccountHolderStatus:
      summary: Deactivate an account holder
      description: Example request for permanently deactivating an account holder
      value:
        status: closed
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http
x-groups:
- Account holders
- Accounts
- Verification