# BS2 - Documentações de APIs Documentation
> Documentation for BS2 - Documentações de APIs
Append .md to any documentation page URL to get its markdown version.
## Guides
- [Introdução](https://devs.bs2.com/docs/introducao.md)
- [Autenticação](https://devs.bs2.com/docs/autenticacao-cc.md)
- [Conta Corrente](https://devs.bs2.com/docs/conta_corrente.md)
- [Transferência](https://devs.bs2.com/docs/transferencia-cc.md)
- [Pagamentos](https://devs.bs2.com/docs/pagamento-cc.md)
- [Comprovantes](https://devs.bs2.com/docs/comprovantes-cc.md)
- [Webhook de Movimentações](https://devs.bs2.com/docs/webhook-de-movimentações.md): Notificamos os nossos clientes acerca das movimentações realizadas. Permitindo, através desta funcionalidade, que o mesmo realize, com autonomia, sua “Assinatura” para recebimento das informações de…
- [Faixa de Desconto](https://devs.bs2.com/docs/faixa-de-desconto.md)
- [Pix para Clientes](https://devs.bs2.com/docs/pix-direto.md)
- [Autenticação](https://devs.bs2.com/docs/autenticacao_pix.md)
- [Webhook do Pix](https://devs.bs2.com/docs/webhook-do-pix-copy.md)
- [Como exportar DNS](https://devs.bs2.com/docs/exportar-dns-pix.md)
- [Chaves Pix](https://devs.bs2.com/docs/chaves-pix.md)
- [Balde de Fichas](https://devs.bs2.com/docs/balde-de-fichas-pix.md)
- [Cobrança](https://devs.bs2.com/docs/cobranca-pix.md)
- [Pagamento](https://devs.bs2.com/docs/pagamento-copy.md)
- [Recebimento](https://devs.bs2.com/docs/recebimentos-pix.md)
- [QR Code](https://devs.bs2.com/docs/pix-qr-code.md)
- [Devolução](https://devs.bs2.com/docs/devolução-pix.md)
- [Restituição](https://devs.bs2.com/docs/restituições.md)
- [Comprovantes de Pagamento e Devolução](https://devs.bs2.com/docs/comprovantes-de-pagamento-e-devolução.md)
- [Tabelas](https://devs.bs2.com/docs/tabelas.md)
- [Onboarding](https://devs.bs2.com/docs/onboarding.md)
- [Autenticação](https://devs.bs2.com/docs/autenticação-20.md)
- [Cadastro de cliente](https://devs.bs2.com/docs/cadastro-de-cliente.md)
- [Consulta de status do cliente](https://devs.bs2.com/docs/consulta-a-status-do-cliente.md)
- [Upload de Arquivos](https://devs.bs2.com/docs/upload-de-arquivos.md)
- [Dúvidas frequentes](https://devs.bs2.com/docs/dúvidas-frequentes.md)
- [Participantes Indiretos](https://devs.bs2.com/docs/pix-para-indiretos.md)
- [Autenticação](https://devs.bs2.com/docs/autenticação-1.md)
- [Fluxo de liquidações](https://devs.bs2.com/docs/fluxo-de-liquidações.md)
- [Fluxo de envio de Pix](https://devs.bs2.com/docs/fluxo-de-envio-de-pix.md)
- [Confirmação de pagamento](https://devs.bs2.com/docs/confirmação-de-pagamento.md)
- [Fluxo de recebimento de Pix](https://devs.bs2.com/docs/fluxo-de-recebimento-de-pix-1.md)
- [Fluxo de envio de Devolução](https://devs.bs2.com/docs/fluxo-de-envio-de-devolução.md)
- [Fluxo de recebimento de Restituição](https://devs.bs2.com/docs/fluxo-de-recebimento-de-restituição.md)
- [Webhooks para participantes indiretos](https://devs.bs2.com/docs/webhooks-para-participantes-indiretos.md)
- [Geração de QR CODEs](https://devs.bs2.com/docs/geração-de-qr-codes.md)
- [DICT - Diretório de Identificadores de contas transacionais](https://devs.bs2.com/docs/dict-diretório-de-identificadores-de-contas-transacionais.md)
- [Políticas de limitação de consulta à base DICT](https://devs.bs2.com/docs/políticas-de-limitação-de-consulta-à-base-dict.md)
- [Marcação de fraudes](https://devs.bs2.com/docs/marcação-de-fraudes.md)
- [Notificação de Infração](https://devs.bs2.com/docs/notificação-de-infração.md)
- [Reivindicação de Portabilidade e Posse](https://devs.bs2.com/docs/reivindicação-de-portabilidade-e-posse.md)
- [Verificação de sincronismo](https://devs.bs2.com/docs/verificação-de-sincronismo.md)
- [Conta Lastro](https://devs.bs2.com/docs/conta-lastro.md)
- [Mecanismo Especial de Devolução](https://devs.bs2.com/docs/mecanismo-especial-de-devolução.md)
- [Tabelas](https://devs.bs2.com/docs/dict.md)
- [Dúvidas frequentes](https://devs.bs2.com/docs/dúvidas-frequentes-1.md)
- [Boleto Híbrido](https://devs.bs2.com/docs/boleto_hibrido.md)
- [Autenticação](https://devs.bs2.com/docs/autenticação-2.md)
- [Webhook do Boleto Híbrido](https://devs.bs2.com/docs/webhook.md)
- [Emissão de Boleto Híbrido](https://devs.bs2.com/docs/emissão-de-bolepix.md)
- [Consulta de Boleto Híbrido](https://devs.bs2.com/docs/consulta-de-bolepix-1.md)
- [Cancelamento](https://devs.bs2.com/docs/cancelamento-de-bolepix.md)
- [Geração do Boleto Híbrido em PDF](https://devs.bs2.com/docs/bolepix-em-pdf.md)
- [Tabela](https://devs.bs2.com/docs/tabela.md)
- [Introduction](https://devs.bs2.com/docs/introduction.md)
- [Checking Account](https://devs.bs2.com/docs/checking_account.md)
- [Transfer](https://devs.bs2.com/docs/transfer-ca.md)
- [Payments](https://devs.bs2.com/docs/payments-ca.md)
- [Receipts/Proof of Payment](https://devs.bs2.com/docs/receiptsproof-payment-ca.md)
- [Discount Ranges](https://devs.bs2.com/docs/discount-ranges.md)
- [Onboarding](https://devs.bs2.com/docs/onboarding-1.md)
- [Authentication](https://devs.bs2.com/docs/authentication_.md)
- [Client Registration](https://devs.bs2.com/docs/client-registration.md)
- [Client Status Inquiry](https://devs.bs2.com/docs/client-status-inquiry.md)
- [Upload Files](https://devs.bs2.com/docs/upload-client-document-files.md)
- [Frequently Asked Questions](https://devs.bs2.com/docs/frequently-asked-questions.md)
- [Indirect participants](https://devs.bs2.com/docs/indirect-participants.md)
- [Authentication](https://devs.bs2.com/docs/authentication-pix.md)
- [Pix Flow (outgoing)](https://devs.bs2.com/docs/pix-flow.md)
- [Payment confirmation](https://devs.bs2.com/docs/payment-confirmation.md)
- [Pix (Incoming) Flow](https://devs.bs2.com/docs/pix-incoming-flow.md)
- [Refund Flow - Outgoing](https://devs.bs2.com/docs/refund-flow-outgoing.md)
- [Returns - Incoming Flow](https://devs.bs2.com/docs/returns-incoming-flow.md)
- [Webhooks for indirect participants](https://devs.bs2.com/docs/webhooks-for-indirect-participants.md)
- [Generating QR CODEs](https://devs.bs2.com/docs/generating-qr-codes.md)
- [DICT - Transactional Account Identifiers Directory](https://devs.bs2.com/docs/dict-indirect-participant.md)
- [DICT database query limitation policies](https://devs.bs2.com/docs/dict-database-query-limitation-policies.md)
- [Fraud identification](https://devs.bs2.com/docs/fraud-identification.md)
- [Infraction notification](https://devs.bs2.com/docs/infraction-notification.md)
- [Claiming Portability and Ownership](https://devs.bs2.com/docs/claiming-portability-and-ownership.md)
- [Synchronization check](https://devs.bs2.com/docs/synchronization-check.md)
- [Ballast account](https://devs.bs2.com/docs/ballast-account.md)
- [Special Refund Mechanism](https://devs.bs2.com/docs/special-refund-mechanism.md)
- [Tables](https://devs.bs2.com/docs/tables-indirect-participant.md)
- [Frequently asked questions](https://devs.bs2.com/docs/dúvidas-frequentes-copy.md)
## API Reference
- [Obter o saldo da conta](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-contascorrentes-saldo-1.md)
- [Obtém o extrato analítico](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-contascorrentes-extrato-analitico.md)
- [Obtém o extrato sintético](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-contascorrentes-extrato-sintetico.md)
- [Obter o extrato da conta (Legado)](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-contascorrentes-extrato-1.md)
- [Obter dados da conta baseado na autenticação](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-contascorrentes-dados-autenticacao-1.md)
- [Efetuar transferência para qualquer titularidade sem cadastro do favorecido](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-transferencias-simplificado-1.md)
- [Consultar os dados da transferência realizada](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-transferencias-solicitacaoid-1.md)
- [Consultar o status da solicitação de transferência](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-transferencias-solicitacoes-solicitacaoid-1.md)
- [Efetuar pagamento de título de cobrança/arrecadação pelo código de barras ou pela linha digitável](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-pagamentos-1.md)
- [Consultar título de cobrança/arrecadação pelo código de barras ou pela linha digitável](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-pagamentos-codigoidentificacao-1.md)
- [Consultar o status da solicitação de pagamento](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-pagamentos-solicitacoes-solicitacaoid-1.md)
- [Consultar comprovantes](https://devs.bs2.com/reference/get_pj-banking-forintegration-v2-comprovantes.md)
- [Gerar comprovante em PDF.](https://devs.bs2.com/reference/get_pj-banking-forintegration-v2-comprovantes-comprovanteid-imprimivel.md): O response é um byte[]
- [Criar assinatura](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-contascorrentes-webhook-1.md)
- [Obter assinatura](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-contascorrentes-webhook-1.md)
- [Cadastrar certificado](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-contascorrentes-webhook-assinaturaid-certificado-1.md)
- [Excluir assinatura](https://devs.bs2.com/reference/delete_pj-apibanking-forintegration-v1-contascorrentes-webhook-assinaturaid-1.md)
- [Emitir um novo boleto.](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v2-boletos-simplificado.md)
- [Emitir um novo boleto. (v3 - com faixas de desconto)](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v3-boletos-simplificado.md)
- [Listar boletos conforme os filtros informados.](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos.md)
- [Consultar os dados detalhados de um boleto. (por Id do boleto)](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-boletoid.md)
- [Consultar os dados detalhados de um boleto. (por Nosso número)](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-nossonumero.md)
- [Gerar versão imprimível de um boleto. (por Id do boleto)](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-boletoid-imprimivel.md)
- [Gerar versão imprimível de um boleto. (por Nosso número)](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-nossonumero-imprimivel.md)
- [Solicitar o cancelamento de um boleto. (por Id do boleto)](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-boletoid-solicitacoes-cancelamentos.md)
- [Solicitar o cancelamento de um boleto. (por Nosso número)](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-nossonumero-solicitacoes-cancelamentos.md)
- [Consultar o status de uma solicitação de cancelamento de boleto. (por Id do boleto)](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-boletoid-solicitacoes-cancelamentos-solicitacaoid.md)
- [Consultar o status de uma solicitação de cancelamento de boleto. (por Nosso número)](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-nossonumero-solicitacoes-cancelamentos-solicitacaoid.md)
- [Consultar o status de uma solicitação de alteração de boleto.](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-alteracoes-solicitacaoid.md)
- [Solicitar a alteração de um boleto. (Valor)](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-boletoid-alteracoes-valor.md)
- [Solicitar a alteração de um boleto. (Vencimento)](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-boletoid-alteracoes-vencimento.md)
- [Solicitar a alteração de um boleto. (Desconto)](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-boletoid-alteracoes-desconto.md)
- [Solicitar a alteração de um boleto. (Dados do pagador)](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-boletoid-alteracoes-dados-pagador.md)
- [Solicitar a alteração de um boleto. (Protesto)](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-boletoid-alteracoes-protesto.md)
- [Emissão de boleto com faixas de desconto](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v3-boletos-simplificado-1.md)
- [Emissão de boleto híbrido](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-boletos-hibridos.md): API para emissão de boletos híbridos, que permitem pagamento tanto via código de barras quanto QR Code Pix. Ideal para automatizar cobranças com múltiplas formas de pagamento em um único documento.
- [Listagem de boletos híbridos](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-boletos-hibridos.md): Retorna uma lista de boletos híbridos com base nos filtros informados.
- [Consulta de boleto híbrido](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-boletos-hibridos-id.md): Retorna os detalhes de um boleto híbrido a partir do seu identificador.
- [Cancelamento de boleto híbrido](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-boletos-hibridos-id.md): Envia uma solicitação de cancelamento para um boleto híbrido.
- [Obtenção do PDF do boleto híbrido](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-boletos-hibridos-id-pdf.md): Retorna o arquivo PDF de um boleto híbrido a partir do seu identificador.
- [Cadastro de webhook por evento](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-boletos-hibridos-webhook-1.md): Adiciona uma nova configuração de webhook para notificação por tipo de evento.
- [Atualização de webhook](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-boletos-hibridos-webhook-configuracaoid-1.md): Atualiza uma configuração de webhook existente.
- [Remoção de webhook](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-boletos-hibridos-webhook-configuracaoid-remover-1.md): Remove uma configuração de webhook existente.
- [Adição de certificado para o webhook](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-boletos-hibridos-webhook-certificado-1.md): Adiciona um certificado à configuração de webhook.
- [Realiza o cadastro completo de um cliente originado por parceiro.](https://devs.bs2.com/reference/post_pj-onboarding-v3-parceiros-cadastro-completo.md): Este endpoint recebe todos os dados necessarios para iniciar e concluir o fluxo de cadastro do cliente parceiro em uma unica chamada. A request e validada e encaminhada ao caso de uso responsavel…
- [Realiza o pre-cadastro de um cliente associado a um parceiro.](https://devs.bs2.com/reference/post_pj-onboarding-v3-parceiros-pre-cadastro.md): Este endpoint registra os dados iniciais do cliente parceiro e devolve a identificacao do cadastro para continuidade do fluxo. O processamento e delegado ao caso de uso de pre-cadastro, preservando o…
- [Consulta o status atual de um cadastro de cliente parceiro.](https://devs.bs2.com/reference/get_pj-onboarding-v3-parceiros-clientes-cadastroid-status.md): Este endpoint utiliza o identificador do cadastro para recuperar a situacao corrente do cliente no fluxo de onboarding. A resposta reflete o status consolidado retornado pelo caso de uso responsavel…
- [Recebe e associa um documento ao cadastro de um cliente parceiro.](https://devs.bs2.com/reference/post_pj-onboarding-v3-parceiros-cadastros-clientes-cadastroid-documentos.md): Este endpoint espera um envio multipart/form-data com o arquivo do documento e utiliza o cadastro informado na rota para vincula-lo ao cliente parceiro. O arquivo recebido e validado, convertido para…
- [Lista os clientes aptos para seguir a jornada de aniversário de conta.](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-aniversario-conta.md)
- [Consulta o status atual do cliente na jornada de aniversário de conta.](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-aniversario-conta-cpf-cpf.md)
- [Verificar se um cliente está apto a abrir conta no BS2.](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-verificar-documento-documento.md): Exemplo de query params: ?email=cliente@exemplo.com.br&telefone=%2B55-11-987654321
- [Cadastra um cliente no BS2.](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cadastrar.md)
- [Verificar status da proposta.](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-status-proposta-documento.md)
- [Atualiza os dados de profissão do cliente identificado pelo CPF.](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cpf-profissao.md)
- [Atualiza o apelido cadastrado do cliente identificado pelo CPF.](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cpf-apelido.md)
- [Atualiza o estado civil do cliente identificado pelo CPF.](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cpf-estado-civil.md)
- [Atualiza o endereço residencial do cliente identificado pelo CPF.](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cpf-endereco-residencial.md)
- [Atualiza o endereço de correspondência do cliente identificado pelo CPF.](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cpf-endereco-correspondencia.md)
- [Atualiza a informação de portal fornecedor do cliente identificado pelo CPF.](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cpf-portal-fornecedor.md)
- [Atualiza os dados de renda do cliente identificado pelo CPF.](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cpf-renda.md)
- [Solicita a alteração do telefone do cliente identificado pelo CPF.](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cpf-telefone.md)
- [Solicita a alteração do e-mail do cliente identificado pelo CPF.](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cpf-email.md)
- [Consulta o saldo disponível do cliente para validar a possibilidade de encerramento da conta.](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-onboarding-parceiros-encerramento-cpf-saldo.md)
- [Registra a solicitação de encerramento da conta do cliente com controle de idempotência.](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-onboarding-parceiros-encerramento-cpf-solicitacao.md)
- [Atualiza um parceiro em múltiplos documentos na Proposta.](https://devs.bs2.com/reference/put_pj-apibanking-forintegration-v1-onboarding-parceiros-atualizar.md)
- [Autenticação - Gerar Access Token](https://devs.bs2.com/reference/post_auth-oauth-v2-token-1.md): # Autenticação - A autenticação das APIs Pix Direto Bs2 seguem o fluxo de autenticação OAuth 2.0 Client Credentials. - É necessário autenticar usando o clientId (API Key) e o secretKey (API…
- [Cobrança com vencimento - Criar cobrança](https://devs.bs2.com/reference/put_pix-direto-forintegration-v1-cobv-txid.md): Endpoint para criar uma cobrança com vencimento.
- [Cobrança com vencimento - Revisar](https://devs.bs2.com/reference/patch_pix-direto-forintegration-v1-cobv-txid.md)
- [Cobrança - Revisar](https://devs.bs2.com/reference/patch_pix-direto-forintegration-v1-cob-txid.md)
- [Cobrança - Criar por Id da transação](https://devs.bs2.com/reference/put_pix-direto-forintegration-v1-cob-txid.md): Atualmente no payload da response desta API não é retornada a informação do QRCode, em decorrência disto é aconselhada a utilização do endpoint desenvolvido no modelo do BS2, disponibilizado no menu…
- [Cobrança - Consultar por TxId](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-cob-txid.md)
- [Cobrança - Criar cobrança](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-cob.md): Atualmente no payload da response desta API não é retornada a informação do QRCode, em decorrência disto é aconselhada a utilização do endpoint desenvolvido no modelo do BS2, disponibilizado no menu…
- [Cobrança - Consultar lista de cobranças](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-cob.md)
- [Devolução - Solicitar](https://devs.bs2.com/reference/put_pix-direto-forintegration-v1-pix-e2eid-devolucao-idexterno.md): **Pré-requisitos:** - Um pix recebido nos ultimos 90 dias. - A consulta de recebimentos pode ser realizada na rota [Recebimentos -…
- [Devolução - Consultar](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pix-e2eid-devolucao-idexterno.md)
- [Recebimento - Consultar por e2eid](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pix-e2eid.md)
- [Recebimento - Consultar](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pix.md)
- [Pagamento - Consultar](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pagamentos.md): **Características:** - Somente será possível realizar a consulta dos pagamentos PIX feitos por meio de APIs, mediante seleção do dia a ser consultado e não mais por período. - O intervalo máximo…
- [Pagamento - Consultar - PagamentoId](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pagamentos-pagamentoid.md): **Pré-requisitos:** Um pagamentoId gerado por um dos seguintes fluxos de iniciação de pagamentos: - [Iniciação de pagamento por…
- [Pagamento - Consultar - EndToEndId](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pagamentos-endtoendid-endtoendid.md): **Pré-requisitos:**
Um EndToEndId gerado por um dos seguintes fluxos de iniciação de pagamentos:
- [Iniciação de pagamento por…
- [Pagamento - Iniciar - QrCodes](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-pagamentos-qrcodes.md): **Pré-requisitos:** Um qrcode gerado que não seja da sua própria conta. **Características:** - Realiza a validação das propriedades do qrcode. - Inicia o procedimento de pagamento. - Para…
- [Pagamento - Iniciar - Chaves](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-pagamentos-chave.md): **Pré-requisitos:** Uma chave pix que não seja da sua própria conta. **Características:** - Realiza a verificação da existência da chave pix. - Inicia o procedimento de pagamento. - Para…
- [Pagamento - Iniciar - Manual](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-pagamentos-manual.md): **Pré-requisitos:** Os dados bancários do contraparte. **Características:** - Realiza a validação dos dados bancários do contraparte. - Inicia o procedimento de pagamento. - Para completar o…
- [Pagamento - Confirmar](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-pagamentos-pagamentoid-confirmacao.md): **Pré-requisitos:** Uma solicitação de pagamento iniciada em algum dos seguintes procedimentos: - [Iniciação de pagamento por…
- [Pagamento - Cancelar](https://devs.bs2.com/reference/patch_pix-direto-forintegration-v1-pagamentos-pagamentoid-cancelar.md): **Pré-requisitos:** Um pagamento retido para análise, com status ```CONFIRMADO```. **Características:** - Permite realizar o cancelamento de um pagamento que foi confirmado mas foi retido para…
- [Pagamento - Solicitar pagamento](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-pagamentos-chave-solicitacoes.md): **Solicitar pagamento assíncrono** - Fluxo de pagamento assíncrono. - Usando este endpoint, o Bs2 irá gerenciar o fluxo de pagamento executando validação de chaves, iniciação de pagamento e…
- [Pagamento - Consultar solicitacao por SolicitacaoId](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pagamentos-chave-solicitacoes-solicitacaoid.md): Obtém detalhes de uma solicitacao de pagamento
- [Pagamentos - Consultar - Restituições](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pagamentos-endtoendidorigem-restituicoes.md)
- [Pagamentos - Consultar - Restituição](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pagamentos-restituicoes-rtrid.md)
- [QR Code - Consultar](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-qrcodes.md)
- [Qr Code - Estático - Criar](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-qrcodes-estatico.md): Realiza a criação de um novo qr code estático. **Caracteristicas:** - Pode ser pago mais de uma vez. - Não expira. - Seu status pode ser consultado em [Qr Code -…
- [Qr Code - Dinâmico - Criar](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-qrcodes-dinamico.md): Realiza a criação de um novo qr code dinâmico. **Caracteristicas:** - Pode ser pago apenas uma vez. - Expira. - Deve ser parâmetrizado com um identificador único "txId" do cliente para fins de…
- [Qr Code - Dinâmico com Vencimento - Criar](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-qrcodes-dinamico-vencimento-txid.md): Realiza a criação de um novo qr code dinâmico. **Caracteristicas:** - Pode ser pago apenas uma vez. - Vence, significando que pode ser pago após o vencimento e as parametriações de juros e multas…
- [Qr Code - Dinâmico com Vencimento - Criar](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-qrcodes-dinamico-vencimento.md): Realiza a criação de um novo qr code dinâmico. **Caracteristicas:** - Pode ser pago apenas uma vez. - Vence, significando que pode ser pago após o vencimento e as parametriações de juros e multas…
- [QR Code - Desativar](https://devs.bs2.com/reference/delete_pix-direto-forintegration-v1-qrcodes-qrcodeid.md)
- [QR Code - Dinâmico com Vencimento - Alterar.](https://devs.bs2.com/reference/put_pix-direto-forintegration-v1-qrcodes-txid-dinamico-vencimento.md)
- [QR Code - Dinâmico - Alterar.](https://devs.bs2.com/reference/put_pix-direto-forintegration-v1-qrcodes-qrcodeid-dinamico.md)
- [Recebimento - Consultar por parâmetros](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-recebimentos.md): **Pré-requisitos:** - Ter recebido um pix por chave. - Para receber por chave pix basta cadastrar uma chave na plataforma web. - Ter recebido um pix manual. - Para receber manualmente, basta…
- [Recebimento - Consultar por EndToEndId](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-recebimentos-endtoendid-recebimento.md)
- [Recebimento - Consultar por RecebimentoId](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-recebimentos-recebimentoid.md)
- [Recebimento - Consultar por QrCodeId](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-recebimentos-qrcode-qrcodeid.md)
- [Webhook - Obter](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-webhook-bs2.md): **Pré-requisitos:** - Um webhook configurado. **Características:** - Obtem os webhook que foram configurados na sua conta.
- [Webhook - Criar/Atualizar](https://devs.bs2.com/reference/put_pix-direto-forintegration-v1-webhook-bs2.md): **Pré-requisitos:** - Uma rota acessível na internet para receber os eventos de webhook. **Características:** - Realiza uma chamada para a rota configurada de acordo com a realização do evento…
- [Webhook - Certificado - Inclusão/Atualização](https://devs.bs2.com/reference/put_pix-direto-forintegration-v1-webhook-bs2-certificado.md): **Pré-requisitos:** - Certificado X.509 codificado em base64 da rota do seu webhook (Arquivo *.cer). **Características:** - Realiza o cadastro/atualização do certificado da rota do webhook…
- [Webhook - Certificado - Inclusão/Atualização](https://devs.bs2.com/reference/put_pix-direto-forintegration-v1-webhook-bs2-configuracaoid-certificado.md): **Pré-requisitos:** - Certificado X.509 codificado em base64 da rota do seu webhook (Arquivo *.cer). **Características:** - Realiza o cadastro/atualização do certificado da rota do webhook…
- [Webhook - Excluir](https://devs.bs2.com/reference/delete_pix-direto-forintegration-v1-webhook-bs2-configuracaoid.md): **Pré-requisitos:** - Um webhook configurado. - O Id da configuração do seu webhook pode ser obtido em [Webhook - Obter](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-webhook-bs2)…
- [TokenBucket - Obter](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-chaves-token-bucket-situacao.md): Endpoint para verificar a posição atual do meu balde de fichas. **Características** - Obtem situação atual do balde de fichas, de acordo com parâmetros pré-configurados.
- [Comprovantes - Solicitar Comprovantes](https://devs.bs2.com/reference/post_pix-direto-forintegration-v1-pix-comprovantes.md): API assíncrona para solicitação de comprovantes . **Pré-requisitos:** - Evento de webhook de comprovantes configurado. **Características:** - Cliente receberá um webhook com um link que permitirá…
- [Endpoint para receber Webhook de Devolução Efetuada](https://devs.bs2.com/reference/post_bs2-pix-direto-webhook-mock-devolucao.md): **Características:**
- Endpoint que deve ser implementado pelo cliente para receber Webhook de Devolução Efetuada.
**Requisitos:**
Realizar a configuração/cadastro do Webhook no Contexto do PIX…
- [Endpoint para receber Webhook de Falha de pagamento realizado no fluxo assíncrono](https://devs.bs2.com/reference/post_bs2-pix-direto-webhook-mock-falha-pagamento-async.md): **Características:**
- Endpoint que deve ser implementado pelo cliente para receber Webhook de Falha no pagamento realizado no fluxo assíncrono.
**Requisitos:**
Realizar a configuração/cadastro do…
- [Endpoint para receber Webhook de Pagamento efetivado no fluxo síncrono](https://devs.bs2.com/reference/post_bs2-pix-direto-webhook-mock-pagamento.md): **Características:**
- Endpoint que deve ser implementado pelo cliente para receber Webhook de Pagamento efetivado no fluxo síncrono.
**Requisitos:**
Realizar a configuração/cadastro do Webhook no…
- [Endpoint para receber Webhook de Pagamento em analise](https://devs.bs2.com/reference/post_bs2-pix-direto-webhook-mock-pagamento-retido-para-analise.md): **Características:**
- Endpoint que deve ser implementado pelo cliente para receber Webhook de Pagamento retido para analise.
**Requisitos:**
Realizar a configuração/cadastro do Webhook no…
- [Endpoint para receber Webhook de Recebimento](https://devs.bs2.com/reference/post_bs2-pix-direto-webhook-mock-recebimento.md): **Características:**
- Endpoint que deve ser implementado pelo cliente para receber Webhook de Recebimento.
**Requisitos:**
Realizar a configuração/cadastro do Webhook no Contexto do PIX Direto
- [Endpoint para receber Webhook de comprovante](https://devs.bs2.com/reference/post_bs2-pix-direto-webhook-mock-solicitar-comprovante.md): **Características:**
- Endpoint que deve ser implementado pelo cliente para receber Webhook de Solicitação de comprovante.
**Requisitos:**
Realizar a configuração/cadastro do Webhook no Contexto…
- [Endpoint para receber Webhook de limite do TokenBucket](https://devs.bs2.com/reference/post_bs2-pix-direto-webhook-mock-token-bucket-limit.md): **Características:**
- Endpoint que deve ser implementado pelo cliente para receber Webhook de limite do token bucket.
**Requisitos:**
Realizar a configuração/cadastro do Webhook no Contexto do…
- [Listar restituições](https://devs.bs2.com/reference/get_core2-pix-indireto-pagamentos-endtoendid-restituicoes.md)
- [Obter restituição](https://devs.bs2.com/reference/get_core2-pix-indireto-pagamentos-endtoendid-restituicoes-returnid.md)
- [Iniciação de pagamento por chave Pix.](https://devs.bs2.com/reference/post_core2-pix-indireto-pagamentos-chave-pix.md): A data de agendamento será utilizada para criação do EndToEndId e deve conter Ano, Mês, Dia, Hora e Minuto e estar em formato UTC.
Há possibilidade de passar um EndToEndId que será considerado…
- [Iniciação de pagamento por chave pix manual.](https://devs.bs2.com/reference/post_core2-pix-indireto-pagamentos-chave-pix-manual.md): Possibilita que a consulta de chave seja realizada antes da iniciação do pagamento.
A data de agendamento será utilizada para criação do EndToEndId e deve conter Ano, Mês, Dia, Hora e Minuto e…
- [Iniciação de pagamento open finance.](https://devs.bs2.com/reference/post_core2-pix-indireto-pagamentos-servico-iniciacao.md): A data de agendamento será utilizada para criação do EndToEndId e deve conter Ano, Mês, Dia, Hora e Minuto e estar em formato UTC.
Há possibilidade de passar um EndToEndId que será considerado…
- [Iniciação de pagamento open finance manual.](https://devs.bs2.com/reference/post_core2-pix-indireto-pagamentos-servico-iniciacao-manual.md): Possibilita que a consulta de chave seja realizada antes da iniciação do pagamento.
A data de agendamento será utilizada para criação do EndToEndId e deve conter Ano, Mês, Dia, Hora e Minuto e estar…
- [Iniciação de pagamento por dados manuais.](https://devs.bs2.com/reference/post_core2-pix-indireto-pagamentos-dados-manuais.md): A data de agendamento será utilizada para criação do EndToEndId e deve conter Ano, Mês, Dia, Hora e Minuto e estar em formato UTC.
Há possibilidade de passar um EndToEndId que será considerado…
- [Iniciação de pagamento por QRCode.](https://devs.bs2.com/reference/post_core2-pix-indireto-pagamentos-qr-code.md): A data de agendamento será utilizada para criação do EndToEndId e deve conter Ano, Mês, Dia, Hora e Minuto e estar em formato UTC.
Há possibilidade de passar um EndToEndId que será considerado…
- [Iniciação de pagamento por QRCode manual.](https://devs.bs2.com/reference/post_core2-pix-indireto-pagamentos-qr-code-manual.md): Possibilita que a consulta de chave seja realizada antes da iniciação do pagamento.
A data de agendamento será utilizada para criação do EndToEndId e deve conter Ano, Mês, Dia, Hora e Minuto e…
- [Confirmação de um pagamento](https://devs.bs2.com/reference/post_core2-pix-indireto-pagamentos-pagamentoid-confirmacao.md): Para pagamentos agendados a confirmação do pagamento deve ser realizada somente no dia do agendamento/liquidação.
- [Cancelamento de uma iniciação de pagamento](https://devs.bs2.com/reference/patch_core2-pix-indireto-pagamentos-pagamentoid-cancelamento.md)
- [Obter pagamento](https://devs.bs2.com/reference/get_core2-pix-indireto-pagamentos.md)
- [Listar QRCodes/cobranças](https://devs.bs2.com/reference/get_pix-indireto-qrcode.md)
- [Criar Qr Code Estático](https://devs.bs2.com/reference/post_pix-indireto-qrcode-estatico.md): Realiza a criação de um novo qr code estático
Caracteristicas: