Sign in
Account holders

Update an account holder

Updates an account holder. When updating an account holder resource, if a parameter is not provided in the request, it is left unchanged.

patch/accountHolders/{id}

Path parameters

idstring required

The unique identifier of the account holder.

Request body

balancePlatformstring

The unique identifier of the balance platform to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.

capabilitiesobject

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.

descriptionstring

Your description for the account holder.

metadataobject

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.

migratedAccountHolderCodestring

The unique identifier of the migrated account holder in the classic integration.

primaryBalanceAccountstring

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.

referencestring

Your reference for the account holder.

status'active' | 'closed' | 'suspended'

The status of the account holder.

Possible values:

  • active: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to suspended or closed.

  • suspended: The account holder is temporarily disabled and payouts are blocked. You can change this status to active or closed.

  • closed: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.

timeZonestring

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.

Response

OK - the request has succeeded.

balancePlatformstring

The unique identifier of the balance platform to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.

capabilitiesobject

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.

descriptionstring

Your description for the account holder.

idstring required

The unique identifier of the account holder.

legalEntityIdstring required

The unique identifier of the legal entity associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.

metadataobject

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.

migratedAccountHolderCodestring

The unique identifier of the migrated account holder in the classic integration.

primaryBalanceAccountstring

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.

referencestring

Your reference for the account holder.

status'active' | 'closed' | 'suspended'

The status of the account holder.

Possible values:

  • active: The account holder is active and allowed to use its capabilities. This is the initial status for account holders and balance accounts. You can change this status to suspended or closed.

  • suspended: The account holder is temporarily disabled and payouts are blocked. You can change this status to active or closed.

  • closed: The account holder and all of its capabilities are permanently disabled. This is a final status and cannot be changed.

timeZonestring

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.

Changes

Changed in 8 of the 51 revisions of this API.92730

  • v2dd6159049c95826See the full diff
    • ▲

      the capabilities/additionalProperties/allowedSettings/amountPerIndustry/additionalProperties/currency response property's maxLength was unset from 3 for the response status 200

      response-property-max-length-unset

    • ▲

      the capabilities/additionalProperties/allowedSettings/maxAmount/currency response property's maxLength was unset from 3 for the response status 200

      response-property-max-length-unset

    • ▲

      the capabilities/additionalProperties/requestedSettings/amountPerIndustry/additionalProperties/currency response property's maxLength was unset from 3 for the response status 200

      response-property-max-length-unset

    • ▲

      the capabilities/additionalProperties/requestedSettings/maxAmount/currency response property's maxLength was unset from 3 for the response status 200

      response-property-max-length-unset

    • ▲

      the capabilities/additionalProperties/allowedSettings/amountPerIndustry/additionalProperties/currency response property's minLength was decreased from 3 to 0 for the response status 200

      response-property-min-length-decreased

    • ▲

      the capabilities/additionalProperties/allowedSettings/maxAmount/currency response property's minLength was decreased from 3 to 0 for the response status 200

      response-property-min-length-decreased

    • ▲

      the capabilities/additionalProperties/requestedSettings/amountPerIndustry/additionalProperties/currency response property's minLength was decreased from 3 to 0 for the response status 200

      response-property-min-length-decreased

    • ▲

      the capabilities/additionalProperties/requestedSettings/maxAmount/currency response property's minLength was decreased from 3 to 0 for the response status 200

      response-property-min-length-decreased

    • ●

      added the new dataReview enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new dataReview enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new dataReview enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/type

      request-property-enum-value-added

    • ○

      added the new dataReview enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/type

      request-property-enum-value-added

    • ○

      the capabilities/additionalProperties/allowedSettings/amountPerIndustry/additionalProperties/currency request property's minLength was decreased from 3 to 0

      request-property-min-length-decreased

    • ○

      the capabilities/additionalProperties/allowedSettings/maxAmount/currency request property's minLength was decreased from 3 to 0

      request-property-min-length-decreased

    • ○

      the capabilities/additionalProperties/requestedSettings/amountPerIndustry/additionalProperties/currency request property's minLength was decreased from 3 to 0

      request-property-min-length-decreased

    • ○

      the capabilities/additionalProperties/requestedSettings/maxAmount/currency request property's minLength was decreased from 3 to 0

      request-property-min-length-decreased

  • v2de1988a0d7b11212See the full diff
    • ●

      added the new issueChargeCard enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueChargeCard enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueChargeCard enum value to the verificationDeadlines/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueChargeCardCommercial enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueChargeCardCommercial enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueChargeCardCommercial enum value to the verificationDeadlines/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new useChargeCard enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new useChargeCard enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new useChargeCard enum value to the verificationDeadlines/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new useChargeCardCommercial enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new useChargeCardCommercial enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new useChargeCardCommercial enum value to the verificationDeadlines/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new issueChargeCard enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueChargeCard enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueChargeCard enum value to the request property verificationDeadlines/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueChargeCardCommercial enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueChargeCardCommercial enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueChargeCardCommercial enum value to the request property verificationDeadlines/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new useChargeCard enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new useChargeCard enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new useChargeCard enum value to the request property verificationDeadlines/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new useChargeCardCommercial enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new useChargeCardCommercial enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new useChargeCardCommercial enum value to the request property verificationDeadlines/items/capabilities/items/

      request-property-enum-value-added

  • v280dfacd37eec33See the full diff
    • ●

      added the new issueCreditLimit enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueCreditLimit enum value to the capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new issueCreditLimit enum value to the verificationDeadlines/items/capabilities/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new issueCreditLimit enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueCreditLimit enum value to the request property capabilities/additionalProperties/problems/items/verificationErrors/items/subErrors/items/capabilities/items/

      request-property-enum-value-added

    • ○

      added the new issueCreditLimit enum value to the request property verificationDeadlines/items/capabilities/items/

      request-property-enum-value-added

  • v26f1fad79c6c011See the full diff
    • ▲

      removed the enum value inactive of the request property status

      request-property-enum-value-removed

    • ○

      removed the inactive enum value from the status response property for the response status 200

      response-property-enum-value-removed

  • v224691235e7213See the full diff
    • ○

      the endpoint scheme security clientKey was added to the API

      api-security-added

    • ○

      the request optional property capabilities/additionalProperties/transferInstruments became read-only

      request-optional-property-became-read-only

    • ○

      the response optional property capabilities/additionalProperties/transferInstruments became read-only for the status 200

      response-optional-property-became-read-only

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v212a0c6036e6b10See the full diff
    • ●

      removed the optional property response/paths from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property response/paths from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property response/paths from the response with the 403 status

      response-optional-property-removed

    • ●

      removed the optional property response/paths from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property response/paths from the response with the 500 status

      response-optional-property-removed

    • ●

      removed the optional property response/rootPath from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property response/rootPath from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property response/rootPath from the response with the 403 status

      response-optional-property-removed

    • ●

      removed the optional property response/rootPath from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property response/rootPath from the response with the 500 status

      response-optional-property-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v25f5aad6991854See the full diff
    • ○

      added the new optional request property capabilities/additionalProperties/problems/items/entity

      new-optional-request-property

    • ○

      added the new optional request property capabilities/additionalProperties/problems/items/verificationErrors

      new-optional-request-property

    • ○

      added the optional property capabilities/additionalProperties/problems/items/entity to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property capabilities/additionalProperties/problems/items/verificationErrors to the response with the 200 status

      response-optional-property-added

  • v2ad8e1da0fe301See the full diff
    • ○

      added the optional property verificationDeadlines/items/entityIds to the response with the 200 status

      response-optional-property-added