Listar Bancos

Lista todos os bancos disponíveis para desembolso, com filtro opcional por nome. Útil para exibir a lista de bancos ao trabalhador durante o preenchimento de dados bancários.

Parâmetros

Parâmetro
Local
Tipo
Obrigatório
Descrição

search

query

string

Não

Termo de busca para filtrar bancos por nome

circle-info

Este endpoint é público e não exige autenticação.

Listar Bancos

get
/api/v1/banks

Lista bancos disponíveis para desembolso, com filtro opcional por nome

Parâmetros de consulta
searchstringOpcional

Termo de busca para filtrar bancos por nome

Respostas
chevron-right
200

Bancos retornados com sucesso

application/json
codestringOpcional

Código do banco

ispbstringOpcional

Código ISPB do banco

namestringOpcional

Nome completo do banco

shortNamestringOpcional

Nome curto do banco

supportsPixbooleanOpcional

Indica se o banco suporta PIX

activebooleanOpcional

Indica se o banco está ativo

get
/api/v1/banks
200

Bancos retornados com sucesso

Atualizado