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

Manage user capabilities

Learn about the capabilities your user must have to get business financing and how to manage them.

Your users are represented by an account holder resource in your balance platform. Each account holder is associated with a set of capabilities that determine what they can do on your platform. To access business financing with Adyen Capital, users must have capital capabilities.

In most cases, Adyen configures the necessary capabilities during the design phase of your Capital integration. These capabilities are then automatically requested for your users when you create account holders for them. However, you can request these capabilities later and enable or disable them for individual account holders if needed.

Requirements

Before you begin, take into account the following requirements, limitations, and preparations.

Requirement	Description
Integration type	You must have an Adyen for Platforms integration with the Capital financial product enabled.
API credentials	To manage user capabilities through the API, you must have a Balance Platform API key (for example, ws[_123456]@BalancePlatform.[YourBalancePlatform]) to access the Configuration API. Your API credential must have the following role: Balance Platform BCL role
Customer Area roles	To manage user capabilities in the Customer Area, you must have the following user role: Manage account holder capabilities
Limitations	Your user must operate in one of the supported countries/regions.
Setup steps	Before you begin, make sure: You reached out to your Adyen contact to set up the necessary configurations to add the Capital financial product to your integration. For more details, see our Integration checklist. You followed our compliance guidelines for Capital when creating user interfaces, marketing materials, and other processes. You read our documentation about capability settings and capability verification statuses.

Capital capabilities

Adyen Capital requires your user's account holder to have the following capabilities:

Capability name	Display name in Customer Area	Description
getGrantOffers	Receive grant offers	Allows users to receive offers for business financing based on the volume of their payment processing. When you request this capability for a user, Adyen evaluates their eligibility for business financing. When the user qualifies and the capability is allowed, Adyen generates grant offers for them.
receiveGrants	Receive grants	Allows users to receive business financing funds from Adyen. When you request this capability, Adyen verifies whether the account holder has signed the Terms of Service. When they have and both `getGrantOffers` and `receiveGrants` capabilities are allowed, you can proceed to disburse the funds to your user.

Request a capability

If needed, you can request capabilities for your account holders in your Customer Area or using the Configuration API.

The following tabs show how to request a capability.

View capabilities

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

Enable or disable a capability

To allow or prevent an account holder from using a capability, update the capability in your Customer Area or make an API request. The following tabs explain both methods.