Adyen

Balance Control API

The Balance Control API allows you to view and manage the balances in your company and merchant accounts. Authentication We recommend that you use an API key…

Payments#openapi

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 Balance Control API allows you to view and manage the balances in your company and merchant accounts.

Authentication

We recommend that you use an API key to connect to the Balance Control API. You can generate an API key in your Customer Area.

Header format

To connect to the Balance Control 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: ADYEN_API_KEY' \
...

Versioning

The Balance Control API handles versioning as part of the endpoint URL. For example, to send a request to version 2 of the /balanceOverview/companies/{companyId}/balances endpoint, use:

https://balance-control-test.adyen.com/balance-control/api/v2/balanceOverview/companies/{companyId}/balances

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://balance-control-live.adyen.com/api/v2.

Endpoints 3

Balances overview

  • GETView the available balances for all merchant accounts under your company./balanceOverview/companies/:companyAccountCode/balances?currency=stringReturns an array with details about the balances available for all merchant accounts under your company account. For each merchant account, the response…
  • GETView all balances available for your merchant account./balanceOverview/merchants/:merchantAccountCode/balances?currency=stringReturns an overview of the different balances available for the merchant account. This includes details about the following: * Available funds: The funds in…

Balance transfers

  • POSTPerforms a balance transfer/balanceTransfersPerforms a balance transfer between merchant accounts. The following conditions must be met before you can successfully transfer balances: * The source and…

API details

Base URL
https://balance-control-test.adyen.com/balance-control/api/v2
https://balance-control-live.adyen.com/balance-control/api/v2
Authentication
An API key in the X-API-Key header
HTTP Basic authentication (username and password)
Operations
3 operations on 3 pathsGET 2POST 1
Main resources
Balances overview 2Balance transfers 1
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 2

How to test the Balance Control API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Balance Control API collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “View the available balances for all merchant accounts under your company.” (GET /balanceOverview/companies/:companyAccountCode/balances?currency=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Balance Control API?

The Balance Control API allows you to view and manage the balances in your company and merchant accounts. Authentication We recommend that you use an API key… It is listed under Payments and has 3 endpoints.

Who publishes the Balance Control 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 Balance Control API?

Its description lists 2 base URLs: https://balance-control-test.adyen.com/balance-control/api/v2, https://balance-control-live.adyen.com/balance-control/api/v2. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Balance Control 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 Balance Control API have?

3 operations on 3 paths (2 GET, 1 POST). The largest groups are Balances overview, Balance transfers.

Is forking the Balance Control API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.