Fund API

https://cal-test.adyen.com/cal/services/Fund/v5
Click to copy

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/v5/accountHolderBalance
post/accountHolderBalance
Get the balances of an account holder
post/accountHolderTransactionList
Get a list of transactions
post/debitAccountHolder
Send a direct debit request
post/payoutAccountHolder
Pay out from an account to the account holder
post/refundFundsTransfer
Refund a funds transfer
post/refundNotPaidOutTransfers
Refund all transactions of an account since the most recent payout
post/setupBeneficiary
Designate a beneficiary account and transfer the benefactor's current balance
post/transferFunds
Transfer funds between platform accounts