Capital API

The Capital API provides endpoints for embedding Adyen Capital into your marketplace or platform. With Capital, you can offer business financing to your users as grants. When a user receives a grant, they must repay the grant amount in a specified term, in addition to paying a fee for using this service.

With these endpoints, you can:

  • Get available grant offers: You can get the grant offers that are available for your users. Adyen configures the financing amount, the fee, and the repayment conditions for each offer. These configurations are based on proactive risk analyses that Adyen performs on your users.
  • Make requests for grants: When a user selects a grant offer, you can make a request for the grant on their behalf.
  • Get information about your grant account: Your grant account tracks the information of all grants in your marketplace or platform.

Authentication

Each request made to the Capital API must be signed with an API key. Generate an API key in your Customer Area.

To connect to the API, add an X-API-Key header with the API key as the value, for example:

curl
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
...

Roles and permissions

To use the Capital API, your API credential must have the following roles:

  • Balance_Platform_Capital_Configuration_Role
  • Balance_Platform_Capital_Grant_Initiation_Role

Reach out to your Adyen contact to set up these roles.

Going live

When going live, generate an API key in your live Customer Area. You can then use the API key to send requests to https://balanceplatform-api-live.adyen.com/capital/v{version}.

get/grants
Get all the grants of an account holder
post/grants
Make a request for a grant
get/grants/{grantId}
Get the details of a grant
get/grants/{grantId}/disbursements
Get all the disbursements of a grant
patch/grants/{grantId}/disbursements/{disbursementId}
Update the repayment configuration of a disbursement
get/grantAccounts/{id}
Get the information of your grant account
get/grantOffers/{id}
Get the details of a grant offer
get/grantOffers
Get all available grant offers