curl --request POST \
--url https://api.sand.getivy.de/api/service/banks/search \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"search": "<string>",
"group": "<string>",
"capability": "pis",
"market": "AF",
"currency": "EUR",
"limit": 500.5,
"skip": 1,
"sessionId": "<any>"
}'
{
"banks": [
{
"id": "<string>",
"name": "<string>",
"logo": "<string>",
"market": [
"AF"
],
"currencies": [
"EUR"
],
"group": "<string>",
"url": "<string>",
"default": true,
"test": true,
"capabilities": [
"ais"
],
"supportedPaymentSchemes": [
"SEPA_INSTANT"
]
}
],
"count": 123,
"skip": 123,
"hasNext": true
}
You can retrieve a list of banks by a given search string. If the search string is empty (""), a default list of banks is returned. On top, you can filter results by group, capability and market.
curl --request POST \
--url https://api.sand.getivy.de/api/service/banks/search \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '{
"search": "<string>",
"group": "<string>",
"capability": "pis",
"market": "AF",
"currency": "EUR",
"limit": 500.5,
"skip": 1,
"sessionId": "<any>"
}'
{
"banks": [
{
"id": "<string>",
"name": "<string>",
"logo": "<string>",
"market": [
"AF"
],
"currencies": [
"EUR"
],
"group": "<string>",
"url": "<string>",
"default": true,
"test": true,
"capabilities": [
"ais"
],
"supportedPaymentSchemes": [
"SEPA_INSTANT"
]
}
],
"count": 123,
"skip": 123,
"hasNext": true
}
API key for authentication
Returns a list of matching Banks
The response is of type object
.