Participantes

Informações dos participantes disponíveis na API Open Finance

Recuperar as instituições participantes do Open Finance

Esse endpoint é utilizado para retornar informações sobre um ou mais participantes que estão ativos no Open Finance.

Dica

Para listar todos os participantes ativos, não é necessário enviar o atributo 'nome' na requisição.

GET /v1/participantes

Requer autorização para o escopo: gn.opb.participants.read

Requisição

O trecho abaixo mostra como os parâmetros organizacao, nome e modalidade devem ser repassados na requisição.
/open-finance/participantes?organizacao=false&nome=exemplo&modalidade=agendado

Respostas

As respostas abaixo representam Sucesso(200) e Falhas/erros do consumo.

🟢 200

Lista com um ou mais participantes do Open Finance
{
  "participantes": [
    {
      "identificador": "ebbed125-5cd7-42e3-965d-2e7af8e3b7ae",
      "nome": "Efí S.A.",
      "descricao": "Descrição da marca",
      "portal": "https://openbankingbrasil.org.br/quem-participa/",
      "logo": "https://www.gerencianet.com.br/logo.png",
      "organizacoes": [
        {
          "nome": "Efí S.A.",
          "cnpj": "09089356000118,",
          "status": "Ativo"
        }
      ]
    }
  ]
}

🔴 404

Nome inválido
{
  "nome": "participante_nao_encontrado",
  "mensagem": "Nenhum participante encontrado"
}

🔴 500

Erro na aplicação
{
  "nome": "erro_aplicacao",
  "mensagem": "Erro interno do servidor"
}