Skip to main content
GET
List banks

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Request-Id
string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Query Parameters

q
string

Free-text search.

Maximum string length: 200

Response

The banks.

Cursor page. Domain files compose this with allOf and set data.items.

object
string
required
Allowed value: "list"
data
object[]
required

Banks, most used first.

has_more
boolean
required

True when another page exists.

next_cursor
string | null

Cursor for the next page in the same direction: pass it as after if this page was read with after (or no cursor), as before if it was read with before. Null when has_more is false.

total_count
integer

Only when include=total_count was sent.