Capital components are prebuilt libraries that enable you to offer Adyen Capital in your user interface (UI) with minimal engineering effort. These components integrate all the features required to offer business financing (also called a grant) to your users without making multiple API requests. This means you do not need to implement API calls to access available grant offers, generate the Terms of Service, or handle the grant payouts. The components handle all of this automatically.
Additionally, the components provide greater flexibility in selecting a grant amount. Your users can choose any amount within their qualifying limit, rather than being restricted to three fixed grant offers as in API-only integration.
This page provides information on:
- The available capital components, which include the Capital Overview component and the Capital Offer component.
- A standard user flow that these components cover.
Capital Overview component
The Capital Overview component provides detailed information (also known as a term sheet) for a grant, its current status, and repayment progress. This component also prompts users to complete necessary actions to secure the grant, such as signing the Terms of Service.
The following tabs illustrate how the component appears on various screen sizes.
The Capital Overview component enables users to:
- View messages indicating their eligibility to receive a grant.
- Sign the Terms of Service required to secure a grant from Adyen.
- Check the current status of their grant.
- Access the term sheet for detailed information about the active grant, such as the repayment threshold, repayment period, fees, the amount already repaid, and the remaining amount.
- Track their repayment progress.
By default, the Capital Overview component includes the Capital Offer component, which together provide a standard user flow.
Capital Offer component
The Capital Offer component shows users the maximum grant amount they qualify for and a preliminary term sheet, enabling them to apply for a grant.
The following tabs illustrate how the component appears on various screen sizes.
The Capital Offer component enables user to:
- Select a grant amount within their qualifying limit using a dynamic slider.
- View a preliminary term sheet of the selected grant offer, such as the repayment threshold, repayment period, and fees.
- Apply for a grant.
Standard user flow
By default, the Capital Offer component is embedded in the Capital Overview component, creating a standard user flow. This flow consists of a series of interactive screens that users engage with, all rendered within a single component element on the same UI page.
- Not qualified for a grant
- Pre-qualified for a grant
- Grant offer selection
- Grant offer term sheet
- Sign the Terms of Service
- Active grant
- Fully repaid grants
You can modify this standard user flow by including additional component instance methods and parameters in your implementation.
Qualifying limit of a grant
The qualifying limit of a grant is the maximum amount for which a user can be eligible. This limit varies for each individual and is determined based on their risk level assessment. In general, the grant amount a user may apply for through the capital components ranges from EUR 500 to EUR 25,000, or the equivalent amount in another supported currency.
Statuses of a grant
The capital components show the status of a grant, which represents the different stages the grant goes through. The components automatically manage status updates, so no further action is needed on your part.
The following diagram illustrates how grant statuses evolve over time.
You can find a detailed explanation for each status in the following table.
Status |
Description |
|---|---|
| Pending | The grant is requested and the Terms of Service are signed, but the funds are not yet paid out to the user's balance account. |
| Action needed | The grant is requested, and the user is required to sign Adyen's Terms of Service. |
| Active | The grant is approved and paid out to the user's balance account. The user can only have one active grant at a time. |
| Failed | The grant is requested, but not approved or paid out due to technical failures or incomplete documentation. |
| Fully repaid | The grant is fully repaid. The user can see a new grant offer, if eligible. |
| Revoked | The grant is canceled by the user. The grant funds are returned to Adyen. |
| Written off | The grant is closed by Adyen because the user failed to repay it. |
Term sheet of a grant
The capital components show a term sheet for a grant. Depending on where the user is in the user flow, this may either be a preliminary term sheet for a grant offer with limited details or a full term sheet for an active grant. The term sheet can include these details:
Term sheet item |
Description |
|---|---|
| Account | The unique reference of the balance account to which the grant amount is paid out. |
| Account ID | The unique identifier of the balance account to which the grant amount is paid out. By default, this is the user's primary balance account, which is the first balance account created for the associated account holder. |
| Daily repayment rate | The percentage of the user's daily net captured volume that is withheld each day for the repayment of the total repayment amount. |
| Expected repayment period | The period in days or months during which the user is expected to repay the grant amount. This period is calculated based on the volume of transactions processed for this user. |
| Grant ID | The unique identifier of the grant. |
| Maximum repayment period | The period in days or months during which the grant repayment amount must be paid in full. |
| Remaining amount | The outstanding grant amount, excluding fees, as of a specific date. |
| Remaining fees | The outstanding fee amount as of a specific date. |
| Repaid amount | The grant amount paid back to Adyen as of a specific date. |
| Repaid fees | The fee amount paid back to Adyen as of a specific date. |
| Repayment threshold | The minimum amount the user is expected to repay every 30-day period to fully pay off the grant within the expected repayment period. If the total 30-day repayment drops below this threshold, Adyen may take additional actions to ensure that the user repays on time. |
| Total fees | The fixed fees associated with the grant that the user must pay to Adyen in relation to business financing. |
| Total repayment amount | The total amount due for repayment, which includes the grant amount received along with any associated fees. |
Supported languages
You can set one of the following languages to localize any of the Platform Experience components.
| Language | Locale code |
|---|---|
| Danish | da-DK |
| Dutch | nl-NL |
| English | en-US |
| Finnish 1 | fi-FI |
| French | fr-FR |
| German | de-DE |
| Italian | it-IT |
| Norwegian | no-NO |
| Portuguese (BR) | pt-BR |
| Spanish | es-ES |
| Swedish | sv-SE |
1 Support for the Finnish language is available starting from library version 1.2.0.