API’S

Boas-vindas à seção API’s!

Assim como o Manual do Dev, a seção de API's auxilia na integração do seu sistema às API's do Bankly. Porém, seu conteúdo é mais sucinto e sua abordagem mais objetiva, o que possibilita a obtenção de informações de maneira prática e rápida.

O desenvolvedor também conseguirá simular requisições e obter exemplos de respostas e erros das chamadas, o que contribui para uma integração mais segura.

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 sobre como obter o token de acesso para a API desejada.

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

Nesta seção, você encontrará informações sobre como enviar documentos para análise e, posteriormente, como consultar o status dessa análise.

O envio de documentos é uma etapa fundamental do processo de onboarding.

Nesta seção, você encontrará informações sobre como cadastrar ou encerrar o vínculo comercial com o cliente, seja ele pessoa física ou jurídica. Também compreenderá como consultar os cadastros realizados.

Nesta seção, você encontrará informações sobre como criar ou encerrar uma conta, como consultar os dados de uma conta específica e como consultar todas as contas de determinado cliente (pessoa física ou jurídica).

Nesta seção, você encontrará informações sobre como criar/atualizar limites personalizados e consultar limites personalizados ou por feature.

Nesta seção, você encontrará informações sobre como emitir, consultar e rastrear os cartões Bankly. Além de compreender como alterar senha, ativar o cartão, alterar o status, configurar o contactless e consultar tanto os próximos status quanto as transações realizadas com o cartão.

Nesta seção, você encontrará informações sobre como cadastrar, consultar e excluir uma chave Pix, emitir e decodificar QR Codes, realizar transferência e devolução e consultar o status da transação.

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 como consultar os eventos ocorridos quando os webhooks ainda não foram configurados.

Nesta seção, você encontrará informações sobre como consultar endereços por CEP, listar cidades por sigla do estado, obter uma lista de instituições financeiras por produto e consultar informações sobre a instituição financeira através do ISPB ou código bancário.

🚧

Importante

As APIs do Bankly são baseadas no protocolo REST, cujas requisições e respostas utilizam o formato JSON, e são utilizados os padrões HTTP para códigos de resposta, autenticação e verbos.

📘

Nota

O tempo máximo de resposta de nossas APIs é de 30 segundos.