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:
Obtenção de token de para gerar um certificado mTLS e download desse certificado.
Geração e validação de hash e código numérico da validação TOTP (Time-based One-time Password).
Configuração, alteração, exclusão e consulta de webhooks. Essa seção também oferece a consulta de mensagens enviadas e a possibilidade de reprocessamento de mensagens.
Consulta do status da análise de documentos do processo de Onboarding.
Cadastro, consulta, atualização e encerramento de vínculo comercial com o cliente (pessoa física ou jurídica).
Criação, consulta ou encerramento de conta (pessoa física ou jurídica), informe de rendimentos, contas pockets e acordos legais.
Consulta, criação e atualização de limites personalizados.
Emissão, consulta, rastreio, ativação de cartões, alteração de senha, alteração de status, configuração de contactless, consulta dos próximos status, consulta de transações e carteiras digitais.
Consulta, pagamento, refinanciamento e antecipação de faturas. A seção também disponibiliza a consulta de limite de crédito.
Criação de pré-análise de crédito e endpoints para análise de crédito (criação, aceite da proposta, consulta de contrato, reanálise de limite e aceite de novo limite).
Simulação de criação de challengedId para o fluxo de autenticação 3DS e confirmação do desafio.
Cadastro, consulta, exclusão e reivindicação de chave Pix. A seção também disponibiliza endpoints de tranferência via Pix, consulta e devolução de pagamentos, bem como emissão e decodificação de QR Codes.
Transferência e consulta de transferências.
Validação de títulos, confirmação e consultas de pagamentos.
Consulta de eventos relativos a uma conta específica.
Consulta de endereços por CEP, listagem de cidades por sigla do estado, listagem de instituições financeiras por produto e consulta de 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.