website logo
English version
⌘K
🚀Quickstart
🌎Documentação de API
📑Produtos
🔗Atualização de conexão
🖍️Categorização API
🏦Instituições disponíveis
⚠️Código de retorno
🖇️Integração de SDK e API
💓Controle de versão
Docs powered by archbee 
13min

Atualização de conexão

Nossos parceiros podem checar e atualizar as conexões continuamente. Baseado em diferentes cenários, o parceiro pode checar qual método utilizar para atualizar as conexões.

Tais métodos são válidos apenas após a primeira conexão, quando o identificador do usuário “connection_key” for gerada.

Método

Cenário

Descrição

API de atualização automática (sem interação com o usuário)

Aplicável para bancos que não utilizam autenticação de vários fatores (MFA) para login

POST para a API e solicitar atualização de conta, dado que atualização de conta está liberada

Link de atualização de conexão (requer interação com o usuário)

Aplicável para bancos que utilizam autenticação de vários fatores (MFA) para login ou em casos de alteração de senha pelo usuário

Usuário faz a atualização da conexão através do URL de Link (“connection_key” é necessário para identificar o usuário)

Como sincronizar



Dica: A API autoupdate_sync se baseia nas credenciais utilizadas anteriormente pelo usuário para fazer a conexão. Porém, há a possibilidade de o usuário ter trocado as credenciais quando tentamos fazer o update de dados. Portanto, ao receber qualquer erro relacionado às credenciais, como 402, 406 e 408, pedimos que pare de chamar esta API e peça ao usuário conectar a conta novamente com as novas credenciais. Se continuar chamando a API com credenciais erradas, as falhas de conexão recorrentes podem ser interpretados como comportamento suspeito pelo banco e ter a conta bloqueada.

Você deve solicitar um POST para a seguinte API para atualizar as conexões bancárias. Os dados bancários atualizados serão enviados em formato JSON para o Webhook original.
POST
Params
Header Parameters
partner_code
required
String
Identificador único do parceiro, como um nome de usuário.
partner_token
required
String
Token único do parceiro para atualização, como uma senha
Body Parameters
connection_key
required
String
Chave específica por conexão. Ela será gerada após a primeira conexão e pode ser encontrado no arquivo JSON da conexão.


Como configurar


Para alterar a configuração da API você precisa solicitar um POST para a seguinte API:
POST
Params
Header Parameters
partner_code
required
String
Identificador único do parceiro, como um nome de usuário.
partner_token
required
String
Token único do parceiro para atualização, como uma senha.
Body Parameters
connection_key
required
String
Chave específica por conexão. Ela será gerada após a primeira conexão e pode ser encontrado no arquivo JSON da conexão.
allow_autoupdate
required
String
Última configuração de atualização automática ("Yes" or "No")


Ligação para atualização Da conexão



Este método é usado para bancos que requerem autenticação de vários fatores (MFA) para login e é válido após a primeira conexão. A seleção de banco e preenchimento de credenciais de login serão pulados para melhorar a experiência do usuário.

Parâmetro

Propósito

Descrição

connection_key (obrigatório)

Identificador específica para cada conexão

Chave específica por conexão. Ela será gerada após a primeira conexão e pode ser encontrado no arquivo JSON da conexão.

callback_url (obrigatório)

URL para redirecionamento do usuário quando ele sair do Link

A URL de callback precisa seguir as regras de “encodeURIcompenent()” como abaixo: - “%3a” no lugar de “:” - “%2f” no lugar de “/” - “%3f” no lugar de “?” - “%3d” no lugar de “=”

cancel_url (obrigatório)

The redirecting URL when users cancel the bank connection. It can be a webpage or native app page.

A URL de cancelar precisa seguir as regras de “encodeURIcompenent()” como abaixo: - “%3a” no lugar de “:” - “%2f” no lugar de “/” - “%3f” no lugar de “?” - “%3d” no lugar de “=”

  • Exemplo de URL do Link com parâmetros opcionais e redirecionamento para uma webpage. O URL de callback após decodificação: https://partnerDomain.com?partnerParameter=valu
Text
|

  • Exemplo de URL do Link com parâmetros opcionais e redirecionamento para um app. O URL de callback após decodificação: partnerAppSchemeDemo://partnerAppPage?partnerParameter=value
Text
|

  • URLs do Link em outros ambientes: https://openbanking-sandbox.klavi.ai/partner_code/update (Sandbox) https://openbanking-dev.klavi.ai/partner_code/update (Homologação) https://openbanking.klavi.ai/partner_code/update (Produção)

Deleção de conta


Para deletar a conta do usuário você precisa chamar a seguinte API em método POST. Note que essa deleção de conta é permanente e não pode ser recuperada.
POST
Params
Header Parameters
partner_code
required
String
Identificador único do parceiro, como um nome de usuário.
partner_token
required
String
Token único do parceiro para atualização, como uma senha.
Body Parameters
connection_key
required
String
Chave específica por conexão. Ela será gerada após a primeira conexão e pode ser encontrado no arquivo JSON da conexão.




UP NEXT
Categorização API
Docs powered by archbee 
/autoupdate_sync