Capital API
The Capital API provides endpoints for embedding [Adyen Capital](https://docs.adyen.com/capital) into your marketplace or platform. With Capital, you can…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 financing offers: You can get a list of offers with fixed amounts or a range of available financing 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 financing 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}.
Endpoints 12
Dynamic offers
- GETGet all available dynamic offers
/dynamicOffers?accountHolderId=string&financingType=hardwareFinancingReturns a list of all dynamic offers available for accountHolderId specified as a query parameter. - POSTCalculate a preliminary offer for a selected financing amount
/dynamicOffers/:id/calculateCalculates a preliminary offer for the financing amount that the user selected from a dynamic offer. The preliminary offer is for informational purposes only… - POSTCreate a static offer for a selected financing amount
/dynamicOffers/:id/grantOfferCreates a static offer for the financing amount that the user selected from the dynamic offer. Requests to this endpoint are subject to rate limits: Live…
Grant offers
- GETGet all available static offers
/grantOffers?accountHolderId=stringReturns a list of all static offers available for accountHolderId specified as a query parameter. This also includes static offers created for financing… - GETGet the details of a static offer
/grantOffers/:idReturns the details of the specified static offer.
Grants
- GETGet all the grants of an account holder
/grants?counterpartyAccountHolderId=stringReturns a list of all the grants of a specific account holder. - POSTMake a request for a grant
/grantsMake a request for a grant on behalf of an account holder. - GETGet the details of a grant
/grants/:grantIdReturns the details of the specified grant. - GETGet all the disbursements of a grant
/grants/:grantId/disbursementsReturns the disbursements of a specified grant. - GETGet disbursement details
/grants/:grantId/disbursements/:disbursementIdReturns the details of a disbursement specified in the path. - PATCHUpdate the repayment configuration of a disbursement
/grants/:grantId/disbursements/:disbursementIdUpdate the percentage of your user's net income that is deducted for repaying the grant.
Grant accounts
- GETGet the information of your grant account
/grantAccounts/:idReturns the details of the specified grant account. This account tracks existing grants in your marketplace or platform.
API details
- Base URL
https://balanceplatform-api-test.adyen.com/capital/v1https://balanceplatform-api-live.adyen.com/capital/v1- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 12 operations on 10 pathsGET 8POST 3PATCH 1
- Main resources
- Grants 6Dynamic offers 3Grant offers 2Grant accounts 1
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the Capital API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Capital API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get all available dynamic offers” (GET /dynamicOffers?accountHolderId=string&financingType=hardwareFinancing), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Capital API?
The Capital API provides endpoints for embedding [Adyen Capital](https://docs.adyen.com/capital) into your marketplace or platform. With Capital, you can… It is listed under Payments and has 12 endpoints.
Who publishes the Capital API?
It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Capital API?
Its description lists 2 base URLs: https://balanceplatform-api-test.adyen.com/capital/v1, https://balanceplatform-api-live.adyen.com/capital/v1. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Capital API?
It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).
How many endpoints does the Capital API have?
12 operations on 10 paths (8 GET, 3 POST, 1 PATCH). The largest groups are Grants, Dynamic offers, Grant offers, Grant accounts.
Is forking the Capital API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.