# Bankly | Banking as a Service Documentation > Construa suas próprias soluções financeiras. Com nossa plataforma de Banking as a Service, você desenvolve sua própria solução financeira, desde uma conta digital completa até funcionalidades modulares como Pix, emissão de cartões, geração de boletos, TEDs e diversos outros recursos. Comece agora! ## Guides - [O Manual do Dev](https://docs.bankly.com.br/docs/manual-do-dev.md) - [Pré-requisitos para integração](https://docs.bankly.com.br/docs/pre-requisitos-para-integracao.md) - [Ambiente de Sandbox X Produção](https://docs.bankly.com.br/docs/ambiente-sandbox-producao.md) - [Versões de APIs](https://docs.bankly.com.br/docs/versoes-de-apis.md) - [Programa de beta testers](https://docs.bankly.com.br/docs/programa-de-beta-testers.md) - [Notações](https://docs.bankly.com.br/docs/notacoes.md) - [Convenções](https://docs.bankly.com.br/docs/convencoes.md) - [HATEOAS](https://docs.bankly.com.br/docs/convencoes-hateoas.md) - [Chave de idempotência (Idempotency-key)](https://docs.bankly.com.br/docs/idempotency-key.md) - [Status codes](https://docs.bankly.com.br/docs/convencoes-status-codes.md) - [Erros](https://docs.bankly.com.br/docs/erros.md) - [FAQ](https://docs.bankly.com.br/docs/faq.md) - [Manual de Segurança](https://docs.bankly.com.br/docs/seguranca-da-informacao.md): Requisitos obrigatórios e recomendados para utilização de Mobiles Apps, APIs e aplicações Web - [Autenticação e autorização (mTLS / DCR)](https://docs.bankly.com.br/docs/autenticacao-autorizacao-mtls-dcr.md): stable - [Token para gerar certificado mTLS](https://docs.bankly.com.br/docs/fluxos-autorizacao.md): stable - [Download do certificado TLS](https://docs.bankly.com.br/docs/download-do-certificado-tls.md): stable - [Registro dinâmico de client (credencial)](https://docs.bankly.com.br/docs/registro-dinamico-de-client.md): stable - [Geração do token (autenticação com mTLS)](https://docs.bankly.com.br/docs/geracao-token-autenticacao-com-mtls.md): stable - [TOTP](https://docs.bankly.com.br/docs/totp.md): stable - [Geração do hash e do código numérico](https://docs.bankly.com.br/docs/totp-geracao-de-hash.md): stable - [Validação do hash e do código numérico](https://docs.bankly.com.br/docs/totp-validacao-do-hash.md): stable - [Features](https://docs.bankly.com.br/docs/features.md) - [Scopes](https://docs.bankly.com.br/docs/scopes.md): stable - [Visão geral](https://docs.bankly.com.br/docs/webhooks-visao-geral.md) - [Pré-requisitos para configuração](https://docs.bankly.com.br/docs/pre-requisitos-configuracao-webhooks.md): stable - [Geração de assinatura HMAC](https://docs.bankly.com.br/docs/assinatura-hmac.md): stable - [Configuração dos webhooks](https://docs.bankly.com.br/docs/configuracao-webhooks.md): stable - [Registro de um novo webhook](https://docs.bankly.com.br/docs/registro-de-um-novo-webhook.md): stable - [Consulta de todas as configurações de webhooks](https://docs.bankly.com.br/docs/consultas-webhooks.md): stable - [Consulta de configuração de webhook específico](https://docs.bankly.com.br/docs/consulta-configuracao-especifica.md): stable - [Alteração de configuração](https://docs.bankly.com.br/docs/alteracao-configuracao.md): stable - [Exclusão de configuração](https://docs.bankly.com.br/docs/exclusao-configuracao.md): stable - [Desabilitar uma configuração](https://docs.bankly.com.br/docs/desabilitar-configuracao.md): stable - [Habilitar uma configuração](https://docs.bankly.com.br/docs/habilitar-configuracao.md): stable - [Mensagens](https://docs.bankly.com.br/docs/mensagens-webhooks.md) - [Consulta de mensagens enviadas](https://docs.bankly.com.br/docs/consulta-de-mensagens-enviadas.md): stable - [Reprocessamento de mensagens](https://docs.bankly.com.br/docs/reprocessamento-de-mensagens.md): stable - [Reprocessamento de eventos em lote](https://docs.bankly.com.br/docs/webhooks-reprocessamento-mensagens.md): stable - [Consulta de um reprocessamento em lote](https://docs.bankly.com.br/docs/pesquisa-de-mensagens-enviadas.md): stable - [Circuit Breaker](https://docs.bankly.com.br/docs/circuit-breaker.md): stable - [Visão geral](https://docs.bankly.com.br/docs/convencoes-eventos.md): stable - [Autenticação 3DS](https://docs.bankly.com.br/docs/eventos-autenticacao-3ds.md): stable - [Autorização e confirmação (Authorization)](https://docs.bankly.com.br/docs/eventos-autorizacao.md): stable - [Boleto](https://docs.bankly.com.br/docs/eventos-boleto.md): stable - [Cartão (Card)](https://docs.bankly.com.br/docs/eventos-cartoes.md): stable - [Contas (Account)](https://docs.bankly.com.br/docs/eventos-contas.md): stable - [Crédito (Credit)](https://docs.bankly.com.br/docs/eventos-credito.md): stable - [Envio de imagens para Onboarding (Document)](https://docs.bankly.com.br/docs/eventos-envio-imagens-onboarding.md): stable - [Fatura (Invoice)](https://docs.bankly.com.br/docs/eventos-faturas.md): stable - [Pagamento de contas (Payment)](https://docs.bankly.com.br/docs/eventos-pagamento-de-contas.md): stable - [Partner](https://docs.bankly.com.br/docs/eventos-partner.md) - [Pessoa física (Customer)](https://docs.bankly.com.br/docs/eventos-pessoa-fisica.md): stable - [MEI, EI, EIRELI ou SLU](https://docs.bankly.com.br/docs/eventos-onboarding-mei.md): stable - [LTDA, S.A. e TS](https://docs.bankly.com.br/docs/eventos-onboarding-ltda-sa-ts.md): stable - [Pix e DICT](https://docs.bankly.com.br/docs/eventos-pix.md): stable - [Pix Automático | Notificações de Autorização de Recorrência](https://docs.bankly.com.br/docs/notificacao-autorizacao-pix-automático.md) - [Pix Automático | Notificações de Agendamento](https://docs.bankly.com.br/docs/notificacoes-agendamentos-pix-automatico.md) - [Notificações de Agendamento Único e Agendamento Recorrente](https://docs.bankly.com.br/docs/pix-notificacoes-agendamento.md) - [Pocket](https://docs.bankly.com.br/docs/eventos-pocket.md): stable - [SLC](https://docs.bankly.com.br/docs/eventos-slc.md) - [TED](https://docs.bankly.com.br/docs/eventos-ted.md): stable - [Open Finance](https://docs.bankly.com.br/docs/open-finance.md) - [Visão geral](https://docs.bankly.com.br/docs/open-finance-visao-geral.md) - [Compartilhamento de dados e/ou iniciação de pagamento por WebView](https://docs.bankly.com.br/docs/transmissao-dados-webview.md) - [Geração do ticket de acesso ao WebView](https://docs.bankly.com.br/docs/geracao-ticket-webview.md): stable - [Processo de hand-off](https://docs.bankly.com.br/docs/processo-de-handoff.md) - [Gestão de consentimentos](https://docs.bankly.com.br/docs/gestao-consentimentos.md): stable - [Visão geral](https://docs.bankly.com.br/docs/onboarding-visao-geral.md) - [Pessoa física](https://docs.bankly.com.br/docs/onboarding-completo.md): stable - [MEI, EI, EIRELI ou SLU](https://docs.bankly.com.br/docs/onboarding-mei-ei-eireli-ou-slu.md): stable - [LTDA, S.A. e TS](https://docs.bankly.com.br/docs/onboarding-ltda-sa-ts.md): stable - [Envio de documentos LTDA, S.A. e TS](https://docs.bankly.com.br/docs/envio-documentos-corporativos.md): stable - [Visão geral](https://docs.bankly.com.br/docs/visao_geral.md): stable - [Criação Processo Selfie](https://docs.bankly.com.br/docs/criacao-processo-selfie.md) - [Envio e análise de documentos pessoais com ID One](https://docs.bankly.com.br/docs/envio-documentos-analise-id-one.md) - [Consulta do status da análise](https://docs.bankly.com.br/docs/consulta-status-analise.md): stable - [Orientações para envio de fotos](https://docs.bankly.com.br/docs/orientacoes-para-envio-de-fotos.md) - [Token de autenticação de identidade](https://docs.bankly.com.br/docs/token-autenticacao-identidade.md): - [Solicitação de novo token](https://docs.bankly.com.br/docs/solicitacao-novo-token.md) - [Visão geral](https://docs.bankly.com.br/docs/registro-cliente-visao-geral.md) - [Registro de pessoa física](https://docs.bankly.com.br/docs/registro-pessoa-fisica.md): stable - [Consulta do registro do cliente](https://docs.bankly.com.br/docs/consulta-registro-cliente.md): stable - [Atualização cadastral](https://docs.bankly.com.br/docs/atualizacao-cadastral.md): stable - [Ciclo de vida do cliente](https://docs.bankly.com.br/docs/ciclo-de-vida-cliente-pessoa-fisica.md) - [Registro de MEI, EI, EIRELI ou SLU](https://docs.bankly.com.br/docs/onboarding-mei-ei-slu.md): stable - [Registro de LTDA, S.A. e TS](https://docs.bankly.com.br/docs/registro-pj-ltda-sa-ts.md): stable - [Consulta do registro da empresa](https://docs.bankly.com.br/docs/consulta-registro-empresa.md): stable - [Código de ocupação do cliente](https://docs.bankly.com.br/docs/codigo-de-ocupacao-cliente.md) - [Motivos de reprovação de registro](https://docs.bankly.com.br/docs/onboarding-motivos-reprovacao.md): stable - [Visão geral](https://docs.bankly.com.br/docs/offboarding-visao-geral.md) - [Pessoa física](https://docs.bankly.com.br/docs/offboarding-pessoa-fisica.md): stable - [Pessoa jurídica](https://docs.bankly.com.br/docs/offboarding-pessoa-juridica.md): stable - [Visão geral](https://docs.bankly.com.br/docs/gestao-de-conta-visao-geral.md) - [Multicontas](https://docs.bankly.com.br/docs/multi-accounts.md): stable - [Conta pocket](https://docs.bankly.com.br/docs/contas-pocket.md) - [Acordos legais](https://docs.bankly.com.br/docs/visao-geral-acordos-legais.md) - [Obtenção do documento (acordo legal)](https://docs.bankly.com.br/docs/obtencao-do-documento.md): beta - [Aceite do acordo legal](https://docs.bankly.com.br/docs/aceite-do-acordo-legal.md) - [Abertura de conta](https://docs.bankly.com.br/docs/abertura-de-conta-pessoa-fisica.md): stable - [Consulta de contas](https://docs.bankly.com.br/docs/consulta-contas-cliente-pessoa-fisica.md): stable - [Abertura de conta](https://docs.bankly.com.br/docs/abertura-de-conta-pessoa-juridica.md): stable - [Consulta de contas](https://docs.bankly.com.br/docs/consulta-contas-cliente-pessoa-juridica.md): stable - [Consulta de dados de uma conta](https://docs.bankly.com.br/docs/consulta-de-dados-de-uma-conta.md): stable - [Encerramento de conta](https://docs.bankly.com.br/docs/encerramento-contas.md): stable - [Informe de rendimentos](https://docs.bankly.com.br/docs/informe-de-rendimentos.md): deprecated - [Dados para informe de rendimentos](https://docs.bankly.com.br/docs/dados-informe-de-rendimentos.md): deprecated - [Informe de rendimentos em PDF](https://docs.bankly.com.br/docs/informe-rendimento-pdf.md): deprecated - [Visão Geral](https://docs.bankly.com.br/docs/limites-visao-geral.md) - [Consulta de limite por feature](https://docs.bankly.com.br/docs/consulta-limite-feature.md): stable - [Criação e atualização de limite personalizado](https://docs.bankly.com.br/docs/criacao-e-atualizacao-limite.md): stable - [Visão geral](https://docs.bankly.com.br/docs/gestao-cartoes-visao-geral.md) - [Definições](https://docs.bankly.com.br/docs/definicoes.md) - [Emissão de cartão](https://docs.bankly.com.br/docs/emissao-de-cartao.md): stable - [Emissão de cartão físico](https://docs.bankly.com.br/docs/emissao-cartao-fisico.md): stable pré pós - [Emissão de cartão virtual](https://docs.bankly.com.br/docs/emissao-cartao-virtual.md): stable pré pós - [Emissão de cartão múltiplo](https://docs.bankly.com.br/docs/emissao-cartao-multiplo.md): stable pré pós - [Emissão de segunda via](https://docs.bankly.com.br/docs/emissao-segunda-via.md): stable pré pós - [Embossing](https://docs.bankly.com.br/docs/embossing.md) - [Cartões Combo](https://docs.bankly.com.br/docs/cartao-combo.md) - [Alteração de status de modalidade](https://docs.bankly.com.br/docs/alteracao-status-modalidade.md): beta - [Vinculação do cartão combo a uma conta](https://docs.bankly.com.br/docs/vinculo-cartao-conta.md): beta - [Cartões No Name](https://docs.bankly.com.br/docs/cartao-no-name.md) - [Criação de cartões em lote](https://docs.bankly.com.br/docs/criacao-de-cartoes-em-lote.md): stable pré - [Vinculação do cartão com uma conta bancária](https://docs.bankly.com.br/docs/vinculacao-cartao-com-conta.md): stable pré - [Consulta de lotes](https://docs.bankly.com.br/docs/consulta-de-lotes.md): stable pré - [Consulta de lote por id](https://docs.bankly.com.br/docs/consulta-de-lote-por-id.md): stable pré - [Consulta de cartões](https://docs.bankly.com.br/docs/visao-geral-consulta-de-cartoes.md) - [Por proxy](https://docs.bankly.com.br/docs/consulta-cartoes-por-proxy.md): stable pré pós - [Por PAN](https://docs.bankly.com.br/docs/consulta-cartoes-por-pan.md): stable pré pós - [Por documento (CPF ou CNPJ)](https://docs.bankly.com.br/docs/consulta-cartoes-por-documento-cpf-ou-cnpj.md): stable pré pós - [Por código de ativação](https://docs.bankly.com.br/docs/consulta-cartoes-por-codigo-de-ativacao.md): stable pré pós - [Por conta](https://docs.bankly.com.br/docs/consulta-cartoes-por-conta.md): stable pré pós - [Dados de segurança do cartão](https://docs.bankly.com.br/docs/consulta-cartoes-dados-de-seguranca-do-cartao.md): stable pré pós - [Por proxy](https://docs.bankly.com.br/docs/rastreio-cartoes-por-proxy.md): stable pré pós - [Alteração de endereço](https://docs.bankly.com.br/docs/alteracao-endereco.md): stable pré pós - [Alteração de limite ativo de cartão pós-pago](https://docs.bankly.com.br/docs/alteracao-limite-ativo-cartao.md): stable pós - [Gestão do status](https://docs.bankly.com.br/docs/gestao-do-status.md) - [Ativação do cartão](https://docs.bankly.com.br/docs/ativacao-do-cartao.md): stable pré pós - [Alteração do status do cartão](https://docs.bankly.com.br/docs/alteracao-status-do-cartao.md): stable pré pós - [Consulta dos próximos status](https://docs.bankly.com.br/docs/consulta-dos-proximos-status.md): stable pré pós - [Possíveis status do cartão](https://docs.bankly.com.br/docs/tabela-possiveis-status-cartao.md) - [Carteiras digitais](https://docs.bankly.com.br/docs/carteiras-digitais.md) - [Geração de token - Fluxo Green Path](https://docs.bankly.com.br/docs/geracao-de-token.md): stable pré pós - [Ativaçao de token - (assíncrono) Google Pay In-App ](https://docs.bankly.com.br/docs/ativaçao-de-token-assincrono.md): stable pré pós - [Geração de dados de ativação - Apple Pay In-App ](https://docs.bankly.com.br/docs/geracao-dados-ativacao.md) - [Alteração de senha](https://docs.bankly.com.br/docs/alteracao-de-senha-cartao.md): stable pré pós - [Alteração de senha com criptografia](https://docs.bankly.com.br/docs/alteracao-de-senha-criptografada.md): beta - [Consulta de senha com criptografia](https://docs.bankly.com.br/docs/consulta-senha-criptografada.md): stable - [Configuração do contactless](https://docs.bankly.com.br/docs/configuracao-do-contactless.md): stable pré pós - [Alteração da data de vencimento](https://docs.bankly.com.br/docs/alteracao-data-de-vencimento.md): stable pós - [Consulta de transações por cartão](https://docs.bankly.com.br/docs/consulta-de-transacoes-por-cartao.md): stable pós - [Gestão de data de expiração de cartão](https://docs.bankly.com.br/docs/gestao-data-expiracao-cartao.md) - [Visão geral](https://docs.bankly.com.br/docs/gestao-faturas-visao-geral.md) - [Consulta de fatura aberta](https://docs.bankly.com.br/docs/consulta-de-fatura-aberta.md): stable - [Consulta de fatura por ID](https://docs.bankly.com.br/docs/consulta-de-fatura-por-id.md): stable - [Consulta de fatura por período](https://docs.bankly.com.br/docs/consultas-de-faturas.md): stable - [Consulta de limite de crédito](https://docs.bankly.com.br/docs/consulta-de-limite-de-credito.md): stable - [Refinanciamento de fatura](https://docs.bankly.com.br/docs/refinanciamento-de-fatura.md) - [Simulação de parcelamentos de uma fatura](https://docs.bankly.com.br/docs/simulacao-de-parcelamentos-fatura.md): stable simulação - [Pagamento de faturas](https://docs.bankly.com.br/docs/pagamento-faturas.md) - [Geração de uma forma de pagamento](https://docs.bankly.com.br/docs/geracao-forma-pagamento.md): stable - [Consulta de opções de pagamento](https://docs.bankly.com.br/docs/consulta-de-opcoes-pagamento.md): stable - [Antecipação de parcelas](https://docs.bankly.com.br/docs/visao-geral-antecipacao-parcelas.md) - [Simulação de antecipação de parcelas](https://docs.bankly.com.br/docs/simulacao-de-antecipacao-de-parcelas.md): stable - [Confirmação de antecipação de parcelas](https://docs.bankly.com.br/docs/antecipacao-de-parcelas.md): stable - [Régua de cobrança](https://docs.bankly.com.br/docs/regua-de-cobranca.md): stable - [Pré-análise de crédito](https://docs.bankly.com.br/docs/visao-geral-pre-analise.md) - [Criação de pré-análise de crédito](https://docs.bankly.com.br/docs/criacao-pre-analise.md): stable - [Análise de crédito](https://docs.bankly.com.br/docs/analise-do-credito.md): stable - [Criação de análise de crédito](https://docs.bankly.com.br/docs/criacao-analise-credito.md): stable - [Aceite da proposta do contrato de crédito](https://docs.bankly.com.br/docs/aceite-proposta-contrato-credito.md): stable - [Consulta de contrato de crédito](https://docs.bankly.com.br/docs/consulta-contrato-de-credito.md): stable - [Reanálise do limite de contrato de crédito](https://docs.bankly.com.br/docs/reanalise-contrato-credito.md): stable - [Aceite do novo limite de contrato de crédito](https://docs.bankly.com.br/docs/aceite-novo-limite.md): stable - [Visão geral](https://docs.bankly.com.br/docs/transacoes-bandeiradas-visao-geral.md) - [Autorização e liquidação](https://docs.bankly.com.br/docs/autorizacao-e-liquidacao.md) - [Autenticação 3 DS](https://docs.bankly.com.br/docs/autenticacao-3ds.md) - [Simulação de criação do desafio (challengeId)](https://docs.bankly.com.br/docs/simulacao-do-desafio.md): simulação - [Confirmação do desafio](https://docs.bankly.com.br/docs/confirmacao-do-desafio.md): stable - [Consulta de Cotações do Dólar](https://docs.bankly.com.br/docs/cotacao-dolar.md): Esses endpoints têm como objetivo fornecer acesso às cotações atualizadas do dólar, utilizando como fonte oficial a API do Banco Central do Brasil (BACEN). Foram implementadas duas rotas que permitem a consulta dos valores do dólar em diferentes formatos, facilitando a integração com sistemas. - [Visão geral](https://docs.bankly.com.br/docs/pix-visao-geral.md) - [Canais de transmissão](https://docs.bankly.com.br/docs/pix-canais-de-transmissao.md) - [Diretório de chaves - DICT](https://docs.bankly.com.br/docs/diretorio-chaves-dict.md): stable - [Consulta de chaves de uma conta](https://docs.bankly.com.br/docs/consulta-de-chaves-de-uma-conta.md): stable - [Cadastro de chaves](https://docs.bankly.com.br/docs/cadastro-de-chaves.md): stable - [Consulta de chaves para transferência](https://docs.bankly.com.br/docs/pix-consulta-por-chaves.md): stable - [Exclusão de chaves](https://docs.bankly.com.br/docs/pix-exclusao-chaves.md): stable - [Reivindicação de chaves Pix](https://docs.bankly.com.br/docs/pix-reivindicacao-chaves.md): stable - [Criação de pedido de reivindicação](https://docs.bankly.com.br/docs/reivindicacao-chave.md): stable - [Consulta dos pedidos de reivindicação](https://docs.bankly.com.br/docs/consulta-pedidos-reivindicacao.md): stable - [Confirmação de um pedido de reivindicação](https://docs.bankly.com.br/docs/confirmacao-pedido-reivindicacao.md): stable - [Completando o pedido de reivindicação](https://docs.bankly.com.br/docs/completando-um-pedido.md): stable - [Simulação de reconhecimento de pedido de reivindicação](https://docs.bankly.com.br/docs/simulacao-acknowledgement.md): simulação - [Cancelamento de um pedido de reivindicação](https://docs.bankly.com.br/docs/cancelamento-pedido-reivindicacao.md): stable - [Pagamentos](https://docs.bankly.com.br/docs/pix-pagamentos.md) - [Recebimento de valores via Pix](https://docs.bankly.com.br/docs/pix-recebimento-valores.md) - [Transferência via Pix](https://docs.bankly.com.br/docs/pix-cash-out.md): stable - [Consulta do status da transação](https://docs.bankly.com.br/docs/pix-consulta-status.md): stable - [Devolução de transferência Pix](https://docs.bankly.com.br/docs/pix-devolucao.md) - [QR Code](https://docs.bankly.com.br/docs/pix-qrcode.md): stable - [Emissão de QR Code estático](https://docs.bankly.com.br/docs/pix-emissao-qrcode-estatico.md): stable - [Emissão QR Code dinâmico](https://docs.bankly.com.br/docs/pix-emissao-qrcode-dinamico.md): stable - [Decodificação de QR Codes](https://docs.bankly.com.br/docs/decodificacao-de-qr-code.md): stable - [Pix Troco](https://docs.bankly.com.br/docs/pix-troco.md): stable - [Pix automático](https://docs.bankly.com.br/docs/pix-automatico.md) - [Autorização de Pix automático](https://docs.bankly.com.br/docs/autorizacao-de-pix-automatico.md): stable - [Consulta de Solicitação de Autorização de Recorrência](https://docs.bankly.com.br/docs/consulta-de-detalhes-autorizacoes.md): stable - [Alterar valor máximo de autorização](https://docs.bankly.com.br/docs/pix-editar-autorizacao.md): stable - [Cancelar autorização](https://docs.bankly.com.br/docs/pix-cancelar-autorizacao.md): stable - [Agendamento Único e Recorrente](https://docs.bankly.com.br/docs/pix-agendamento.md) - [Criar agendamento único](https://docs.bankly.com.br/docs/pix-criar-agendamento-unico.md) - [Listar agendamentos](https://docs.bankly.com.br/docs/pix-lista-agendamentos.md): stable - [Consulta de agendamento por identificador](https://docs.bankly.com.br/docs/pix-consulta-agendamento.md): stable - [Cancelar agendamento](https://docs.bankly.com.br/docs/pix-cancelar-agendamento.md): stable - [Criar recorrência de agendamento](https://docs.bankly.com.br/docs/pix-criar-recorrencia.md) - [Listar recorrência de agendamentos](https://docs.bankly.com.br/docs/pix-listar-recorrencia.md): stable - [Consulta de recorrência por identificador](https://docs.bankly.com.br/docs/pix-consulta-recorrencia-por-identificador.md): stable - [Cancelar recorrência](https://docs.bankly.com.br/docs/pix-cancelar-recorrencia.md): stable - [Autoatendimento MED - Fluxo de recuperação de valores](https://docs.bankly.com.br/docs/autoatendimento-med.md) - [Criar contestação - Autoatendimento MED](https://docs.bankly.com.br/docs/pix-criar-notificacao-infracao.md): A abertura de uma contestação deve ser feita pelo prestador de serviço de pagamento (PSP) do pagador assim que houver suspeita de fraude ou reclamação do cliente. Esse PSP é chamado de participante recuperador, e a transação que origina o processo é denominada transação raiz, sempre vinculada a um cliente pagador. A instauração do processo deve ocorrer de forma imediata, com o objetivo de agilizar o bloqueio dos recursos. A análise do mérito da solicitação é feita posteriormente, permitindo maior eficiência na contenção dos valores envolvidos. - [Cancelar contestação - Autoatendimento MED](https://docs.bankly.com.br/docs/pix-cancelar-contestacao.md): A funcionalidade de cancelamento de contestação permite que o usuário encerre uma contestação MED 2.0 que ainda esteja em andamento. Ao acessar os detalhes de uma contestação ativa, o usuário pode optar por cancelá‑la, encerrando definitivamente o processo sem continuidade de análise. O cancelamento somente é permitido quando a contestação está em status elegível e ainda não passou por decisão final. - [Listar contestação - Autoatendimento MED](https://docs.bankly.com.br/docs/pix-listar-contestacao.md): Utilize este endpoint para listar as notificações de infração do pagador. - [Consultar detalhes da contestação - Autoatendimento MED](https://docs.bankly.com.br/docs/pix-consultar-contestacao.md): Utilize este endpoint para consultar os detalhes de uma notificação de infração. - [Visão geral](https://docs.bankly.com.br/docs/ted-visao-geral.md): stable - [Recebimento de valores via TED](https://docs.bankly.com.br/docs/recebimento-valores-via-ted.md): stable - [Transferência via TED](https://docs.bankly.com.br/docs/transferencia-via-ted.md): stable - [Consulta do status da transação](https://docs.bankly.com.br/docs/consulta-status-transacao.md): stable - [Consulta por conta](https://docs.bankly.com.br/docs/ted-consulta-conta.md): stable - [Consulta por código de autenticação](https://docs.bankly.com.br/docs/ted-consulta-codigo-autenticacao.md): stable - [Visão geral](https://docs.bankly.com.br/docs/slc-visao-geral.md) - [Visão geral](https://docs.bankly.com.br/docs/pagamento-contas-visao-geral.md) - [Validação do título](https://docs.bankly.com.br/docs/validacao-do-pagamento.md): stable - [Confirmação do pagamento](https://docs.bankly.com.br/docs/confirmacao-do-pagamento.md): stable - [Consulta do status da transação](https://docs.bankly.com.br/docs/consulta-de-pagamentos.md) - [Consulta por conta](https://docs.bankly.com.br/docs/consulta-pagamento-por-conta.md): stable - [Consulta por código de autenticação](https://docs.bankly.com.br/docs/consulta-por-codigo-de-autenticacao.md): stable - [Visão geral](https://docs.bankly.com.br/docs/boleto-visao-geral.md) - [Consulta de endereço por CEP](https://docs.bankly.com.br/docs/consulta-cep.md): stable - [Listagem de instituições financeiras](https://docs.bankly.com.br/docs/listagem-bancos.md): stable - [Visão geral](https://docs.bankly.com.br/docs/feed-eventos-visao-geral.md) - [Consulta de eventos](https://docs.bankly.com.br/docs/eventos.md): stable - [Eventos](https://docs.bankly.com.br/docs/eventos-events.md): stable - [Boletos](https://docs.bankly.com.br/docs/events-boletos.md): stable - [Cartões](https://docs.bankly.com.br/docs/events-cartoes.md): stable - [Contas](https://docs.bankly.com.br/docs/events-contas.md): stable - [Pagamento de contas](https://docs.bankly.com.br/docs/events-pagamento-de-contas.md): stable - [Pix](https://docs.bankly.com.br/docs/events-pix.md): stable - [TED](https://docs.bankly.com.br/docs/events-ted.md): stable - [SLC](https://docs.bankly.com.br/docs/events-slc.md) ## API Reference - [API’S](https://docs.bankly.com.br/reference/bem-vindo-ao-bankly.md) - [Token para gerar certificado mTLS](https://docs.bankly.com.br/reference/token-de-acesso.md):
Obtenha um token de acesso para gerar o certificado mTLS.
stable scope: certificate.createBaixe o certificado TLS para iniciar o processo de autenticação com mTLS.
stableRegistre um novo webhook para um evento Bankly.
stable scope: webhook.writeConsulte todas as configurações registradas para os webhooks.
stable scope: webhook.readRealize a consulta das configurações de um webhook específico.
stable scope: webhook.readAltere a chave pública, a chave privada e/ou a URI do endpoint de um webhook configurado pelo parceiro.
stable scope: webhook.writeRealize a exclusão de uma configuração de webhook quando necessário.
stable scope: webhook.deleteDesabilite a configuração de um webhook vinculado a um evento Bankly quando necessário.
stable scope: webhook.writeHabilite a configuração de um webhook vinculado a um evento Bankly.
stable scope: webhook.writeConsulte os reprocessamentos em lote que foram previamente criados.
stable scope: webhook.readReegistre o reprocessamento de eventos em lote.
stable scope: webhook.readGere um ticket que dará acesso ao WebView para iniciar a transmissão de dados de seu cliente no ecossistema Open Finance.
stable scope: openfinance.ticket.writeGere um ticket que dará acesso ao WebView para efetuar a gestão dos consentimentos de seu cliente.
stable scope: openfinance.ticket.writeConsulte o status da análise dos documentos enviados pelo endpoint envio de documentos pessoais para análise com o ID ONE. Para obter mais de um resultado, informe os tokens correspondentes às análises solicitadas.
stable scope: kyc.document.readSolicite um novo token de autenticação de identidade para o seu cliente.
beta scope: security.id-token.createRegistre um cliente pessoa física. Se os dados informados já existirem, eles serão sobrepostos.
Após o registro, as informações serão analisadas e você poderá obter o resultado dessa análise por meio do endpoint Consulta do registro do cliente.
Obtenha um resultado resumido (BASIC) ou detalhado (DETAILED) dos dados de registro de um cliente.
stable scope: customer.readRealize a atualização de determinados dados cadastrais de clientes do tipo pessoa física.
stable scope: customer.updateSolicite o encerramento de vínculo comercial com cliente do tipo pessoa física (cancelamento de registro, contas, cartões e chaves Pix).
stable scope: customer.cancelRegistre um cliente pessoa jurídica do tipo MEI, EI, EIRELI ou SLU.
Após o registro, as informações serão analisadas e você poderá obter o resultado dessa análise por meio do endpoint Consulta do registro da empresa.
Obtenha um resultado resumido (BASIC) ou detalhado (DETAILED) dos dados de registro de uma empresa.
stable scope: business.readRealize o envio de imagens de documentos de pessoa jurídica (LTDA, S.A. e TS), para que seja possível realizar o fluxo de Onboarding.
stable scope: kyc.document.writeRegistre um cliente pessoa jurídica do tipo LTDA, S.A. ou TS. O pedido de registro será analisado e você poderá obter o resultado dessa análise por meio do endpoint Consulta do registro da empresa. Caso o cadastro não exista, ele será criado. Se já existir, os dados serão sobrepostos.
stable scope: business.corporation.writeSolicite o encerramento de vínculo comercial com cliente do tipo pessoa jurídica (cancelamento de registro, contas, cartões e chaves Pix).
stable scope: business.cancelObtenha o documento do acordo legal para ser visualizado e aceito pelo seu cliente.
beta scope: legal.agreements.readEnvie ao Bankly o consentimento do cliente referente ao acordo legal apresentado.
beta scope: legal.agreements.acceptCrie contas de pagamento para clientes do tipo pessoa física que tiveram seu registro previamente aprovado.
stable scope: account.createIdempotency-Key nas requisições, a fim de evitar a criação de contas duplicadas. Para mais informações, confira a documentação [Abertura de conta](/docs/abertura-de-conta-pessoa-fisica)." } [/block]
- [Consulta de contas](https://docs.bankly.com.br/reference/getpersonalaccounts.md): Realize a consulta de todas as contas que determinado cliente do tipo pessoa física possui.
stable scope: account.readCrie contas de pagamento para clientes do tipo pessoa jurídica que tiveram seu registro previamente aprovado.
stable scope: account.createIdempotency-Key nas requisições, a fim de evitar a criação de contas duplicadas. Para mais informações, confira a documentação [Abertura de conta](/docs/abertura-de-conta-pessoa-juridica). " } [/block]
- [Consulta de contas](https://docs.bankly.com.br/reference/getbusinessaccounts.md): Realize a consulta de todas as contas que determinado cliente do tipo pessoa jurídica possui.
stable scope: account.readRealize a consulta dos dados de uma conta específica. Opcionalmente, é possível obter o saldo dessa conta (exceto o saldo bloqueado).
stable scope: account.readSolicite o encerramento da conta do cliente.
stable scope: account.closeConsulte as configurações dos limites de uma feature (funcionalidade) específica.
stable scope: limits.readCrie ou atualize limites definidos pelo usuário.
stable scope: limits.writeCrie um cartão virtual que poderá ser utilizado em compras on-line.
stable scope: card.createCrie um cartão físico que será embossado e entregue no endereço informado.
stable scope: card.createCrie uma segunda via de um cartão físico com as mesmas características da primeira via.
stable scope: card.createEste endpoint permite que o parceiro Bankly ofereça a seus clientes a possibilidade de solicitar um cartão adicional.
stable scope: card.createCrie um cartão físico múltiplo (pré e pós) que será embossado e entrege no endereço informado pelo cliente.
stable scope: card.createCrie um lote de cartões sem vínculo com uma conta (Cartão No Name).
stable scope: card.createVincule um cartão a uma conta, para que ele seja ativado e para que seja possível definir uma senha para ele.
stable scope: card.updateObtenha os dados de um lote específico de cartões.
stable scope: card.readObtenha os dados de todos os lotes de cartões.
stable scope: card.readConsulte os dados de um cartão pelo seu proxy.
stable scope: card.readConsulte os dados de um cartão pelo Primary Account Number (PAN).
stable scope: card.pci.readConsulte os dados de um cartão por meio do número de documento (CPF ou CNPJ) do seu titular.
stable scope: card.readConsulte os dados de um cartão por meio do seu código de ativação.
stable scope: card.readConsulte os cartões vinculados a uma conta.
stable scope: card.readConsulte os dados PCI de um cartão (PAN, CVV e data de validade).
stable scope: card.pci.readObtenha o rastreio do cartão pelo seu proxy.
stable scope: card.readAtualize o endereço do destinatário do cartão para uma nova tentativa de entrega.
stable scope: card.updateAltere o limite de crédito ativo de um cartão pós-pago.
stable scope: card.updateRealize a ativação do cartão pela primeira vez.
stable scope: card.updateRealize a alteração do status do cartão. O status escolhido poderá ser [temporário ou definitivo](/docs/tabela-possiveis-status-cartao).
stable scope: card.updateConsulte todos os possíveis próximos status válidos para o cartão. Serão consideradas as permissões concedidas para o token informado na requisição.
stable scope: card.readGere um token com os dados criptografados do cartão para adicioná-lo a uma carteira digital (Google Pay ou Apple Pay).
stable scope: card.pci.token.createGere um token contendo os dados de ativação (activationData) para a formulação do desafio que confirmará a adição do cartão à carteira digital, em caso de uso de Apple Pay e fluxo de verificação in-App.
Realize a alteração da senha de um cartão.
stable scope: card.pci.password.updateAltere a senha de um cartão com segurança, por meio da comunicação criptografada.
beta scope: card.pci.password.updateConsulte a senha de um cartão por meio de comunicação criptografada.
stable scope: card.pci.readAtive ou desative a função contactless do cartão. Para cartões virtuais, caso o contactless fique desativado, não será possível realizar transações com o uso de carteiras digitais.
stable scope: card.updateAltere a data de vencimento da fatura do cartão de crédito do seu cliente.
stable scope: card.updateConsulte as transações realizadas no cartão de acordo com os filtros informados.
Importante: a diferença entre a data de início e de fim deverá ser de, no máximo, sete dias.
Realize o bloqueio temporário de uma das modalidade do cartão do tipo combo (débito ou pós) ou habilite uma modalidade que havia sido bloqueada.
beta scope: card.updateVincule um cartão do tipo combo a uma conta bancária. Desse modo, a modalidade débito será ativada.
beta scope: card.updateConsulte os dados de uma fatura em aberto (cycleType = “Open”) por meio do proxy do cartão e do número do documento de seu titular.
Consulte os dados de uma fatura específica, independentemente do seu status, por meio do seu identificador único (id).
Consulte todas as faturas de um determinado período (initialDate e finalDate), independentemente do seu status.
Consulte o limite de crédito do cartão.
stable scope: invoice.readSimule os possíveis parcelamentos de uma fatura e seus valores.
stable simulação scope: invoice.readGere uma forma de pagamento para uma fatura específica, por meio do seu ID.
stable scope: invoice.writeConsulte as opções de pagamento de uma fatura.
stable scope: invoice.readSimule a antecipação de parcelas de refinanciamento, registradas em ciclos de faturas futuros, ou seja, que ainda não foram fechados nem abertos.
stable scope: invoice.readRealize o adiantamento de parcelas referentes a um refinanciamento (parcelado ou parcelado compulsório) e/ou de compras realizadas no cartão.
stable scope: invoice.writetransactionType apresente o valor REFINANCE_INSTALLMENT, CP_REFINANCING_INSTALLMENT ou ou INSTALLMENT_WITHOUT_INTEREST. Confira a documentação [Antecipação de parcelas](/docs/antecipacao-de-parcelas) para mais informações." } [/block]
- [Criação de pré-análise de crédito](https://docs.bankly.com.br/reference/criacao-de-pre-analise.md): Realize uma pré-análise para determinar se o cliente terá limite de crédito aprovado antes da criação de uma conta. Importante: A pré-análise é válida apenas até o final do dia em que foi realizada.
stable scope: credit.writeInicie o processo de análise do seu cliente para concessão de crédito.
stable scope: credit.writeEnvie o aceite da proposta já aprovada de um contrato de crédito.
stable scope: credit.writeConsulte um contrato de crédito já existente.
stable scope: credit.readSolicite a reanálise do limite de contrato de crédito do seu cliente.
stable scope: credit.writeApós o pedido de reanálise ser aprovado, envie o aceite do cliente para que seja possível realizar a emissão do novo contrato de crédito.
stable scope: credit.writeTeste o fluxo de autenticação 3DS, simulando a criação do challengeId, id da transação gerado para identificar o desafio que deverá ser enviado a seu cliente.
stable scope: card.network.transactions.3ds.writeApós o seu cliente responder o desafio, utilize este endpoint para confirmar ou não a sua identidade.
stable scope: card.network.transactions.3ds.writeConsulte a lista de chaves de endereçamento vinculadas a uma conta de pagamento.
stable scope: pix.account.readCadastre até cinco chaves para contas com titular pessoa física e vinte chaves para contas com titular pessoa jurídica.
stable scope: pix.entries.createConsulte informações sobre a chave de endereçamento para a qual você realizará uma transferência Pix.
stable scope: pix.entries.readImportante! A chave a ser excluída não pode estar em um processo de reinvindicação. Se esse for o caso, é necessário aguardar o encerramento da disputa para realizar a exclusão.
stable scope: pix.entries.deleteCrie um pedido de portabilidade de chaves ou reivindique a posse para outra instituição.
stable scope: pix.claims.createAcompanhe as solicitações de reivindicação de posse ou portabilidade de chaves e verifique se há pedidos de reivindicação provenientes de outras instituições financeiras direcionados aos clientes dos parceiros Bankly.
stable scope: pix.claims.readRealize a confirmação de um pedido de reivindicação proveniente de outra instituição financeira para efetuar a doação de uma chave.
stable scope: pix.claims.confirmComplete o pedido de reivindicação de posse de chave assim que seu status estiver como CONFIRMED.
stable scope: pix.claims.completeSimule o reconhecimento de um pedido de reivindicação de portabilidade ou de posse de chaves por parte de outra instituição.
simulaçãoCancele um pedido de reivindicação de posse ou portabilidade de uma chave. Tanto o doador quanto o reivindicador poderão realizar o cancelamento, desde que o status do pedido de reivindicação esteja como WAITING_RESOLUTION.
stable scope: pix.claims.cancelRealize a devolução de valores recebidos via Pix. Importante! Para que uma devolução possa ocorrer, é necessário que a transação tenha acontecido dentro dos últimos 90 dias.
stable scope: pix.cashout.createPara emitir um QR Code, é necessário possuir uma chave no DICT registrada previamente.
stable scope: pix.qrcode.createRealize a emissão de um QR Code dinâmico. Para isso, é necessário possuir uma chave no DICT registrada previamente.
stable scope: pix.qrcode-dynamic-payment.createRealize a transferência de valores via TED entre contas pertencentes ao Bankly e do Bankly para contas de outras instituições financeiras.
stable scope: ted.cashout.createConsulte todas as TEDs realizadas a partir da conta informada.
stable scope: ted.cashout.readRealize a consulta específica de uma transferência via TED por meio de seu código de autenticação (authenticationCode).
Realize a validação por meio da linha digitável para verificar se o título está apto a ser pago.
stable scope: payment.validateConfirme o pagamento do título para que ele possa ser efetivado.
stable scope: payment.confirmConsulte todos os pagamentos (completados ou não) realizados por uma conta específica.
stable scope: payment.readConsulte todos os detalhes de um pagamento específico (completado ou não) por meio de seu código de autenticação (authenticationCode).
Obtenha uma lista de instituições financeiras e suas informações, como o ISPB, os produtos ofertados, o tipo de banco (se é folha, destino ou ambos), dentre outras.
stable scope: banklist.readproduct, será assumido o valor padrão TED. Confira a documentação [Listagem de instituições financeiras](/docs/listagem-bancos) para mais informações." } [/block]
- [Consulta de instituições financeiras por ISPB ou código bancário](https://docs.bankly.com.br/reference/getbank.md): Consulte informações sobre a instituição financeira através do ISPB ou código bancário.
- [Atualização de recorrência](https://docs.bankly.com.br/reference/patch_cards-invoices-recurrencies-recurrencyid.md): Atualize uma cobrança recorrente agendada previamente.
stable scope: recurrency.updateRealize o cancelamento de uma cobrança recorrente. Isso implicará a interrupção de todas as futuras cobranças recorrentes associadas à transação.
stable scope: recurrency.deleteRealize o agendamento de uma cobrança recorrente de acordo com as necessidades de seu cliente.
stable scope: recurrency.write