List Banks
curl --request POST \
--url https://api.getivy.de/api/service/banks/list \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"group": "<string>",
"capability": "pis",
"market": "DE",
"limit": 500.5,
"skip": 1,
"sessionId": "<unknown>"
}
'import requests
url = "https://api.getivy.de/api/service/banks/list"
payload = {
"group": "<string>",
"capability": "pis",
"market": "DE",
"limit": 500.5,
"skip": 1,
"sessionId": "<unknown>"
}
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Ivy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
group: '<string>',
capability: 'pis',
market: 'DE',
limit: 500.5,
skip: 1,
sessionId: '<unknown>'
})
};
fetch('https://api.getivy.de/api/service/banks/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getivy.de/api/service/banks/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'group' => '<string>',
'capability' => 'pis',
'market' => 'DE',
'limit' => 500.5,
'skip' => 1,
'sessionId' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getivy.de/api/service/banks/list"
payload := strings.NewReader("{\n \"group\": \"<string>\",\n \"capability\": \"pis\",\n \"market\": \"DE\",\n \"limit\": 500.5,\n \"skip\": 1,\n \"sessionId\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getivy.de/api/service/banks/list")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"group\": \"<string>\",\n \"capability\": \"pis\",\n \"market\": \"DE\",\n \"limit\": 500.5,\n \"skip\": 1,\n \"sessionId\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/banks/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"group\": \"<string>\",\n \"capability\": \"pis\",\n \"market\": \"DE\",\n \"limit\": 500.5,\n \"skip\": 1,\n \"sessionId\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"banks": [
{
"id": "<string>",
"name": "<string>",
"market": [
"AF"
],
"currencies": [
"EUR"
],
"default": true,
"test": true,
"supportedPaymentSchemes": [
"SEPA_INSTANT"
],
"logo": "<string>",
"group": "<string>",
"url": "<string>",
"capabilities": [
"pis"
]
}
],
"count": 123,
"skip": 123,
"hasNext": true
}Bank
List Banks
Get a list of banks. You can filter by group, capability and market.
POST
/
api
/
service
/
banks
/
list
List Banks
curl --request POST \
--url https://api.getivy.de/api/service/banks/list \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"group": "<string>",
"capability": "pis",
"market": "DE",
"limit": 500.5,
"skip": 1,
"sessionId": "<unknown>"
}
'import requests
url = "https://api.getivy.de/api/service/banks/list"
payload = {
"group": "<string>",
"capability": "pis",
"market": "DE",
"limit": 500.5,
"skip": 1,
"sessionId": "<unknown>"
}
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Ivy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
group: '<string>',
capability: 'pis',
market: 'DE',
limit: 500.5,
skip: 1,
sessionId: '<unknown>'
})
};
fetch('https://api.getivy.de/api/service/banks/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getivy.de/api/service/banks/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'group' => '<string>',
'capability' => 'pis',
'market' => 'DE',
'limit' => 500.5,
'skip' => 1,
'sessionId' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getivy.de/api/service/banks/list"
payload := strings.NewReader("{\n \"group\": \"<string>\",\n \"capability\": \"pis\",\n \"market\": \"DE\",\n \"limit\": 500.5,\n \"skip\": 1,\n \"sessionId\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getivy.de/api/service/banks/list")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"group\": \"<string>\",\n \"capability\": \"pis\",\n \"market\": \"DE\",\n \"limit\": 500.5,\n \"skip\": 1,\n \"sessionId\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/banks/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"group\": \"<string>\",\n \"capability\": \"pis\",\n \"market\": \"DE\",\n \"limit\": 500.5,\n \"skip\": 1,\n \"sessionId\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"banks": [
{
"id": "<string>",
"name": "<string>",
"market": [
"AF"
],
"currencies": [
"EUR"
],
"default": true,
"test": true,
"supportedPaymentSchemes": [
"SEPA_INSTANT"
],
"logo": "<string>",
"group": "<string>",
"url": "<string>",
"capabilities": [
"pis"
]
}
],
"count": 123,
"skip": 123,
"hasNext": true
}Authorizations
API key for authentication
Body
application/json
If provided the list will show banks in this group only. Groups are e.g. "Sparkasse", i.e. a group of different bank branches of the same brand.
Filter banks with the provided payment capability.
Available options:
pis ISO 3166-1 alpha-2 country code. Filter banks with provided market only.
Available options:
AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IL, IT, JM, JP, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, MK, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, PM, VC, WS, SM, ST, SA, SN, SC, SL, SG, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW, AX, BQ, CW, GG, IM, JE, ME, BL, MF, RS, SX, SS, XK ISO 4217 currency code. Filter banks with provided currency only.
Available options:
EUR, USD, GBP, PLN, SEK, DKK The maximum number of banks to return (default 1000)
Required range:
1 < x < 1000The number of banks to skip
Required range:
x > 0The internal checkout session id. For internal use only.
Was this page helpful?