powered by Nortcash
Testar grátis
documentação

Guia do conector

Um link num botão da sua plataforma. Cada usuário que passar por ele conecta o banco e o CNPJ ou CPF entra na sua conta.

Como funciona

  1. Na sua conta, em Conector, copie o link do conector.
  2. Coloque o link num botão “Conectar banco” da sua plataforma.
  3. Seu usuário informa o CNPJ ou CPF e autoriza no site ou app do banco. Ele não precisa criar conta aqui.
  4. Ele volta para a sua plataforma e o CNPJ ou CPF entra na sua conta. Você lê os dados com a chave de API.

O botão

Acrescente ao link dois parâmetros opcionais: reference, o identificador do cliente na sua plataforma, e return_url, para onde o usuário volta depois do banco.

<a href="https://openfinancemcp.ai/c/8f2kQx71?reference=cli_1042&return_url=https%3A%2F%2Fapp.suaplataforma.com.br%2Fbancos%2Fretorno">
  Conectar banco
</a>

O return_url precisa ser HTTPS e o domínio precisa estar em Domínios de retorno, na tela Conector. Sem ele, a página termina com “Banco autorizado” e o usuário fecha a aba.

Abra o link na mesma aba ou numa aba nova. A página de autorização não abre dentro de um iframe.

O que o seu usuário vê

  • “Qual CNPJ ou CPF você quer conectar?”, com o nome da sua plataforma (o campo Nome da plataforma, na tela Conector).
  • A lista de bancos, com busca.
  • Para um CNPJ, o CPF de quem acessa o banco: o banco usa o CPF para saber quem está autorizando.
  • A autorização no site ou app do banco. A senha não passa por aqui.
  • O Inter é a exceção: conecta por uma credencial de integração que a empresa gera no Internet Banking.

O retorno

Quando a autorização termina, o navegador volta para o return_url com estes parâmetros:

ParâmetroO que traz
documentO CNPJ ou CPF, mascarado.
referenceA referência que você mandou no link.
connectionO identificador da conexão com o banco.
resultauthorized, pending_approval (falta a aprovação dos outros aprovadores no banco), document_mismatch (a conta autorizada é de outro CNPJ ou CPF, nada foi lido) ou error.
https://app.suaplataforma.com.br/bancos/retorno?document=11.222.333%2F0001-81&reference=cli_1042&connection=6f1c…&result=authorized

Use a reference para achar o cliente na sua base. O documento completo está na lista de titulares da API.

Trocar o link

Em Conector, “Trocar link” cria um link novo e o antigo para de funcionar na hora. Atualize o botão da sua plataforma.