Configuration API

adyen · Company

Company No Auth Free & Open payment

The Configuration API enables you to create a platform where you can onboard your users as account holders and create balance accounts, cards, and business accounts. ## 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 t

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get all available grant offers

Returns a list of all [grant offers](https://docs.adyen.com/marketplaces-and-platforms/capital#grant-offers) available for `accountHolderId` specified as a query parameter.

https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/grantOffers?accountHolderId=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/grantOffers?accountHolderId=example"

import requests
params = {
    "accountHolderId": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/grantOffers",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/grantOffers');
url.searchParams.set('accountHolderId', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/grantOffers")
	q := baseURL.Query()
	q.Set("accountHolderId", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/grantOffers")
uri.query = URI.encode_www_form({
  "accountHolderId" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/grantOffers?" . http_build_query([
    "accountHolderId" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get all balance accounts of an account holder

Returns a paginated list of the balance accounts associated with an account holder. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 balance accounts and skip the first 10, use `/accountHolders/{id}/balanceAccounts?limit=5&offset=10`.

https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/accountHolders/{id}/balanceAccounts?limit=10&offset=0

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/accountHolders/{id}/balanceAccounts?limit=10&offset=0"

import requests
params = {
    "limit": "10",
    "offset": "0"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/accountHolders/{id}/balanceAccounts",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/accountHolders/{id}/balanceAccounts');
url.searchParams.set('limit', '10');
url.searchParams.set('offset', '0');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/accountHolders/{id}/balanceAccounts")
	q := baseURL.Query()
	q.Set("limit", "10")
	q.Set("offset", "0")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/accountHolders/{id}/balanceAccounts")
uri.query = URI.encode_www_form({
  "limit" => "10",
  "offset" => "0"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/accountHolders/{id}/balanceAccounts?" . http_build_query([
    "limit" => "10",
    "offset" => "0"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get all sweeps for a balance account

Returns a list of the sweeps configured for a balance account. To fetch multiple pages, use the query parameters. For example, to limit the page to 5 sweeps and to skip the first 10, use `/balanceAccounts/{balanceAccountId}/sweeps?limit=5&offset=10`.

https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/balanceAccounts/{balanceAccountId}/sweeps?limit=10&offset=0

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/balanceAccounts/{balanceAccountId}/sweeps?limit=10&offset=0"

import requests
params = {
    "limit": "10",
    "offset": "0"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/balanceAccounts/{balanceAccountId}/sweeps",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/balanceAccounts/{balanceAccountId}/sweeps');
url.searchParams.set('limit', '10');
url.searchParams.set('offset', '0');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/balanceAccounts/{balanceAccountId}/sweeps")
	q := baseURL.Query()
	q.Set("limit", "10")
	q.Set("offset", "0")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/balanceAccounts/{balanceAccountId}/sweeps")
uri.query = URI.encode_www_form({
  "limit" => "10",
  "offset" => "0"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/adyen.com/BalancePlatformService/2/balanceAccounts/{balanceAccountId}/sweeps?" . http_build_query([
    "limit" => "10",
    "offset" => "0"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Configuration API?

Configuration API is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Configuration API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗