POST
/
api
/
service
/
banks
/
search
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: 'My API Key',
});

const response = await client.banks.search();

console.log(response.banks);
{
  "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
}

Authorizations

​
X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
​
search
string

The search query. Banks with names matching the query are returned. If the string is empty or undefined, a list of default banks is returned.

​
group
string

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.

​
capability
enum<string>
default:pis

Filter banks with provided capability only. ais for data products, pis for payment products.

Available options:
ais,
pis
​
market
enum<string>

ISO 3166-1 alpha-2 country code. Filter banks with provided market only. If not provided, all banks are returned.

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
​
currency
enum<string>

ISO 4217 currency code. Filter banks with provided currency only.

Available options:
EUR,
GBP,
PLN,
SEK,
DKK
​
limit
number

The maximum number of banks to return (default 1000)

Required range: 1 < x < 1000
​
skip
number

The number of banks to skip

Required range: x > 0
​
sessionId
any

The internal checkout session id. For internal use only.

Response

200 - application/json

Returns a list of matching Banks

​
banks
object[]
required

A list of banks.

​
count
number
required

The total number of banks

​
skip
number
required

The number of banks skipped

​
hasNext
boolean
required

Whether there are more banks to retrieve