Fund API
This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration…
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
This API is used for the classic integration. If you are just starting your implementation, refer to our new integration guide instead.
The Fund API provides endpoints for managing the funds in the accounts on your platform. These management operations include, for example, the transfer of funds from one account to another, the payout of funds to an account holder, and the retrieval of balances in an account.
For more information, refer to our documentation.
Authentication
Your Adyen contact will provide your API credential and an API key. 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" \
...Alternatively, you can use the username and password to connect to the API using basic authentication. For example:
curl
-U "ws@MarketPlace.YOUR_PLATFORM_ACCOUNT":"YOUR_WS_PASSWORD" \
-H "Content-Type: application/json" \
...When going live, you need to generate new web service user credentials to access the live endpoints.
Versioning
The Fund API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
For example:
https://cal-test.adyen.com/cal/services/Fund/v6/accountHolderBalanceEndpoints 8
General
- POSTGet the balances of an account holder
/accountHolderBalanceReturns the account balances of an account holder. An account's balances are organized according by currencies. This mean that an account may have multiple… - POSTGet a list of transactions
/accountHolderTransactionListReturns a list of transactions for an account holder's accounts. You can specify the accounts and transaction statuses to be included on the list. The call… - POSTSend a direct debit request
/debitAccountHolderSends a direct debit request to an account holder's bank account. If the direct debit is successful, the funds are settled in the accounts specified in the… - POSTPay out from an account to the account holder
/payoutAccountHolderPays out a specified amount from an account to the bank account of account holder. - POSTRefund a funds transfer
/refundFundsTransferRefunds funds transferred from one account to another. Both accounts must be in the same platform, but can have different account holders. - POSTRefund all transactions of an account since the most recent payout
/refundNotPaidOutTransfersRefunds all the transactions of an account that have taken place since the most recent payout. This request is on a account basis (as opposed to a payment… - POSTDesignate a beneficiary account and transfer the benefactor's current balance
/setupBeneficiaryDefines a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are… - POSTTransfer funds between platform accounts
/transferFundsTransfers funds from one account to another account. Both accounts must be in the same platform, but can have different account holders. The transfer must…
API details
- Base URL
https://cal-test.adyen.com/cal/services/Fund/v6- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 8 operations on 8 pathsPOST 8
- Main resources
- General 8
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
6 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the Fund 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 Fund 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 the balances of an account holder” (POST /accountHolderBalance), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Fund API?
This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration… It is listed under Payments and has 8 endpoints.
Who publishes the Fund 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 Fund API?
Requests go to https://cal-test.adyen.com/cal/services/Fund/v6. Endpoint paths are added to this base URL.
How do I authenticate with the Fund 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 Fund API have?
8 operations on 8 paths (8 POST). The largest groups are General.
Is forking the Fund API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.