Pular para o conteúdo principal
GET
/
v1
/
banks
/
participants
Listar bancos participantes
curl --request GET \
  --url https://plugin-br-pix-direct-jd.sandbox.lerian.net/v1/banks/participants \
  --header 'Authorization: Bearer <token>'
[
  {
    "bankId": "12345678",
    "name": "Banco Example S.A.",
    "pspType": 1,
    "pspStatus": 1
  }
]

Autorizações

Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Resposta

Lista de bancos participantes recuperada com sucesso

bankId
string
obrigatório

Codigo ISPB do banco (8 digitos).

Exemplo:

"12345678"

name
string
obrigatório

Nome do banco

Exemplo:

"Banco Example S.A."

pspType
integer
obrigatório

Tipo de Prestador de Servicos de Pagamento. Valores: 1 = Participante direto, 2 = Participante indireto

Exemplo:

1

pspStatus
integer
obrigatório

Status de participacao no sistema PIX. Valores: 1 = Ativo e operacional

Exemplo:

1