integrations.sh
← all integrations

adyen.com – BalanceControlService

OpenAPI apis-guru payment

The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account.

Authentication

To connect to the Balance Control API, you must authenticate your requests with an . To learn how you can generate these, see .Here is an example of authenticating a request with an API key:

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

Note that when going live, you need to generate API credentials to access the .

Versioning

The Balance Control 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:

https://pal-test.adyen.com/pal/servlet/BalanceControl/v1/balanceTransfer
Homepage
https://api.apis.guru/v2/specs/adyen.com:BalanceControlService/1.json
Provider
adyen.com:BalanceControlService / BalanceControlService
OpenAPI version
3.1.0
Spec (JSON)
https://api.apis.guru/v2/specs/adyen.com/BalanceControlService/1/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/adyen.com/BalanceControlService/1/openapi.yaml

Tools (3)

Extracted live via the executor SDK.

  • general.postBalanceTransfer

    Starts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances:

    • The source and destination merchant accounts must be under the same company account and legal entity.

    • The source merchant account must have sufficient funds.

    • The source and destination merchant accounts must have at least one common processing currency.

    When sending multiple API requests with the same source and destination merchant accounts, send the requests sequentially and not in parallel. Some requests may not be processed if the requests are sent in parallel.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools