Are you looking for test card numbers?

Would you like to contact support?

No momento, esta página não está disponível em português
Marketpay icon

Manage account holders

Learn how to manage account holders on your platform.

Here we explain how to manage your account holders and what they can do in your platform.

View account holders

To view account holders details, you can either make an API request or use your Balance Platform Customer Area. The following tabs explain both methods.

To get account holders, use the following endpoints:

View legal entity details

To view the legal entity details of an account holder using your Balance Platform Customer Area. To do this, you can search for the account holder associated to the legal entity. As an alternative:

  1. Go to Accounts & balances > Account holders.
  2. In the account holder table, select an Account holder ID to open the Account holder details page.
  3. In the Overview tab, select Legal entity.

The Legal entity details are shown in the page. If the legal entity is an organization, the page also shows details about the associated legal entities.

Request a capability

Default capabilities are automatically requested when you create an account holder. However, your account holders might need additional capabilities if, for example, your business expands its financial product offering. In these cases, you must request the additional capabilities.

The following tabs show how to request a capability.

Default capabilities are automatically requested when you create an account holder. However, if you need to request a specific capability, you must update the account holder and include the capabilities map.

In your PATCH /accountHolders/{id} request, set the capability that you are requesting as the key, and specify the following fields in the object:

Here is an example of how you would update an existing account holder to request the sendToTransferInstrument capability. If you're requesting for multiple capabilities, add another set of key-value object.

Request a capability 
curl https://balanceplatform-api-test.adyen.com/bcl/v2/accountHolders/AH00000000000000000000001 \
-H "content-type: application/json" \
-H "x-api-key: YOUR_BALANCE_PLATFORM_API_KEY" \
-X PATCH \
-d '{
  "capabilities" : {
    "sendToTransferInstrument" : {
      "requested" : true
    }
  }
}'

You receive a response informing you that the capability has been requested and the verification status is pending.

Response 
{
  "balancePlatform": "YOUR_BALANCE_PLATFORM",
  "id": "AH32272223222B5D3755J3C3C",
  "legalEntityId": "LE00000000000000000000001",
  "description": "S.Hopper",
  "capabilities": {
    "sendToTransferInstrument": {
      "requested": true,
      "allowed": false,
      "verificationStatus": "pending"
    }
  }
}

View capabilities

View an account holder's capabilities and their verification status in your Balance Platform Customer Area or by making a GET /accountHolders/{id} request. The following tabs explain both methods.

When you make a GET /accountHolders/{id} request, refer to the following response parameters in the capabilities object:

  • allowed: Boolean that indicates whether the capability is allowed.
  • verificationStatus: The status of the checks. The possible values are invalid, pending, rejected, or valid.
  • problems array: When this array is not empty, this means that there are errors that you need to address. Refer to verification error codes for a list of verification errors.

Enable or disable a capability

To allow or prevent an account holder from using a capability, update the capability in your Balance Platform Customer Area or request a PATCH /accountHolders/{id}. The following tabs explain both methods.

To disable a capability, make a PATCH /accountHolders/{id} request to update the capability. Set the enabled field to false.

Deactivate a capability 
curl https://balanceplatform-api-test.adyen.com/bcl/v2/accountHolders/AH00000000000000000000001 \
-H "content-type: application/json" \
-H "x-api-key: YOUR_BALANCE_PLATFORM_API_KEY" \
-X PATCH \
-d '{
    "capabilities": {
        "sendToTransferInstrument": {
            "enabled": false
        }
    }
}'

Update an account holder

After you create an account holder resource, you might need to update the resource at a later time. For example, an account holder that has several balance accounts might want to change their primary balance account.

To update an account holder, make a PATCH /accountHolders/{id} request.

The example below shows how you can change the primary balance account of an account holder by sending the primaryBalanceAccount field.

Change the primary balance account

Permanently deactivate account holders and their balance accounts

When an account holder discontinues their business, you can permanently deactivate them from your platform.

In some scenarios, you might also want to close a balance account but keep the account holder active. For example, an account holder that has separate balance accounts for their businesses might want to only close one of their businesses.

To close balance accounts and account holders:

  1. Check if they have zero balance in their balance accounts. You can only close empty balance accounts, so if there are funds left, you must pay out or transfer any remaining balance.

  2. Close balance accounts by updating each balance account and setting the status to Closed. Start with those that are not the primary balance account. You can only close a primary balance account if the account holder's other balance accounts are already closed.

  3. Finally, permanently deactivate the account holder by updating the account holder and setting the status to Closed.