Usando nosso ambiente de produção, você pode acessar conectores Live e Sandbox. Para fins de teste, você pode experimentar sua integração usando nosso conector Sandbox (que representa nosso ambiente Sandbox). Isso permitirá que você veja como as transações são atualizadas diariamente e teste todas as possíveis conexões válidas e fluxos de erro.
Aviso
Todos os itens do sandbox que não forem atualizados por mais de 30 dias serão excluídos sem possibilidade de recuperação no futuro.
Você encontrará diferentes fluxos:
- Fluxo básico (também incluímos um fluxo especial da Caixa)
- Fluxo básico para Negócios
- MFA 1 etapa
- MFA 2 etapas
- Contas conjuntas (fluxo Bradesco Conta Conjunta)
- Fluxo de Login QR
- Fluxo de Open Finance
Para um fluxo bem-sucedido, as credenciais são:
- Senha correta:
password-ok - Token MFA correto:
123456
Cada nome de usuário de teste abaixo mapeia para um status de execução específico. Veja Ciclo de vida do Item para a descrição completa dos status de item e execução.
1- Fluxos básicos#
Nota
O fluxo básico também funciona para conectores de Negócios.
| Status de execução | Nome de usuário | Descrição |
|---|---|---|
SUCCESS | user-ok | Conexão bem-sucedida. |
ALREADY_LOGGED_IN | user-logged | O usuário já tem uma sessão de login aberta (precisa sair manualmente). |
ACCOUNT_LOCKED | user-locked | A conta do usuário está bloqueada, precisa de ação manual para ser desbloqueada. |
UNEXPECTED_ERROR | user-error | O conector teve um erro aleatório. |
SITE_NOT_AVAILABLE | user-unavailable | O site do provedor não estava disponível. |
ACCOUNT_NEEDS_ACTION | user-account-need-actions | O provedor está solicitando alguma ação manual do usuário (ou seja, aceitar novos termos de uso). |
ACCOUNT_NEEDS_ACTION + providerMessage | user-account-need-actions-provider-message | O provedor está solicitando alguma ação manual do usuário, incluindo instruções para resolver no campo de erro do item providerMessage. |
CONNECTION_ERROR | user-connection-error | Houve um erro de conexão interno com o provedor (ou seja, problema de Proxy). |
INVALID_CREDENTIALS | qualquer outra coisa | As credenciais de usuário/senha eram inválidas. |
PARTIAL_SUCCESS | user-ok-account-error | Erro ao recuperar o produto da conta. |
SUCCESS com avisos | user-ok-account-warning | Aviso no produto da conta. |
ACCOUNT_CREDENTIALS_RESET | user-account-credentials-reset | O usuário precisa atualizar algumas de suas credenciais na instituição. |
USER_NOT_SUPPORTED | user-not-supported | O usuário não tem permissão para realizar login na instituição através do Pluggy. |
SUCCESS com dados de duas contas correntes | user-ok-two-checking-accounts | Sucesso, mas retorna um exemplo de duas contas correntes. |
Ampliar dados do resultado#
Nos casos em que é necessário testar grandes quantidades de transações no resultado, você pode usar o nome de usuário user-ok-perf ou user-ok-perf-XXx para recriar essa situação. XX representa o multiplicador para o número de transações a serem recuperadas. Por exemplo, se você escolher 1000 como XX, o nome de usuário resultante seria user-ok-perf-1000x, a fim de multiplicar o resultado por esse número.
O limite desse multiplicador é 5000, então se você usar um número maior, o multiplicador será apenas 5000.
Fluxo Básico | Status de Autorização Pendente (fluxo da Caixa)#
Este é um caso especial que emula o fluxo da Caixa. Consiste em três possíveis status de execução a serem retornados.
Quando um usuário se conecta pela primeira vez, a execução esperada retornada será para confirmar o dispositivo do usuário mostrado (ou seja, "1234-5678").
Assim, a primeira execução (após o usuário confirmar o dispositivo do lado dele) retornará USER_AUTHORIZATION_PENDING e uma mensagem que informa o tempo que o usuário deve esperar até que a autorização seja concedida pela Caixa.
Uma vez que esta etapa é concluída, existem dois cenários possíveis:
- Se o usuário atualizar o item dentro do tempo a ser aguardado, o resultado da execução será
USER_AUTHORIZATION_NOT_GRANTEDe uma mensagem para lembrar o tempo a ser aguardado até que a autorização seja concedida pela Caixa (no caso do Sandbox, o tempo é de 2 minutos). - Se o usuário atualizar o item após o tempo de espera, os dados da conta serão recuperados com sucesso e o relatório de execução será
SUCCESS.
Veja a tabela abaixo para mais detalhes:
| Status de execução | Nome de usuário | Descrição |
|---|---|---|
USER_AUTHORIZATION_PENDING | user-ok-auth-pending | Isso reportará um status USER_AUTHORIZATION_PENDING, e uma mensagem para esperar 2 minutos até que a instituição conceda autorização. Então, você pode atualizar o item para recuperar os dados após esses 2 minutos, ou receber uma mensagem de autorização ainda não concedida (por favor, leia as próximas linhas). |
USER_AUTHORIZATION_NOT_GRANTED | re-utilizar credenciais (atualizar) | Se o item for atualizado antes que a instituição conceda autorização, o status reportado será USER_AUTHORIZATION_NOT_GRANTED e você será solicitado a esperar novamente pelos 2 minutos após a primeira execução. |
SUCCESS | re-utilizar credenciais (atualizar) | Se o item for atualizado uma vez que a autorização da instituição for concluída, então os dados devem ser recuperados e o relatório de status será SUCCESS. |
3- MFA 1 etapa#
| Cenário | Nome de usuário | MFA | Descrição |
|---|---|---|---|
| Login Ok | user-ok | 123456 | Conexão bem-sucedida. |
INVALID_CREDENTIALS_MFA | user-ok | ≠ 123456 | O parâmetro MFA fornecido estava incorreto. |
4- MFA 2 etapas#
| Cenário | Nome de usuário | MFA | Descrição |
|---|---|---|---|
| Login Ok | user-ok | 123456 | Conexão bem-sucedida. |
INVALID_CREDENTIALS_MFA | user-ok | ≠ 123456 | O parâmetro MFA fornecido estava incorreto. |
| Login Ok (MFA com imagem QR) | user-ok-img | 123456 | Conexão bem-sucedida. |
INVALID_CREDENTIALS_MFA (MFA com imagem QR) | user-ok-img | ≠ 123456 | O parâmetro MFA fornecido estava incorreto. |
| Login Ok (MFA com opções para selecionar) | user-ok-select | qualquer | Conexão bem-sucedida. |
| Login OK (com seleção de telefone antes do MFA) | user-ok-phone | 123456 | Conexão bem-sucedida. |
INVALID_CREDENTIALS_MFA (com seleção de telefone antes do MFA) | user-ok-phone | ≠ 123456 | O parâmetro MFA fornecido estava incorreto. |
| Login Ok (com seleção de empresa após o MFA) | user-ok-multi-company | 123456 | Conexão bem-sucedida. |
INVALID_CREDENTIALS_MFA | user-ok-multi-company | ≠ 123456 | O parâmetro MFA fornecido estava incorreto. |
UNEXPECTED_ERROR | user-ok-mfa-error | 123456 | O conector teve um erro aleatório. |
ACCOUNT_LOCKED | user-ok-mfa-locked | 123456 | A conta do usuário está bloqueada, precisa de ação manual para ser desbloqueada. |
SITE_NOT_AVAILABLE | user-ok-mfa-unavailable | 123456 | O site do provedor não estava disponível. |
CONNECTION_ERROR | user-ok-mfa-connection-error | 123456 | Houve um erro de conexão interno com o provedor (ou seja, problema de Proxy). |
ALREADY_LOGGED_IN | user-ok-mfa-logged | 123456 | O usuário já tem uma sessão de login aberta (precisa sair manualmente). |
ACCOUNT_NEEDS_ACTION | user-ok-mfa-account-need-actions | 123456 | O provedor está solicitando alguma ação manual do usuário (ou seja, aceitar novos termos de uso). |
5- Contas Conjuntas (fluxo Bradesco Conta Conjunta)#
Este é um caso especial que emula o fluxo da Bradesco Conta Conjunta.
Abaixo você encontrará dois exemplos:
- Testando no widget Pluggy Connect
- Testando via Postman
1- Testando no widget Pluggy Connect#
Ao usar o widget Pluggy Connect, o usuário será apresentado para escolher primeiro entre uma "Conta única" ou uma "Conta conjunta".
- Se o usuário selecionar "Conta única", será solicitado a fornecer credenciais bancárias e MFA no mesmo passo das credenciais.
- Se o usuário selecionar "Conta conjunta", será solicitado apenas as credenciais bancárias. Em seguida, será perguntado qual conta deseja conectar, e depois disso, o MFA será necessário. Se o MFA estiver correto, a conta será conectada com sucesso.
2- Testando via Postman#
- Ao testar "conta única", a solicitação é a mesma que a do sandbox MFA 1 etapa. As credenciais bancárias e o MFA são enviados juntos.
- Ao testar "conta conjunta", você deve incluir um parâmetro MFA 1 etapa, com o valor simulado:
000000.
Observe que isso é o mesmo que o fluxo do widget Connect. Quando o usuário seleciona o fluxo "conta conjunta", a interface não está pedindo para completar o parâmetro MFA.
6- Fluxo de Login QR#
Este é um caso que originalmente simula um fluxo semelhante ao QR do Inter. Nenhuma credencial é necessária. Uma vez iniciado, o item entrará em um status WAITING_USER_ACTION e retornará um código QR para o usuário escanear.
Este fluxo simulará um código QR em rápida mudança por 10 segundos e, em seguida, simulará o usuário lendo o QR e avançando o estado para um fluxo de login normal.
7- Fluxo de Open Finance#
Para se conectar usando nossa conexão sandbox (veja Criando um item de Open Finance), você precisará enviar um CPF:
| Cenário | CPF |
|---|---|
| Fluxo básico | 761.092.776-73 |
| Fluxo de autorização múltipla - aprovado | 238.242.640-30 |
| Fluxo de autorização múltipla - rejeitado | 051.177.670-55 |
| Fluxo básico - com autenticação lenta | 002.502.737-99 |
| Fluxo básico - forçar erro ao obter recursos OF | 163.511.711-99 |
Isso redirecionará você para a página de login do banco simulado. Por favor, use as seguintes credenciais:
- Usuário:
ralph.bragg@gmail.com - Senha:
P@ssword01
Como funciona o fluxo de autorização múltipla (múltipla alçada)?#
Este fluxo simula um cenário onde, para recuperar os dados da conta, o item deve ser aprovado por outra pessoa (tipicamente outro associado da empresa). Para testar esse cenário, siga estas etapas:
- Crie um item sandbox usando um dos CPFs listados na tabela acima. O item não retornará contas imediatamente. Em vez disso, o campo
statusDetailindicará que as contas requerem autorização. - Atualize esse item. Dependendo do CPF que você forneceu, as contas podem ou não ser retornadas.