Busca de uma organização

Um dos dados obrigatórios para realizar a criação de um consentimento de uma iniciação de pagamento são os dados da organização participante do Open Finance (Instituição detentora de conta) onde a iniciação de pagamento irá ser requisitada.

Para a solução da Bit Capital identificar quem é a instituição detentora de conta onde será realizada a criação do consentimento de uma iniciação de pagamento precisamos de dois dados:

• Identificação da organização (organizationId)
• Identificação do servidor de autorização (authorisationServerId)

📘

Organização e Servidor de autorização

Organização é a participante do Open Finance.
P.ex.: Picpay; Itaú; BTG

Servidor de autorização é a marca ou canal do participante do Open Finance.
P.ex.: Itau Unibanco; Itau Cartões; Itaú Pessoa Jurídica

Para conseguir essas informações é necessário que seja realizada uma consulta no nosso endpoint. A consulta pode ser realizada sem informar a identificação da organização, informando a identificação da organização e utilizando filtros.

Consulta a organização sem informar a identificação.

ENDPOINT: open-finance/tpp/organisations/v1
Este endpoint utiliza o método GET.

Ao realizar uma consulta será listado uma lista das organizações conforme demonstra o exemplo abaixo:

Consulta a organização informando a identificação

ENDPOINT: open-finance/tpp/organisations/v1/{organisationId}
Este endpoint utiliza o método GET.

Ao realizar uma consulta será apresentado os dados da organização identificada conforme demonstra o exemplo abaixo:

Filtros

👍

Utilização de filtros

Recomendamos a utilização dos filtros sinalizando as instituições habilitadas e família de APIs para diminuir a quantidade de possíveis experiências de usuário com falha junto as instituições.

Instituição habilitada

ENDPOINT: open-finance/tpp/organisations/v1?enabled=
Este endpoint utiliza o método GET.

Este filtro é utilizado para buscar apenas instituições sinalizadas como habilitada.

A Bit Capital acompanha cada incidente aberto e caso algum servidor de autorização esteja com dificuldades em algum momento, ela é sinalizada através do campo habilitado com o valor de falso (enabled:false). Caso tenha sido realizado um fluxo completo junto ao servidor de autorização ou não há incidentes aberto, o servidor de autorização é sinalizado com o campo habilitado com o valor de verdadeiro (enabled:true).

Para utilizar o filtro basta utilizar o valor 1 para verdadeiro ou valor 0 para falso.
enabled=1 (True)
enabled=0 (False)

Família de APIs

ENDPOINT: open-finance/tpp/organisations/v1?apiFamilyType=
Este endpoint utiliza o método GET.

A listagem de organizações contém os participantes de todas as fases do Open Finance mas apenas é possível realizar uma iniciação de pagamento junto dos participantes da fase de pagamentos.

Para a listagem exibir apenas os participantes da fase 3 basta utilizar o filtro família de APIs utilizando as seguintes famílias separadas por virgula: payment-consents,payments-pix.

Listagem simplificada

ENDPOINT: open-finance/tpp/organisations/v1?output=simplified
Este endpoint utiliza o método GET.

Filtro utilizado para exibir uma listagem mais simplificada trazendo apenas os dados de identificação da organização, identificação do servidor de autorização, nome da marca e logo da marca.

Descrição dos campos