O Manual do Dev

Boas-vindas ao Manual do Dev!

Este Manual descreve passo a passo como integrar nossos produtos ao sistema do parceiro. Ele traz informações detalhadas sobre as APIs, seus parâmetros, URLs, exemplos de respostas e possíveis erros, tudo inserido no contexto de negócio do produto.

Além disso, esse material disponibiliza diagramas e imagens, que contribuem para facilitar a compreensão dos conceitos.

Para ajudá-lo em sua navegação, resumimos o conteúdo de cada seção que você encontrará no menu.

Nesta seção, você encontrará informações relacionadas à integração com as APIs, ambiente de sandbox e produção, às convenções e notações adotadas pelo Bankly, além de dados sobre o programa de beta testers.

Nesta seção, você encontrará informações relacionadas à segurança da sua aplicação.

Nesta seção, você encontrará informações sobre os webhooks, como configurá-los e consultá-los.

Nesta seção, você encontrará informações sobre os eventos de webhooks liberados até o momento, agrupados por contexto. Exemplos: Pix, TED, Contas etc.

Nesta seção, você encontrará informações gerais sobre todo o processo de Onboarding de pessoa física e jurídica (MEI, EI, EIRELI ou SLU) e (LTDA, S.A. e TS). Além disso, saberá como enviar os documentos de LTDA, S.A. e TS.

Nesta seção, você encontrará informações sobre as melhores práticas de envio de fotos dos documentos pessoais de Onboarding e saberá como realizar esse envio com ID One. Além disso, saberá como consultar o status da análise dos documentos enviados.

Nesta seção, você encontrará informações sobre como realizar o registro de um cliente pessoa física e jurídica, consultar o status do seu registro, atualizar informações cadastrais e conhecer todo o ciclo de vida do seu cliente. Além disso, você terá acesso a tabelas contendo informações sobre os códigos de ocupação e dos possíveis motivos de reprovação do seu cliente.

Nesta seção, você encontrará informações sobre como encerrar o vínculo comercial com o cliente, seja ele pessoa física ou jurídica.

Nesta seção, você encontrará informações sobre como criar ou encerrar uma conta, como ter acesso aos informes de rendimentos anuais de seus clientes (pessoa física e jurídica), e informações sobre todo o ciclo de vida de uma conta pocket, como criação, alteração de usuário, depósito e resgaste de valores, consultas e encerramento.

Nesta seção, você encontrará informações sobre como emitir cartões Bankly, rastreá-los, alterar o seu limite, gerir sua senha e seu status e inseri-los em carteiras digitais. Além disso, você obterá informações sobre cartões No Name, como criação, vinculação e consultas.

Nesta seção, você encontrará informações sobre como consultar faturas, limite de crédito, opções de pagamento e como gerar uma forma de pagamento para a fatura. Além disso, você saberá como realizar o refinanciamento de uma fatura e antecipar as parcelas desse refinanciamento. Para melhorar a experiência, nesta mesma seção, disponibilizamos um endpoint de simulação do parcelamento de uma fatura.

Nesta seção, você encontrará informações sobre como analisar a elegibilidade de clientes para conceder crédito, originar contratos de crédito, gerir os contratos concedidos, cancelar contratos quando solicitado pelo parceiro e revisar os limites dos contratos.

Nesta seção, você encontrará informações sobre o processo de autenticação 3DS, incluindo a confirmação do desafio. Além disso, a seção disponibiliza um endpoint de simulação de criação do desafio para que a etapa de confirmação possa ser testada pelo parceiro.

Nesta seção, você encontrará informações sobre como cadastrar e reivindicar uma chave Pix, emitir e decodificar QR Codes, realizar transferências e devoluções, consultar o status de uma transação e utilizar o Pix troco.

Nesta seção, você encontrará informações sobre como transferir ou receber valores via TED e como consultar o status da transação.

Nesta seção, você encontrará informações sobre como realizar o pagamento de contas e como consultar os pagamentos realizados.

Nesta seção, você encontrará informações sobre como emitir boletos, consultar ou cancelar os boletos emitidos, e compreenderá como é realizado seu pagamento.

Nesta seção, você encontrará informações sobre instituições financeiras e seus dados, como o ISPB, os produtos ofertados, o tipo de banco (se é folha, destino ou ambos), dentre outros.

Nesta seção, você encontrará informações sobre como consultar os eventos ocorridos quando os webhooks ainda não foram configurados.