Manage disbursements

Learn how to get and update configurations of a disbursement.

After the grant amount is disbursed to your user, you can retrieve information about a particular disbursement and update its configurations.

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: Balance_Platform_Capital_Configuration_Role Balance_Platform_Capital_Grant_Initiation_Role
Capabilities	Make sure that your user's account holder has the following capabilities: getGrantOffers receiveGrants
Limitations	Currently, only one disbursement per grant is allowed. We are working on enabling multiple disbursements to different balance accounts.
Setup steps	Before you begin: Reach 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. Verify that your user is operating in one of the supported countries/regions. Ensure compliance with our guidelines for Capital when creating user interfaces, marketing materials, and other processes. Ensure you user has selected a grant offer and signed the Terms of Service. Ensure you have disbursed at least one grant.

How it works

Depending on the level of detail or the action you need, you can either:

Get all disbursements related to a grant.
Update the repayment configuration for a particular disbursement.
Retrieve bank account details for a particular disbursement to manage unscheduled repayments.

Get all disbursements of a grant

To get all disbursements related to a grant:

Make a GET /grants/{grantId}/disbursements request, specifying the following parameters in the path:

Parameter Required Description

grantId The identifier of the grant reference.

In the response, note the following parameters:

Parameter	Description
accountHolderId	The unique identifier of the account holder that received the disbursement.
amount	An object containing the amount of the disbursement, in minor units.
balanceAccountId	The unique identifier of the balance account that received the disbursement.
balances	An object containing the balances of the disbursement.
fee	An object containing the fee that your user must pay for the disbursement.
fundsCollections	An object containing the accounts that Adyen uses to collect funds related to repayments.
grantId	The unique identifier of the grant related to the disbursement.
disbursementsId	The unique identifier of the disbursement.
repayment	An object containing the basis points configured for repaying the disbursement.

Update repayment configuration of a disbursement

You can update the repayment configuration of a specific disbursement. Specifically, you can change the percentage of your user's incoming net volume that is deducted for repaying the grant. To do this:

Make a PATCH /grants/{grantId}/disbursements/{disbursementId} request specifying the following parameters:

Parameter	Parameter type	Description
disbursementId	Path	The unique identifier of the disbursement.
grantId	Path	The identifier of the grant reference.
repayment	Request	An object containing the basis points configured for repaying the disbursement.

Here's an example of how to update the repayment configuration of a specific disbursement.

In the response, note the following parameters:

Parameter	Description
accountHolderId	The unique identifier of the account holder that received the disbursement.
amount	An object containing the amount of the disbursement, in minor units.
balanceAccountId	The unique identifier of the balance account that received the disbursement.
balances	An object containing the balances of the disbursement.
fee	An object containing the fee that your user must pay for the disbursement.
fundsCollections	An object containing the accounts that Adyen uses to collect funds related to repayments.
grantId	The unique identifier of the grant related to the disbursement.
disbursementId	The unique identifier of the disbursement.
repayment	An object containing the basis points configured for repaying the disbursement.

Retrieve bank account details for unscheduled repayments

This feature is currently only available for users operating in Europe, the United Kingdom, and the United States.

Users can make unscheduled payments to repay their grant using the dedicated bank account details (for example, IBAN) assigned to each disbursement. You can retrieve these bank account details by making an API call. Then, you can share the information with your users.

To retrieve bank account details for a particular disbursement:

Make a GET /grants/{grantId}/disbursements/{disbursementId} request, specifying the following path parameters:

Parameter Required Description

disbursementId The unique identifier of the disbursement.

grantId The identifier of the grant reference.

In the response, note the fundsCollections object containing the following parameters:

Parameter	Description
fundsCollections.accountIdentification	An object containing the identification information of the account to which your user can transfer funds related to unscheduled repayments. For example, the international bank account number (IBAN).
fundsCollections.type	The type of funds collection. Must be set to UnscheduledRepayment.