adyen.com – FundService
This API is used for the classic integration. If you are just starting your implementation, refer to our 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 .
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:
Alternatively, you can use the username and password to connect to the API using basic authentication. For example:
When going live, you need to generate new web service user credentials to access the .
Versioning
The Fund API supports using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
For example:
curl-H "Content-Type: application/json" \-H "X-API-Key: YOUR_API_KEY" \...curl-U "ws@MarketPlace.YOUR_PLATFORM_ACCOUNT":"YOUR_WS_PASSWORD" \-H "Content-Type: application/json" \...https://cal-test.adyen.com/cal/services/Fund/v3/accountHolderBalance- Homepage
- https://api.apis.guru/v2/specs/adyen.com:FundService/3.json
- Provider
- adyen.com:FundService / FundService
- OpenAPI version
- 3.1.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/adyen.com/FundService/3/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/adyen.com/FundService/3/openapi.yaml
Tools (10)
Extracted live via the executor SDK.
-
general.postAccountHolderBalanceReturns the account balances of an account holder. An account's balances are organized according by currencies. This mean that an account may have multiple balances: one for each currency.
-
general.postAccountHolderTransactionListReturns 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 returns a maximum of 50 transactions for each account. To retrieve all transactions, you must make another call with the 'page' value incremented. Transactions are listed in chronological order, with the most recent transaction first.
-
general.postDebitAccountHolderSends 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 split instructions. Adyen sends the result of the direct debit in a notification webhook.
To learn more about direct debits, see .
-
general.postPayoutAccountHolderPays out a specified amount from an account to the bank account of account holder.
-
general.postRefundFundsTransferRefunds funds transferred from one account to another. Both accounts must be in the same platform, but can have different account holders.
-
general.postRefundNotPaidOutTransfersRefunds 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 basis), so only the portion of the payment that was made to the specified account is refunded. The commissions, fees, and payments to other accounts remain in the accounts to which they were sent as designated by the original payment's split details.
-
general.postSetupBeneficiaryDefines a benefactor and a beneficiary relationship between two accounts. At the time of benefactor/beneficiary setup, the funds in the benefactor account are transferred to the beneficiary account, and any further payments to the benefactor account are automatically sent to the beneficiary account. A series of benefactor/beneficiaries may not exceed four beneficiaries and may not have a cycle in it.
-
general.postTransferFundsTransfers funds from one account to another account. Both accounts must be in the same platform, but can have different account holders. The transfer must include a transfer code, which should be determined by the platform, in compliance with local regulations.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools