Before offering business financing to your users, Adyen does a proactive risk assessment of your user based on the user's payments data. This assessment results in a maximum of three grant offers that you can show to the user.
Offers are only generated for the users that meet our eligibility criteria. To learn more about the eligibility criteria, reach out to your Adyen contact.
This page explains how to use the Capital API to get grant offers available to your user.
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. |
| API credentials | You must have a Balance Platform API key (for example, ws[_123456]@BalancePlatform.[YourBalancePlatform]) to access the Capital API. Ensure that you have asked your Adyen contact to assign the following role to your API credential:
|
| Capabilities | Make sure that your user's account holder has the following capability:
|
| Limitations | With the API-only integration, Adyen generates a maximum of three grant offers that you can present to your user. Each offer includes different grant amounts. |
| Setup steps | Before you begin:
|
How it works
To provide information about a grant offer to your user:
- Make an API request to get all available grant offers for an account holder.
- Make an API request to get details about a specific grant offer.
Each grant offer includes the following information:
- The grant amount available to the user.
- The fee associated with the grant.
- The repayment terms for the grant.
1. Get grant offers available to an account holder
To get the grant offers available for your user, make a GET /grantOffers request with the accountHolderId as a query parameter:
| Parameter | Required | Description |
|---|---|---|
| accountHolderId |  |
The unique identifier of the receiving account holder. |
The response contains the grantOffers object with the following parameters:
| Parameter | Description |
|---|---|
| accountHolderId | The unique identifier of the receiving account holder. |
| amount | An object containing the amount of the grant, in minor units. |
| contractType | The legal type of the grant offer. Possible values: loan, cashAdvance. |
| expiresAt | The expiring date of the offer validity period. |
| fee | An object containing the fee currency and value, in minor units. |
| id | The unique identifier of the grant offer. |
| repayment | An object containing the details of the repayment configuration. |
| repayment.basisPoints | The repayment that is deducted daily from incoming net volume, in basis points. |
| repayment.term.estimatedDays | The estimated term for repaying the grant, in days. |
| repayment.term.maximumDays | The maximum term for repaying the grant, in days. Only returned when contractType is loan. |
| repayment.threshold | An object containing the details of the 30-day repayment threshold. |
| startsAt | The starting date of the offer validity period. |
The following example shows three grant offers of USD 500, USD 800, and USD 1000. The repayment rate is 7, 11, and 14 percent respectively with a 90-day expected term.
2. Get a specific grant offer
To get a specific grant offer, make a GET /grantOffers/{id} request, specifying the id in the path.
In the response, you receive an object containing all the information about the grant.