Get grant offers

Get personalized grant offers that you can present to your users.

Before offering business financing to your users, Adyen conducts a proactive risk assessment for each user based on their processed payment volume. This assessment results in personalized grant offers. Offers are only generated for users who meet our eligibility criteria. To learn more about these criteria, reach out to your Adyen contact.

You can get the list of grant offers to present to your users. Adyen provides various ways to access grant offers, depending on your use case and the level of detail you require:

You can get grant offers for all eligible users across the entire balance platform. This is useful if you want to run a marketing campaign aimed at driving conversions.
You can get grant offers available for an individual account holder, which is ideal for low-scope personalized campaigns.
You can get a single grant offer to be more specific in your offerings for an individual account holder.

This page explains how to get personalized grant offers that you can present to your users using the Capital API.

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	You must have a Balance Platform API key (for example, ws[_123456]@BalancePlatform.[YourBalancePlatform]) to access the Capital API. Your API credential must have the following roles: Balance Platform Capital Configuration role Balance Platform Capital Grant Initiation role
Capabilities	When getting grant offers available to an account holder, make sure that your user have the following capability: getGrantOffers
Limitations	Your user must operate in one of the supported countries/regions. The grant offer remains valid for seven days. After this period, a new offer is generated for an account holder if they still meet the qualification criteria. The amount of the grant offer may differ from one offer to another.
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. Your application includes a CSV module to manage data if you intend to get grant offers for all account holders in your balance platform

Get grant offers for all eligible users

You can get grant offers for all eligible users across the entire balance platform. Adyen provides this information in a CSV format, making it easy to analyze and utilize. For example, you can use this data to launch marketing campaigns that promote business financing.

Each offer is personalized for the account holder based on their processing history and has its own expiration date. The CSV file contains the minimum and the maximum grant amount each account holder is eligible for. The actual grant offer will fall within this specified range, but the exact amount may vary.

The grant offer data is automatically generated every day at midnight based on Central European Time (CET). If an account holder does not appear on the list, it means there are currently no active offers available for them or they already have an active grant.

To get grant offers for all eligible users using the Capital API:

Make a GET /grantOffers/download/{balancePlatformId} request, specifying the balancePlatformId in the path.
In response, you will receive a CSV file. Verify that the file has been successfully downloaded to your internal storage.

Sample

Download a sample eligible offer list for examples of the included data. Your downloaded file name should be similar to this: BalancePlatformName_EligibleCapitalOffers_YYYY_MM_DD.csv.

Here is an example of what the list looks like.

Balance Platform name	Account holder ID	Min amount	Max amount	Currency	Start date (CEST	Expiry Date (CEST
TestBalancePlatform	AH00000000000000000000001	1.00	6083.14	NOK	2025-10-05T22:42:44.6+02:00	2025-10-12T22:42:44.6+02:00
TestBalancePlatform	AH00000000000000000000002	1.00	2600.11	EUR	2025-10-05T22:42:44.517+02:00	2025-10-12T22:42:44.517+02:00
TestBalancePlatform	AH00000000000000000000003	1.00	8668.44	GPB	2025-10-05T22:42:46.255+02:00	2025-10-12T22:42:46.255+02:00

Data structure

If you need to upload the CSV data to any other application for future analysis, here is how you should interpret the columns and their data types.

#	Column	Data type	Description
1	Balance Platform name	Unicode Text	The name of your Balance Platform account.
2	Account holder ID	Unicode Text	The unique identifier of the account holder.
3	Min amount	String	The minimum grant amount the account holder is eligible for, expressed in major units.
4	Max amount	String	The maximum grant amount the account holder is eligible for, expressed in major units.
5	Currency	Alpha Text (3-character limit)	The three-character ISO currency code for the grant offer.
6	Start date	Date field + Time field + Timezone	The timestamp indicating the start date and time of the grant offer's validity, in ISO 8601 format.
7	Expiry date	Date field + Time field + Timezone	The timestamp indicating the end date and time of the grant offer's validity, in ISO 8601 format.

Get grant offers available to an account holder

When getting grant offers for an individual account holder, you receive a maximum of three grant offers that you can present to your user. Each offer includes different grant amounts.

To get the grant offers available for your user:

Make a GET /grantOffers request with the receiving accountHolderId as a query parameter.

The response, note 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.

Get a specific grant offer

To get the details of a specific grant offer:

Make a GET /grantOffers/{id} request, specifying the id in the path.
In the response, note an object containing all the information about the grant.

Next steps

required

Make a grant request

Learn how to make a request for a grant and pay the funds out to your user.

Get grant balances

Learn how to get the balances of all grants in your balance platform.