# BS2 - Documentações de APIs Documentation > Documentation for BS2 - Documentações de APIs ## 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 movimentações e de sua URL que receberá tais notificações. - [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 a 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 e registro do boleto na CIP.](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v2-boletos-simplificado-1.md) - [Realizar a busca de boletos gerados a partir de uma série de filtros.](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-1.md) - [Obter detalhe do boleto pelo código de identificação.](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-boletoid-1.md) - [Obter detalhe do boleto pelo campo nosso numero](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-nossonumero-1.md) - [Obter boleto imprimível pelo código de identificação.](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-boletoid-imprimivel-1.md) - [Obter boleto imprimível pelo campo nosso número.](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-nossonumero-imprimivel-1.md) - [Solicitar novo vencimento do boleto pelo nosso número.](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-nossonumero-solicitacoes-novosvencimentos-1.md) - [Solicitar novo vencimento do boleto pelo código identificador.](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-boletoid-solicitacoes-novosvencimentos-1.md) - [Obter detalhe da solicitação de novo vencimento do boleto pelo nosso número do boleto e código da solicitação.](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-nossonumero-solicitacoes-novosvencimentos-solicitacaoid-1.md) - [Obter detalhe da solicitação de novo vencimento do boleto pelo código identificador do boleto e código da solicitação.](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-boletoid-solicitacoes-novosvencimentos-solicitacaoid-1.md) - [Solicitar o cancelamento do boleto pelo código identificador.](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-boletoid-solicitacoes-cancelamentos-1.md) - [Solicitar o cancelamento do boleto pelo campo nosso número.](https://devs.bs2.com/reference/post_pj-forintegration-cobranca-v1-boletos-nossonumero-solicitacoes-cancelamentos-1.md) - [Obter detalhe da solicitação de cancelamento do boleto pelo código identificador do boleto e o código da solicitação.](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-boletoid-solicitacoes-cancelamentos-solicitacaoid-1.md) - [Obter detalhe da solicitação de cancelamento do boleto pelo nosso número do boleto e código da solicitação.](https://devs.bs2.com/reference/get_pj-forintegration-cobranca-v1-boletos-nossonumero-solicitacoes-cancelamentos-solicitacaoid-1.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-1.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-1.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-1.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-1.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-1.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. - [Pré-cadastro de Clientes](https://devs.bs2.com/reference/post_pj-onboarding-v1-fluxos-bs2pj-parceiros-cadastros-clientes.md) - [Cadastro Completo de Clientes](https://devs.bs2.com/reference/post_pj-onboarding-v1-fluxos-bs2pj-parceiros-cadastros.md) - [Consulta de Status](https://devs.bs2.com/reference/get_pj-onboarding-v1-fluxos-bs2pj-parceiros-cadastros-clientes-clienteid-status.md) - [Upload Arquivo](https://devs.bs2.com/reference/post_pj-onboarding-v1-fluxos-bs2pj-parceiros-cadastros-clientes-clienteid-documentos.md) - [Clientes](https://devs.bs2.com/reference/clientes.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-1.md) - [Cadastra um cliente no BS2.](https://devs.bs2.com/reference/post_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-cadastrar-1.md) - [Verificar status da proposta.](https://devs.bs2.com/reference/get_pj-apibanking-forintegration-v1-onboarding-parceiros-clientes-status-proposta-documento-1.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 Secret) obtidos através da do API Banking na plataforma Bs2 Empresas. (Consulte detalhes sobre a obtenção das chaves de API em [Criação das chaves API](https://devs.bs2.com/docs/primeirospassos#cria%C3%A7%C3%A3o-das-chaves-api)) - Uma autenticação bem-sucedida irá gerar o `access_token` (token de acesso), necessário para realização das requisições API Pix Direto Bs2. ## Gerenciamento de Token O `access_token` possui tempo para expiração. Ao gerar um novo token, a validade será apresentada no campo `expires_in` (em segundos) |Ambiente|`expires_in`| |--|--| | Homologação | 420 segundos | |Produção|300 segundos| Para uma operação saudável, é fundamental implementar a gestão do `access_token` utilizado pela sua aplicação, garantindo a validade do `access_token` utilizado nas requisições realizadas. ## Token de Autenticação > Para usar a API é necessário obter o token `Bearer` de autenticação. Para e emissão do token de acesso reproduza os seguintes passos: 1.1 Preparar uma requisição `Basic Auth` com método HTTP POST no endpoint `/auth/oauth/v2/token` 1.2 Definir o valor `client_credentials` para a chave `grant_type` (--data-urlencode) 1.3 Definir as permissões de acesso desejados, declarando o valor para da chave `scope`, de acordo com os escopos gerados na [Criação das chaves API](https://devs.bs2.com/docs/primeirospassos#cria%C3%A7%C3%A3o-das-chaves-api)(--data-urlencode) [Vide tabela **Permissões** abaixo] 1.4 Inserir autorização no Header Authorization ('Basic '+ encode base64 do clientId and secretKey separados por dois pontos) > POST /auth/oauth/v2/token ### Exemplo - REQUEST ```json curl --location --request POST 'https://example.bancobonsucesso.com.br/auth/oauth/v2/token' \ --header 'Authorization: Basic bDdkNWQ3OTg1ZDMxMTE0Y2NjYTgzMjlmZWVkZDQ3N2E0NTpmNjBjYzVjMzIxNDA0Y2UyOWQ4Mjg5NGVmNmEzZWI1Ng==' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'grant_type=client_credentials' \ --data-urlencode 'scope=cob.write cob.read dict.write dict.read webhook.read webhook.write pix.read pix.write' ``` ### Exemplo - RESPONSE ```json { "access_token": "36ee37ec-a475-4068-8f6e-e08dd2b8880d", "token_type": "Bearer", "expires_in": 420, "scope": "cob.write cob.read dict.write dict.read webhook.read webhook.write pix.read pix.write" } ``` ## Pontos Importantes - O campo `expires_in` apresenta a validade do token em segundos. Enquanto o token estiver válido, este token poderá ser utilizado para a realização das requisições. - Quando o token estiver próximo da validade, deve-se gerar um novo token, para assim, receber um novo token valido, garantindo a gestão do token e fluxo das requisições. - Não há limite de requisições por token. - [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 "Recebimentos".

Caso seja do interesse do cliente a utilização desta API, para obtenção do QRCode é necessário criá-lo seguindo orientações do BACEN

https://www.bcb.gov.br/estabilidadefinanceira/pix - [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 "Recebimentos".

Caso seja do interesse do cliente a utilização desta API, para obtenção do QRCode é necessário criá-lo seguindo orientações do BACEN

https://www.bcb.gov.br/estabilidadefinanceira/pix - [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 - Consultar](#tag/Recebimentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1recebimentos/get) **Características:** - Solicita uma operação de devolução para o valor recebido. - A devolução desse valor pode ser parcial. - A devolução pode ser realizada N vezes até que o valor total devolvido seja igual ao recebido. - O status da devolução pode ser consultado em [Devolução - Consultar](#tag/Devolucoes-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pix~1{e2eid}~1devolucao~1{idExterno}/get) - Uma devolução pode ser recusada caso não exista saldo na conta ou o contraparte rejeita a operação. - [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 entre Início e Fim deve ser de 1 dia - [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 chave](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1chave/post) - [Iniciação de pagamento por qrcode](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1qrcodes/post) - [Iniciação de pagamento manual](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1manual/post) **Características:** - Realiza a consulta do estado e dados do pagamento. - Pode ser usado no mecanismo de pooling para conciliação. - [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 chave](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1chave/post) - [Iniciação de pagamento por qrcode](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1qrcodes/post) - [Iniciação de pagamento manual](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1manual/post) **Características:** - Realiza a consulta do estado e dados do pagamento. - Pode ser usado no mecanismo de pooling para conciliação. - [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 completar o pagamento é necessário que você realize a confirmação dele em [Pagamento - Confirmar](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1{pagamentoId}~1confirmacao/post). - Permite informar o pagamentoId para utilização como identificador externo e se informado, caso o pagamentoId já tenha sido utilizado, não inicia um novo pagamento devolvendo uma resposta idempotente. - [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 completar o pagamento é necessário que você realize a confirmação dele em [Pagamento - Confirmar](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1{pagamentoId}~1confirmacao/post). - Permite informar o pagamentoId para utilização como identificador externo e se informado, caso o pagamentoId já tenha sido utilizado, não inicia um novo pagamento devolvendo uma resposta idempotente. - [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 é necessário que você realize a confirmação dele em [Pagamento - Confirmar](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1{pagamentoId}~1confirmacao/post). - Permite informar o pagamentoId para utilização como identificador externo e se informado, caso o pagamentoId já tenha sido utilizado, não inicia um novo pagamento devolvendo uma resposta idempotente. - [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 chave](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1chave/post) - [Iniciação de pagamento por qrcode](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1qrcodes/post) - [Iniciação de pagamento manual](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1manual/post) **Características:** - Realiza a validação dos dados do recebedor do pagamento. - Parametriza o valor à ser pago. - Solicita o pagamento para o contraparte através de uma solicitação. - Os dados do pagamento realizado podem ser consultados em [Pagamento - Consulta por PagamentoId](#tag/Pagamentos-Cliente/paths/~1pix~1direto~1forintegration~1v1~1pagamentos~1{pagamentoId}/get) - Ao ser debitado dispara um webhook sob o evento "Pagamento" com o EndToEndId retornado na iniciação de pagamento. Veja [Configurando webhook de pagamentos](#tag/Webhook-Cliente/paths/~1pix~1direto~1forintegration~1v1~1webhook~1bs2/put) > Atenção! > > Uma confirmação de pagamento significa que a sua intenção de realizar o pagamento foi encaminhada ao BACEN. > Qualquer solicitação de pagamento esta sujeita a cancelamento ou rejeição, cenário no qual o débito na conta não é realizado. - [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 analise. > Pagamentos confirmados, podem permanecer de 30 a 60 minutos em análise, ao realizar o cancelamento, significa que intenção de realizar o pagamento foi cancelada e o pagamento não será encaminhado para liquidação. - [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 confirmação de pagamento automaticamente para cada solicitação de pagamento. - É possível solicitar o pagamento para múltiplas chaves em uma única requisição. - A notificação por webhook (`Pagamento`), se configurada, ocorrerá quando a solicitação for confirmada com sucesso, enviada para liquidação e houver retorno do status final da transação. - Se o documento for informado no objeto validaRecebedor.Documento, o BS2 validará correspondencia entre o documento informado e o documento do vinculado a chave DICT informada na solicitação. Em caso de divergência, a solicitação será interrompida e um evento webhook FalhaPagamentoAsync será disparado (é necessário possuir o evento configurado para receber as notificações). - [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 - Consultar.](#tag/QR-Code-Cliente/paths/~1pix~1direto~1forintegration~1v1~1qrcodes/get) - Os dados do pagamento realizado podem ser consultados em [Cobrança - Consulta por TxId](#tag/Cobranca-Cliente/paths/~1pix~1direto~1forintegration~1v1~1cob~1{txId}/get) - Ao ser pago dispara um webhook sob o evento "Recebimento" porém sem o txId parametrizado. Veja [Configurando webhook de recebimentos](#tag/Webhook-Cliente/paths/~1pix~1direto~1forintegration~1v1~1webhook~1bs2/put) - [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 conciliação. - Seu status pode ser consultado em [Qr Code - Consultar.](#tag/QR-Code-Cliente/paths/~1pix~1direto~1forintegration~1v1~1qrcodes/get) - Os dados do pagamento realizado podem ser consultados em [Cobrança - Consulta por TxId](#tag/Cobranca-Cliente/paths/~1pix~1direto~1forintegration~1v1~1cob~1{txId}/get) - Ao ser pago dispara um webhook sob o evento "Recebimento" com o txId parametrizado. Veja [Configurando webhook de recebimentos](#tag/Webhook-Cliente/paths/~1pix~1direto~1forintegration~1v1~1webhook~1bs2/put) - [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 serão aplicadas. - Expira, significando que não poderá ser mais pago. - Deve ser parâmetrizado com um identificador único "txId" do cliente para fins de conciliação. - Seu status pode ser consultado em [Qr Code - Consultar.](#tag/QR-Code-Cliente/paths/~1pix~1direto~1forintegration~1v1~1qrcodes/get) - Os dados do pagamento realizado podem ser consultados em [Cobrança - Consulta por TxId](#tag/Cobranca-Cliente/paths/~1pix~1direto~1forintegration~1v1~1cob~1{txId}/get) - Ao ser pago dispara um webhook sob o evento "Recebimento" com o txId parametrizado. Veja [Configurando webhook de recebimentos](#tag/Webhook-Cliente/paths/~1pix~1direto~1forintegration~1v1~1webhook~1bs2/put) - [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 serão aplicadas. - Expira, significando que não poderá ser mais pago. - Deve ser parâmetrizado com um identificador único "txId" do cliente para fins de conciliação. - Seu status pode ser consultado em [Qr Code - Consultar.](#tag/QR-Code-Cliente/paths/~1pix~1direto~1forintegration~1v1~1qrcodes/get) - Os dados do pagamento realizado podem ser consultados em [Cobrança - Consulta por TxId](#tag/Cobranca-Cliente/paths/~1pix~1direto~1forintegration~1v1~1cob~1{txId}/get) - Ao ser pago dispara um webhook sob o evento "Recebimento" com o txId parametrizado. Veja [Configurando webhook de recebimentos](#tag/Webhook-Cliente/paths/~1pix~1direto~1forintegration~1v1~1webhook~1bs2/put) - [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 informar ao pagador os dados da sua conta bancária. - Ter recebido um pix por qrcode. - Para gerar um qrocde basta criar por uma das seguintes formas: - [Qr Code - Estático - Criar](#tag/QR-Code-Cliente/paths/~1pix~1direto~1forintegration~1v1~1qrcodes~1estatico/post) - [Qr Code - Dinâmico - Criar](#tag/QR-Code-Cliente/paths/~1pix~1direto~1forintegration~1v1~1qrcodes~1dinamico/post) - [Qr Code - Dinâmico com Vencimento - Criar](#tag/QR-Code-Cliente/paths/~1pix~1direto~1forintegration~1v1~1qrcodes~1dinamico-vencimento~1{txId}/post) **Características:** - Filtra recebimentos pix que foram recebidos no intervalo especificado. - Somente será possível realizar a consulta dos recebimentos 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 entre Início e Fim deve ser de 1 dia - [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 parametrizado. - Pode ser usado como mecanismo de conciliação. - Deve ser usado em conjunto à algum mecanismo de callback para conciliação referente ao evento configurado. - O disparo do webhook só começa a ocorrer após o cadastro do certificado do DNS da rota parametrizada. [Webhook - Certificado - Inclusão/Atualização](#tag/Webhook-Cliente/paths/~1pix~1direto~1forintegration~1v1~1webhook~1bs2~1certificado/put) **Eventos configuráveis para webhook** | Evento | Descrição | |-------------------------------|-------------------------------------------------------------| | Pagamento | Ocorre toda vez que um Pagamento Pix é realizado com sucesso. Notifica o status final do pagamento.
Fallback: [Consultar pagamento por pagamentoId](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pagamentos-pagamentoid) | | Recebimento | Ocorre toda vez que uma transação é recebida na conta configurada (Notifica Recebimento e Restituição).
Fallback: [Recebimento - Consultar por parâmetros](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-recebimentos) | | | DevolucaoEfetuada | Ocorre toda vez que uma Devolucao é realizada com sucesso. Notifica o status final da devolução.
Fallback: [Devolução - Consultar](https://devs.bs2.com/reference/get_pix-direto-forintegration-v1-pix-e2eid-devolucao-idexterno) | | PagamentoRetidoParaAnalise | Ocorre toda vez que um pagamento é retido para análise. | | TokenBucketLimit | Ocorre quando verificado baixo nivel de Tokens do cliente. | FalhaPagamentoAsync | Ocorre quando uma Solicitaçao de Pagamento é solicitada com um PagamentoId já utilizado anteriormente | | SolicitarComprovante | Ocorre quando um comprovante é solicitado | - [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 (Arquivo *.cer). - [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 (Arquivo *.cer). especificando a configuração de webhook ao qual o certificado se refere - [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) **Características:** - Realiza a exclusão do webhook configurado interrompendo o disparo dele. - [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á baixar o arquivo PDF do comprovante solicitado. - Podem ser solicitados até 20 comprovantes por requisição. - [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 Direto - [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 Webhook no Contexto do PIX Direto - [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 Contexto do PIX Direto - [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 Contexto do PIX Direto - [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 do PIX Direto - [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 PIX Direto - [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 caso não exista nenhum outro EndToEndId válido ou não for possível gerar um novo. - [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 estar em formato UTC. Há possibilidade de passar um EndToEndId que será considerado caso não exista nenhum outro EndToEndId válido ou não for possível gerar um novo. - [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 caso não exista nenhum outro EndToEndId válido ou não for possível gerar um novo. - [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 em formato UTC. Há possibilidade de passar um EndToEndId que será considerado caso não exista nenhum outro EndToEndId válido ou não for possível gerar um novo. - [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 caso não exista nenhum outro EndToEndId válido ou não for possível gerar um novo. - [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 caso não exista nenhum outro EndToEndId válido ou não for possível gerar um novo. - [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 estar em formato UTC. Há possibilidade de passar um EndToEndId que será considerado caso não exista nenhum outro EndToEndId válido ou não for possível gerar um novo. - [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:
- [Criar Qr Code Dinâmico](https://devs.bs2.com/reference/post_pix-indireto-qrcode-dinamico.md): Realiza a criação de um novo qr code dinâmico
Caracteristicas:
- [Criar Qr Code Dinâmico com Vencimento](https://devs.bs2.com/reference/post_pix-indireto-qrcode-dinamico-vencimento.md): Realiza a criação de um novo qr code dinâmico
Caracteristicas:
- [Desativar um Qr Code](https://devs.bs2.com/reference/delete_pix-indireto-qrcode-qrcodeid-desativar.md) - [Alterar informações de um Qr Code com vencimento](https://devs.bs2.com/reference/put_pix-indireto-qrcode-transactionid-dinamico-vencimento.md) - [Alterar informações de um Qr Code](https://devs.bs2.com/reference/put_pix-indireto-qrcode-qrcodeid-dinamico.md) - [Recupera um documento de cobrança a partir de um GUID](https://devs.bs2.com/reference/get_pix-indireto-spi-qrcode-identificadorlocation.md) - [Recupera um documento de cobrança com vencimento a partir de um GUID](https://devs.bs2.com/reference/get_pix-indireto-spi-qrcode-cobv-identificadorlocation.md) - [Listar devoluções](https://devs.bs2.com/reference/get_pix-indireto-recebimentos-endtoendid-devolucoes.md) - [Obter devolução](https://devs.bs2.com/reference/get_pix-indireto-recebimentos-endtoendid-devolucoes-returnid.md) - [Solicitar uma devolução](https://devs.bs2.com/reference/post_pix-indireto-recebimentos-endtoendid-devolucoes.md) - [Obter recebimento](https://devs.bs2.com/reference/get_pix-indireto-recebimentos.md) - [Endpoint para receber Webhook de Devolução Finalizada](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-devolucao-1.md): **Características:** - Endpoint que deve ser implementado pelo cliente para receber Webhook de Devolução Finalizada. **Requisitos:** Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto - [Endpoint para receber Webhook de atualizações na notificação de infração](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-notificacao-infracao-1.md): **Requisitos:** - Endpoint que deve ser implementado pelo cliente para receber Webhook de atualizações na notificação de infração. - Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto - [Endpoint para receber Webhook de Pagamento Finalizado](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-pagamento-1.md): **Requisitos:** - Endpoint que deve ser implementado pelo cliente para receber Webhook de Pagamento Finalizado. - Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto - [Endpoint para receber Webhook de Recebimento Finalizado](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-recebimento-1.md): **Características:** - Endpoint que deve ser implementado pelo cliente para receber Webhook de Recebimento Finalizado. **Requisitos:** Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto - [Endpoint para receber Webhook de atualizações na reivindicação de chave](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-reivindicacao-chave-1.md): **Requisitos:** - Endpoint que deve ser implementado pelo cliente para receber Webhook de atualizações na reivindicação de chave. - Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto - [Endpoint para receber Webhook de Restituição do Pagamento Finalizada](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-restituicao-1.md): **Requisitos:** - Endpoint que deve ser implementado pelo cliente para receber Webhook de Restituição do Pagamento Finalizada. - Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto - [Endpoint para receber Webhook de atualizações no sincronismo de chave](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-sincronismo-chave-1.md): **Requisitos:** - Endpoint que deve ser implementado pelo cliente para receber Webhook de atualizações no sincronismo de chave. - Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto - [Endpoint para receber Webhook de atualizações na solicitacao de devolução (MED)](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-solicitacao-devolucao-1.md): **Requisitos:** - Endpoint que deve ser implementado pelo cliente para receber Webhook de atualizações na solicitacao de devolução (MED). - Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto - [Webhook validação Recebimento - Cliente](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-recebimento-validacao-1.md): **Características:** - Endpoint que deve ser implementado pelo cliente para que a validação do recebimento seja realizada. - Valida se a(s) solicitações de recebimento(s) podem ser efetivadas. - Caso a(s) solicitações não possam ser efetivadas retorna uma lista de erros. - [Webhook validação Recebimento - Cliente](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-recebimento-validacao-csm-1.md): **Características:** - Endpoint que deve ser implementado pelo cliente para que a validação do recebimento seja realizada. - Valida se a(s) solicitações de recebimento(s) podem ser efetivadas. - Caso a(s) solicitações não possam ser efetivadas retorna uma lista de erros. - [Validação Síncrona da(s) Restituição(s) (Pagamento Restituido)](https://devs.bs2.com/reference/post_bs2-pix-indireto-webhook-mock-restituicao-validacao-1.md): **Requisitos:** - Endpoint que deve ser implementado pelo cliente para que a validação da Restituição seja recebida. - Valida se a(s) solicitações de Restituição(s) podem ser recebida/efetivada. - As validações devem respeitar o tempo de SLA regulamentado pelo Bacen para evitar a rejeição por timeout. - Caso a(s) solicitações não possam ser efetivadas retorna uma lista de erros. - [Cria uma marcação de fraude.](https://devs.bs2.com/reference/post_pix-indireto-dict-marcacao-fraude.md) - [Obtém detalhes de uma marcação de fraude.](https://devs.bs2.com/reference/get_pix-indireto-dict-marcacao-fraude-id.md) - [Cancela uma marcação de fraude.](https://devs.bs2.com/reference/post_pix-indireto-dict-marcacao-fraude-id-cancelar.md) - [Obtém dados estatísticos de um usuário final (liquidações, fraudes reportadas e fraudes confirmadas)](https://devs.bs2.com/reference/get_pix-indireto-dict-pessoa-documento.md) - [Obtém dados estatísticos relacionados a chaves registradas](https://devs.bs2.com/reference/get_pix-indireto-dict-chaves-chave.md) - [Consulta a existência de um conjunto de chaves no diretório de identificadores.](https://devs.bs2.com/reference/post_pix-indireto-dict-chave-existencia.md) - [Cria uma Solicitação de devolução.](https://devs.bs2.com/reference/post_pix-indireto-dict-devolucao.md): Apenas o participante debitado pode criar uma Solicitação de devolução. - [Obtém lista de solicitações de devolução em que o participante é parte.](https://devs.bs2.com/reference/get_pix-indireto-dict-devolucao.md) - [Obtém detalhes de uma solicitação de devolução.](https://devs.bs2.com/reference/get_pix-indireto-dict-devolucao-uuid.md) - [Cancela a Solicitação de devolução. Só pode ser realizada pelo participante que criou a solicitação.](https://devs.bs2.com/reference/post_pix-indireto-dict-devolucao-uuid-cancelamento.md):
Idempotência
A operação é idempotente. Caso a solicitação já tenha sido cancelada com os mesmos parâmetros, será retornada resposta equivalente à primeira requisição. - [Fecha a solicitação de devolução.](https://devs.bs2.com/reference/post_pix-indireto-dict-devolucao-uuid-fechamento.md): A solicitação só pode ser fechada pelo participante contestado. Para fechamento, o status deve ser `OPEN`.
Idempotência
A operação é idempotente. Caso a solicitação já tenha sido fechada com os mesmos parâmetros, será retornada resposta equivalente à primeira requisição. - [Obtém um vínculo contendo os detalhes de conta transacional associados a uma chave de endereçamento.](https://devs.bs2.com/reference/get_pix-indireto-dict-vinculo-chave.md): Limitação de requisições A consulta a chaves está sujeita à política de limitação (rate-limiting) de requisições. A limitação funciona com base em cabeçalhos enviados na requisição. Os cabeçalhos de requisição são obrigatórios para todos os tipos de chaves. O parâmetro `Documento` é o identificador do usuário final e é usado para aplicar as políticas de limitação com escopo de usuário. Deve ser preenchido com o CPF ou CNPJ (apenas dígitos), a depender do tipo da entidade titular da conta pagadora.
Estatísticas Através do parâmetro opcional `IncluirEstatisticas`, é possível indicar se as informações de contadores antifraude devem ou não ser incluídas na resposta. - [Atualiza um vínculo.](https://devs.bs2.com/reference/put_pix-indireto-dict-vinculo-chave.md):
A ser utilizado no cenário de atualização da informação da conta, nome e nome fantasia de um cliente, permanecendo este no mesmo PSP. Somente podem ser atualizadas as informações de conta do vínculo, nome e nome fantasia do cliente. Outras atualizações do vínculo devem ser feitas por exclusão/inclusão do vínculo, portabilidade ou reivindicação de posse, a depender da situação.
Restrições
As seguintes restrições devem ser obedecidas na atualização de vínculo, de acordo com o tipo de chave: Chaves `EVP` (aleatórias) - É permitida a alteração, porém, apenas com os motivos `BRANCH_TRANSFER` ou `RECONCILIATION`. Demais chaves - É permitida a alteração com os motivos `USER_REQUESTED`, `BRANCH_TRANSFER` ou `RECONCILIATION`. - [Cria um novo vínculo de chave com uma conta transacional.](https://devs.bs2.com/reference/post_pix-indireto-dict-vinculo.md):
Idempotência
A operação de criação de vínculo é idempotente. Isso significa que é seguro realizar uma nova tentativa em caso de falhas temporárias, como erros de conexão ou término abrupto de processos. A resposta retornada para uma requisição repetida é equivalente à resposta dada à primeira requisição processada.
Para garantir a idempotência da operação, a requisição tem um campo `RequestId`. Esse campo é um `UUID` versão 4 e deve ser único no contexto de um mesmo participante. O RequestId fica associado ao vínculo criado e é usado no cálculo do seu CID (ver seção de reconciliação na documentação).
Uma requisição de criação é considerada repetida quando o CID do vínculo contido na requisição já existe no DICT. Caso seja feita uma requisição com um `RequestId` previamente usado, mas com parâmetros diferentes para o vínculo, será retornado o erro `RequestIdAlreadyUsed`. - [Remove um vínculo de chave com conta.](https://devs.bs2.com/reference/post_pix-indireto-dict-vinculo-chave-remover.md) - [Cria uma notificação de infração.](https://devs.bs2.com/reference/post_pix-indireto-dict-infracao.md): Quando o objetivo da notificação de infração for solicitação de devolução, quem deve criar a notificação é o PSP do pagador da transação original. \ Para o cancelamento de devolução, quem deve criar é o PSP do recebedor da transação original. - [Obtém lista de notificações de infração em que o participante é parte.](https://devs.bs2.com/reference/get_pix-indireto-dict-infracao.md): Lista de notificações é ordenada de forma crescente pelo campo `LastModified`. - [Obtém detalhes de uma notificação de infração.](https://devs.bs2.com/reference/get_pix-indireto-dict-infracao-uuid.md) - [Notifica recebimento da notificação pelo participante contraparte.](https://devs.bs2.com/reference/post_pix-indireto-dict-infracao-uuid-recebimento.md):
Idempotência:
A operação é idempotente. Caso a notificação já tenha sido recebido e esteja ainda com status `ACKNOWLEDGED`, será retornada resposta equivalente à primeira requisição. - [Cancela a notificação de infração.](https://devs.bs2.com/reference/post_pix-indireto-dict-infracao-uuid-cancelamento.md): Só pode ser realizada pelo participante que criou a notificação. \ Para o cancelamento, o status deve ser `OPEN` ou `ACKNOWLEDGED`. \
Idempotência:
A operação é idempotente. Caso a notificação já tenha sido cancelada com os mesmos parâmetros, será retornada resposta equivalente à primeira requisição. - [Fecha a notificação de infração.](https://devs.bs2.com/reference/post_pix-indireto-dict-infracao-uuid-fechamento.md): Caso o fechamento seja com o resultado de análise `AGREED`, será gerada automaticamente uma marcação de fraude. \ O id constará no campo `FraudMarkerId` da resposta.
Idempotência:
A operação é idempotente. Caso a notificação já tenha sido fechada com os mesmos parâmetros, será retornada resposta equivalente à primeira requisição. - [Obtém a lista de políticas de limitação de acesso ao DICT para o participante requisitante.](https://devs.bs2.com/reference/get_pix-indireto-dict-limites.md):
Além da lista de políticas, o serviço informa também a categoria em que o participante se encontra, de acordo com a tabela presente no item `ENTRIES_READ_PARTICIPANT_ANTISCAN` da seção limitação de requisições da documentação do BCB.
Cada item da lista detém informações do estado do balde correspondente no momento da consulta. - [Obtém o estado atual do balde do participante para a política informada.](https://devs.bs2.com/reference/get_pix-indireto-dict-limites-politica-politica.md) - [Cria uma verificação de sincronismo para um participante e tipo de chave.](https://devs.bs2.com/reference/post_pix-indireto-dict-reconciliacao.md) - [Cria um arquivo contendo todos os CIDs de um determinado tipo de chave do participante.](https://devs.bs2.com/reference/post_pix-indireto-dict-reconciliacao-arquivo.md): O formato do arquivo é um CID por linha ('\n' como EOL), sem ordem definida. A geração do arquivo é feita assincronamente. - [Obtém detalhes do arquivo de CIDs requisitado.](https://devs.bs2.com/reference/get_pix-indireto-dict-reconciliacao-arquivo-id.md) - [Lista os eventos de CIDs para um tipo de chave do participante, ordenados de forma crescente por `Timestamp`.](https://devs.bs2.com/reference/get_pix-indireto-dict-reconciliacao-eventos.md): Observação: A atualização de informações de eventos de CIDs para listagens é assíncrona em relação às operações de inclusão e atualização de registros, sendo assim, é possível haver um retardo de 5 segundos até que os dados incluídos ou alterados constem na consulta. - [Obtém detalhes de um vínculo ativo identificado pelo CID.](https://devs.bs2.com/reference/get_pix-indireto-dict-reconciliacao-vinculo-cid.md) - [Cria uma nova reivindicação.](https://devs.bs2.com/reference/post_pix-indireto-dict-reivindicacao.md): Essa operação é feita pelo participante reivindicador a pedido do usuário final. \ O vínculo atual permanece inalterado, até que haja a confirmação pelo PSP doador. \ Nem todo tipo de chave pode ser reivindicado ou portado. - [Obtém uma lista de reivindicações, ordenada de forma crescente pelo campo ModificadaDepoisDe, de acordo com os filtros passados.](https://devs.bs2.com/reference/get_pix-indireto-dict-reivindicacao.md): Ao percorrer a lista em intervalos de tempo fechados, recomendável para que não se pule nenhum elemento, alguns elementos retornados poderão se repetir. O comportamento dos filtros isDonor e isClaimer, quando os valores passados são iguais, é disjuntivo: são retornadas reinvidicações em que o participante é doador OU reivindicador. A atualização de informações de reinvindicações para listagens é assíncrona em relação às operações de inclusão e atualização de registros, sendo assim, é possível haver um retardo de 5 segundos até que os dados incluídos ou alterados constem na consulta. - [Obtém detalhes de uma reivindicação.](https://devs.bs2.com/reference/get_pix-indireto-dict-reivindicacao-uuid.md) - [Notifica recebimento pelo participante doador de reivindicação com status OPEN.](https://devs.bs2.com/reference/post_pix-indireto-dict-reivindicacao-uuid-recebimento.md): Idempotência:
A operação é idempotente. Caso reivindicação já tenha sido recebida e ela esteja ainda com status \ `WAITING_RESOLUTION`, será retornada resposta equivalente à primeira requisição. - [Confirma a operação de reivindicação.](https://devs.bs2.com/reference/post_pix-indireto-dict-reivindicacao-uuid-confirmacao.md): Como consequência, vínculo da chave com participante doador é removido. Status deve estar em `WAITING_RESOLUTION`.
Para reivindicação de posse, caso razão seja `DEFAULT_OPERATION`, o prazo de resolução (`ResolutionPeriodEnd`) deve ter passado. Se a razão informada for `USER_REQUESTED`, o prazo de encerramento (`CompletionPeriodEnd`) será adiantado para permitir o encerramento imediato pelo reivindicador.
Idempotência
A operação é idempotente. Caso reivindicação já tenha sido confirmada com os mesmos parâmetros e esteja ainda com status `CONFIRMED`, será retornada resposta equivalente à primeira requisição. - [Cancela uma reivindicação.](https://devs.bs2.com/reference/post_pix-indireto-dict-reivindicacao-uuid-cancelamento.md):
Para reivindicação de posse, status deve ser `WAITING_RESOLUTION` ou `CONFIRMED`. Se razão de cancelamento for `DEFAULT_OPERATION`, prazo de validação de posse da chave do usuário reivindicador deve ter passado.
Para portabilidade, status também deve ser `WAITING_RESOLUTION` ou `CONFIRMED`. Se razão de cancelamento for `DEFAULT_OPERATION`, prazo definido pelo campo ResolutionPeriodEnd deve ter passado.
Idempotência
A operação é idempotente. Caso reivindicação já tenha sido cancelada com os mesmos parâmetros, será retornada resposta equivalente à primeira requisição. - [Conclui reivindicação pelo reivindicador.](https://devs.bs2.com/reference/post_pix-indireto-dict-reivindicacao-uuid-conclusao.md): Como consequência, vínculo da chave com participante reivindicador é criado.
Para reivindicação de posse, status deve ser `CONFIRMED` e prazo definido pelo campo `CompletionPeriodEnd` deve ter passado.
Para portabilidade, status deve ser `CONFIRMED`.
Idempotência
A operação de conclusão de reivindicação é idempotente. Valem aqui as mesmas considerações feitas descritas na operação de Criação de Vínculo. - [Token de Acesso](https://devs.bs2.com/reference/post_v1-auth-oauth2.md): Utilize esse endpoint para autenticação no sistema paycore.: - [Inserir Lançamento](https://devs.bs2.com/reference/post_v1-accounting-posting-create.md): Utilize esse endpoint para inserir um lançamento para uma loja: - [Somatória de vendas e valores pagos no período](https://devs.bs2.com/reference/post_v1-appseller-total.md): Utilize esse endpoint para listar os totais do lojista para o período selecionado: [p][b]OBSERVAÇÃO[/b] [p] Intervalo máximo de 90 dias entre a data de inicio e a data fim. [p] Será substituido pela data de hoje caso passe uma data maior que a data de hoje na data fim. - [Adicionar Campanha](https://devs.bs2.com/reference/post_v1-campanha-add.md): Utilize esse endpoint para gravar uma campanha: - [Campanha SubSeller](https://devs.bs2.com/reference/post_v1-campanha-subseller-update.md): Utilize esse endpoint para gerenciar campanha da loja: - [Obter HTML da carta de cancelamento](https://devs.bs2.com/reference/get_v1-cancellation-params.md): Utilize esse endpoint para o arquivo HTML da carta de cancelamento: - [Lista de Tabela de Preço](https://devs.bs2.com/reference/post_v1-combo-list.md): Utilize esse endpoint para listar a Tabela de Preço: - [Criar Tabela de Preço](https://devs.bs2.com/reference/post_v1-combo-create.md): Utilize esse endpoint para criar a Tabela de Preço: - [Lista de Configuração de Conexão](https://devs.bs2.com/reference/post_v1-connection-list.md): Utilize esse endpoint para listar a Configuração de Conexão: - [Criar Configuração de Conexão](https://devs.bs2.com/reference/post_v1-connection-create.md): Utilize esse endpoint para criar a Configuração de Conexão: - [Lista de Perfil Conexão](https://devs.bs2.com/reference/post_v1-connection-profile-list.md): Utilize esse endpoint para listar os Perfis de Conexão: - [Criar Perfil Conexão](https://devs.bs2.com/reference/post_v1-connection-profile-create.md): Utilize esse endpoint para criar os Perfis Conexão: - [Lista de Tipos de Agenda](https://devs.bs2.com/reference/get_v1-domain-tables-schedule-type-list.md): Utilize esse endpoint para listar os tipos de Agenda: - [Lista de Tipos de Lançamento](https://devs.bs2.com/reference/get_v1-domain-tables-accounting-posting-type-list.md): Utilize esse endpoint para listar os tipos de Lançamento: - [Lista de Tipos de Movimento](https://devs.bs2.com/reference/get_v1-domain-tables-movement-type-list.md): Utilize esse endpoint para listar os tipos de Movimento: - [Lista de Tabelas de Preços](https://devs.bs2.com/reference/get_v1-domain-tables-combo.md): Utilize esse endpoint para listar as tabelas de preços: - [Lista de Planos de Pagamento](https://devs.bs2.com/reference/get_v1-domain-tables-paymentplan.md): Utilize esse endpoint para listar os planos: - [Listar status da liquidação](https://devs.bs2.com/reference/get_v1-domain-tables-liquid-status.md): Utilize esse endpoint para listar os status da Liquidação: - [Listar tipos de transação](https://devs.bs2.com/reference/get_v1-domain-tables-transaction-type-list.md): Utilize esse endpoint para listar os tipos de transações: - [Listar CNAE](https://devs.bs2.com/reference/get_v1-domain-tables-cnae-list.md): Utilize esse endpoint para listar as Classificações Nacionais de Atividades Econômicas: - [Listar Natureza Jurídica](https://devs.bs2.com/reference/get_v1-domain-tables-legal-nature-list.md): Utilize esse endpoint para listar as Naturezas Jurídicas: - [Listar Portes de Empresa](https://devs.bs2.com/reference/get_v1-domain-tables-company-formation-list.md): Utilize esse endpoint para listar os Portes de Empresa: - [Listar bancos](https://devs.bs2.com/reference/get_v1-domain-tables-bank-list.md): Utilize esse endpoint para listar os Bancos: - [Listar CBO](https://devs.bs2.com/reference/get_v1-domain-tables-cbo-list.md): Utilize esse endpoint para listar os CBOs: - [Listar Modelo Terminal](https://devs.bs2.com/reference/get_v1-domain-tables-terminal-model-list.md): Utilize esse endpoint para listar os modelos de terminais: - [Listar tipos de descontos de tarifa](https://devs.bs2.com/reference/get_v1-domain-tables-discount-type-list.md): Utilize esse endpoint para listar os tipos de desconto de tarifa: - [Listar tipos de isenção de tarifa](https://devs.bs2.com/reference/get_v1-domain-tables-exemption-type-list.md): Utilize esse endpoint para listar os tipos de isenção de tarifa: - [Listar tipos de tarifa](https://devs.bs2.com/reference/get_v1-domain-tables-fare-type-list.md): Utilize esse endpoint para listar os tipos de tarifa: - [Listar tipos de contas bancárias](https://devs.bs2.com/reference/get_v1-domain-tables-bank-account-type-list.md): Utilize esse endpoint para listar os tipos de contas bancárias: - [Listar tipos de Bandeira por Produto](https://devs.bs2.com/reference/get_v1-domain-tables-brand-product-list.md): Utilize esse endpoint para listar os tipos de Bandeira por Produto para Onboarding: - [Listar tipos de Bandeira por Produto](https://devs.bs2.com/reference/get_v1-domain-tables-brand-product-listall.md): Utilize esse endpoint para listar os tipos de Bandeira por Produto: - [Listar tipos de Operadora de Terminais](https://devs.bs2.com/reference/get_v1-domain-tables-operator-list.md): Utilize esse endpoint para listar tipos de Operadora de Terminais: - [Listar Bandeiras](https://devs.bs2.com/reference/get_v1-domain-tables-brand-list.md): Utilize esse endpoint para listar as Bandeiras : - [Status da Transação](https://devs.bs2.com/reference/get_v1-domain-tables-transaction-status-list.md): Utilize esse endpoint para listar os status das transações: - [Categoria da Transação](https://devs.bs2.com/reference/get_v1-domain-tables-transaction-category-list.md): Utilize esse endpoint para listar as categorias das transações: - [Lista de Tipos de MCC](https://devs.bs2.com/reference/get_v1-domain-tables-mcc.md): Utilize esse endpoint para listar os tipos de MCC: - [Listar todos os tipos de sócios](https://devs.bs2.com/reference/get_v1-domain-tables-partner-type-list.md): Utilize esse endpoint para listar todos os tipos de sócios: - [Listar todos os usuários responsáveis](https://devs.bs2.com/reference/get_v1-domain-tables-cod-name-commercial.md): Utilize esse endpoint para listar todos os usuários responsáveis: - [Lista de Equipamento](https://devs.bs2.com/reference/post_v1-equipment-list.md): Utilize esse endpoint para listar os Equipamentos: - [Criar Equipamento](https://devs.bs2.com/reference/post_v1-equipment-create.md): Utilize esse endpoint para criar os Equipamentos: - [Vincular Equipamento](https://devs.bs2.com/reference/post_v2-equipment-maintenance-link-terminal-seller-document.md): Vincular um equipamento para uma loja, informando o Documento da Loja: - [Vincular Equipamento](https://devs.bs2.com/reference/post_v2-equipment-maintenance-link-terminal-seller-id.md): Vincular um equipamento para uma loja, informando o ID da Loja: - [Desvincular Equipamento](https://devs.bs2.com/reference/post_v2-equipment-maintenance-untie-terminal-seller-document.md): Desvincular um equipamento de uma loja, informando o Documento da Loja: - [Desvincular Equipamento](https://devs.bs2.com/reference/post_v2-equipment-maintenance-untie-terminal-seller-id.md): Desvincular um equipamento de uma loja informando o ID da Loja: - [Efetuar Troca de Equipamento](https://devs.bs2.com/reference/post_v2-equipment-maintenance-change-terminal-seller-document.md): Efetuar uma troca de equipamento para uma loja informando o Documento da Loja: - [Efetuar Troca de Equipamento](https://devs.bs2.com/reference/post_v2-equipment-maintenance-change-terminal-seller-id.md): Efetuar uma troca de equipamento para uma loja informando o ID da Loja: - [Efetuar Troca de SIM Card (Chip)](https://devs.bs2.com/reference/post_v2-equipment-maintenance-change-sim-card-seller-document.md): Efetuar uma troca de SIM Card (Chip) para um equipamento informando o Documento da Loja: - [Efetuar Troca de SIM Card (Chip)](https://devs.bs2.com/reference/post_v2-equipment-maintenance-change-sim-card-seller-id.md): Efetuar uma troca de SIM Card (Chip) para um equipamento informando o ID da Loja: - [Lista de Facilitador](https://devs.bs2.com/reference/post_v1-facilitator-list.md): Utilize esse endpoint para listar os Facilitadores: - [Atualizar Facilitador](https://devs.bs2.com/reference/post_v1-facilitator-update.md): Utilize esse endpoint para atualizar os dados do Facilitador: - [Lista de Taxa do Facilitador](https://devs.bs2.com/reference/post_v1-fee-facilitator-list.md): Utilize esse endpoint para listar as Taxas do Facilitador: - [Criar Taxa do Facilitador](https://devs.bs2.com/reference/post_v1-fee-facilitator-create.md): Utilize esse endpoint para criar a Taxa do Facilitador: - [Lista de Taxas da Loja](https://devs.bs2.com/reference/post_v2-fee-seller-list.md): Utilize esse endpoint para listar as Taxas da Loja: - [Criar Taxa da Loja](https://devs.bs2.com/reference/post_v2-fee-seller-create.md): Utilize esse endpoint para criar a Taxa da Loja: - [Lista de Personalização de Taxa](https://devs.bs2.com/reference/post_v1-fee-seller-custom-list.md): Utilize esse endpoint para listar a Personalização de Taxa: - [Criar Personalização de Taxa](https://devs.bs2.com/reference/post_v1-fee-seller-custom-create.md): Utilize esse endpoint para criar a Personalização de Taxa: - [Lista de Taxa do Subadquirente](https://devs.bs2.com/reference/post_v1-fee-subacquirer-list.md): Utilize esse endpoint para listar as Taxas do Subadquirente: - [Criar Taxa do Subadquirente](https://devs.bs2.com/reference/post_v1-fee-subacquirer-create.md): Utilize esse endpoint para criar as Taxas do Subadquirente: - [Lista de Pré Cadastro](https://devs.bs2.com/reference/post_v1-lead-seller-list.md): Utilize esse endpoint para listar os Pré Cadastros: - [Lista de terminais do pré cadastro](https://devs.bs2.com/reference/post_v1-lead-seller-terminal-list.md): Utilize esse endpoint para listar os terminais do pré cadastro: - [Listar Taxas por CNAE](https://devs.bs2.com/reference/post_v5-onboarding-cnae-fees-list.md): Utilize esse endpoint para listar as taxas pelo CNAE: - [Listar Pré-cadastro Loja](https://devs.bs2.com/reference/post_v5-onboarding-list.md): Utilize esse endpoint para listar os pré-cadastros das lojas: - [Pré-Cadastrar Loja PJ](https://devs.bs2.com/reference/post_v5-onboarding-pj.md): Utilize esse endpoint para pré-cadastro de pessoa jurídica: Para credenciamento de Lojas Presenciais deve ser preenchido o list de list_equipment_register Para precificação de terminal deve ser preenchido o list list_terminal_pricing Para caso de endereço de Entrega diferente do Fiscal, os campos de endereço de entrega devem ser preenchidos - [Pré-Cadastrar Loja PF](https://devs.bs2.com/reference/post_v5-onboarding-pf.md): Utilize esse endpoint para pré-cadastro de pessoa física. Para credenciamento de Lojas Presenciais deve ser preenchido o list de list_equipment_register. Para precificação de terminal deve ser preenchido o list list_terminal_pricing. Para caso de endereço de Entrega diferente do Fiscal, os campos de endereço de entrega devem ser preenchidos. - [Pré-Cadastrar Taxas Personalizadas](https://devs.bs2.com/reference/post_v5-onboarding-persontax.md): Utilize esse endpoint para solicitar taxas personalizadas: - [Concluir Cadastro](https://devs.bs2.com/reference/post_v5-onboarding-confirm.md): Utilize esse endpoint para concluir o cadastro e enviar para análise: - [Lista de Pedido](https://devs.bs2.com/reference/post_v1-order-list.md): Utilize esse endpoint para listar os Pedidos: - [Lista de Plano de Pagamento](https://devs.bs2.com/reference/post_v1-payment-plan-list.md): Utilize esse endpoint para listar os Planos de Pagamentos: - [Criar Plano de Pagamento](https://devs.bs2.com/reference/post_v1-payment-plan-create.md): Utilize esse endpoint para criar os Planos de Pagamentos: - [Lista de Transações](https://devs.bs2.com/reference/post_v1-payments-list.md): Utilize esse endpoint para listar as transações : - [Lista de Pagamentos](https://devs.bs2.com/reference/post_v1-transacao-list.md): Utilize esse endpoint para listar os Pagamentos: - [Cancelamento de transação](https://devs.bs2.com/reference/post_v1-transacao-cancellation.md): Utilize esse endpoint para cancelar uma transação parcialmente ou integralmente: - [Cancelamento de transação por PaymentID](https://devs.bs2.com/reference/post_v1-transacao-cancellation2.md): Utilize esse endpoint para cancelar uma transação parcialmente ou integralmente por PaymentID: - [Recebe os Domicílios Bancários ](https://devs.bs2.com/reference/post_v1-receive-bank-account-receive.md): Implemente essa interface em seu sistema para receber os domicílios bancários via webhook: - [Credenciais E-Commerce](https://devs.bs2.com/reference/post_v1-receive-credentials-credentials.md): Implemente essa interface em seu sistema para receber as credenciais do e-commerce para loja: - [Webhook Equipamento](https://devs.bs2.com/reference/post_v1-receive-equipament-seller-receive.md): # Introdução\r\n\r\n \r\nUtilize essa API para gerenciar os Equipamento: - [Recebe as Taxas das Lojas](https://devs.bs2.com/reference/post_v1-receive-fee-seller-receive.md): Implemente essa interface em seu sistema para receber as taxas para lojas via webhook: - [Recebe as Taxas das Lojas](https://devs.bs2.com/reference/post_v1-receive-fee-seller-custom-receive.md): Implemente essa interface em seu sistema para receber as personalizações de taxas para lojas via webhook: - [Webhook dos cadastros de terminais do pré cadastro](https://devs.bs2.com/reference/post_v1-receive-lead-seller-terminal-receive.md): Implemente essa interface em seu sistema para receber os terminais do pré cadastro via webhook: - [Transação](https://devs.bs2.com/reference/post_v2-receive-payments-receive.md): Implemente essa interface em seu sistema para receber as transações via push: - [Recebe Agendas ](https://devs.bs2.com/reference/post_v1-receive-schedule-receive.md): Implemente essa interface em seu sistema para receber as agendas via push: - [Recebe as Lojas](https://devs.bs2.com/reference/post_v1-receive-seller-receive.md): Implemente essa interface em seu sistema para receber as lojas via webhook: - [Webhook dos cadastros de terminal](https://devs.bs2.com/reference/post_v1-receive-terminal-receive.md): Implemente essa interface em seu sistema para receber os terminais credenciados via webhook: - [Webhook das relações de terminais com equipamento](https://devs.bs2.com/reference/post_v1-receive-terminal-equipament-receive.md): Implemente essa interface em seu sistema para receber as relações de terminais com equipamento via webhook: - [Simulador de vendas](https://devs.bs2.com/reference/post_v1-sales-simulator-gettransactioninformation.md): Utilize esse endpoint para simular uma venda: - [Extrato Sintético de Recebíveis - Pré Processado e Paginado](https://devs.bs2.com/reference/post_v1-schedule-ec-synthetic-statement.md): Utilize esse endpoint para listar o resumo de recebíveis das lojas: - [Extrato Analítico de Recebíveis](https://devs.bs2.com/reference/post_v1-schedule-receivables-analytic-statement.md): Utilize esse endpoint para listar o extrato analítico de recebíveis da loja : [p][b]INSTRUÇÕES[/b] [p] Utilize o filtro (date_init / date_end) ou ( schedule_date_init / schedule_date_end) ou transaction_id [p] [p] Caso seja fornecido (date_init / date_end) [span _ngcontent-c12=\"\" class=\"param-required\"](Máximo de 3 meses)[/span] será retornado apenas agendas relacionadas a transações [p] [p] Caso seja fornecido (schedule_date_init / schedule_date_end) [span _ngcontent-c12=\"\" class=\"param-required\"](Máximo de 3 meses)[/span]será retornado todas agendas [p] [p] Caso seja fornecido (transaction_id) será retornado as agendas relacionadas a transação - [Extrato Sintético de Recebíveis](https://devs.bs2.com/reference/post_v1-schedule-receivables-synthetic-statement.md): Utilize esse endpoint para listar o resumo de recebíveis das lojas: - [Gera Valores Pré Transferência](https://devs.bs2.com/reference/post_v1-schedule-receivables-transfer-generate.md): Utilize esse endpoint para gerar valores de pré transferência de agenda (1ª Etapa da Transferência de Agenda): - [Listar Valores Gerados na Pré transferência](https://devs.bs2.com/reference/post_v1-schedule-receivables-transfer-list.md): Utilize esse endpoint para listar valores gerados na pré transferência de agenda(2ª Etapa da Transferência de Agenda): - [Efetiva Transferência](https://devs.bs2.com/reference/post_v1-schedule-receivables-transfer-effective.md): Utilize esse endpoint para efetiva a transferência de agenda com as datas selecionadas (3ª Etapa da Transferência de Agenda): - [Gera Valores Pre Antecipacao ](https://devs.bs2.com/reference/post_v1-schedule-receivables-anticipation-generate.md): Utilize esse endpoint para gerar valores de antecipação (1ª Etapa da Antecipação): - [Listar Valores Gerados Na Pre Antecipacao ](https://devs.bs2.com/reference/post_v1-schedule-receivables-anticipation-list.md): Utilize esse endpoint para listar valores gerados na pré antecipação. (2ª Etapa da Antecipação): - [Efetivar Antecipação](https://devs.bs2.com/reference/post_v1-schedule-receivables-anticipation-effective.md): Utilize esse endpoint para efetivar a antecipação selecionada (3ª Etapa da Antecipação): - [Agendas ](https://devs.bs2.com/reference/post_v1-schedule-receivables-schedule-list.md): Listagem das agendas: - [Lista de Loja](https://devs.bs2.com/reference/post_v1-seller-list.md): Utilize esse endpoint para listar as Lojas: - [Lista de Taxas da Loja](https://devs.bs2.com/reference/post_v1-seller-mdr.md): Utilize esse endpoint para listar as taxas da loja: - [Atualizar Taxas e Combos](https://devs.bs2.com/reference/post_v1-seller-update-fee-combo.md): Utilize esse endpoint para atualizar cadastro da loja (preço, plano, valor diário, valor mensal, bloquear captura e habilitar limite mensal diário). : [p][b]INSTRUÇÕES[/b] [p] loja (seller_id) é obrigatório. [p] Caso seja fornecido (combo_cod) tem que ser de uma tabela de preço que exista, será alterado a tabela de preço. [P] Caso seja fornecido (cod_plan) tem que ser de uma tabela de plano que exista, será alterado a tabela plano de pagamento. [P] Caso seja fornecido (monthly_limit_value) será alterado o valor limite mensal (Ex: 60.10). [P] Caso seja fornecido (daily_limit_value) valor) será alterado o limite diário. (Ex: 50.50) obs: valor limite diário não pode ser maior que valor limite mensal. [P] Caso seja fornecido (is_block_capture) será ativado ou desativado a captura. Ex: ('S' para bloquear e 'N' para desbloquear). [p] Caso seja fornecido (is_use_limit) será ativado ou desativado o Habilita Limite Mensal/Diário. Ex: ('S' para bloquear e 'N' para desbloquear). - [Atualizar Loja](https://devs.bs2.com/reference/post_v1-seller-update.md): Utilize esse endpoint para atualizar os dados da loja: - [Obter lojas por responsável comercial](https://devs.bs2.com/reference/post_v1-seller-seller-responsable-commercial.md): Utilize esse endpoint para listar as lojas vinculadas a um responsável comercial: - [Lista de Dados Bancários Subseller](https://devs.bs2.com/reference/post_v1-seller-bank-account-list.md): Utilize esse endpoint para listar os Dados Bancários Subseller: - [Atualiza Dados Bancários da Loja](https://devs.bs2.com/reference/post_v1-seller-bank-account-update.md): Utilize esse endpoint para criar os Dados Bancários da Loja: - [Lista de Sócio da Loja](https://devs.bs2.com/reference/post_v1-seller-partner-list.md): Utilize esse endpoint para listar os Sócio da Loja: - [Atualizar Sócio da Loja](https://devs.bs2.com/reference/post_v1-seller-partner-update.md): Utilize esse endpoint para atualizar os Sócio da Loja: - [Autenticação Transparente da Loja](https://devs.bs2.com/reference/post_v1-seller-sso-create.md): Utilize esse endpoint para retornar uma url de redirecionamento para login transparente da loja: - [Valida Autenticação](https://devs.bs2.com/reference/post_v1-seller-sso-validate.md): Utilize esse endpoint para validar o token para login transparente da loja: - [Lista de Terminal](https://devs.bs2.com/reference/post_v1-terminal-list.md): Utilize esse endpoint para listar os Terminais: - [Criar Terminal](https://devs.bs2.com/reference/post_v1-terminal-create.md): Utilize esse endpoint para criar os Terminais: - [Lista de Terminal - Equipamento](https://devs.bs2.com/reference/post_v1-terminal-equipment-list.md): Utilize esse endpoint para listar as associações de terminal com equipamento: - [Associa Terminal com Equipamento](https://devs.bs2.com/reference/post_v1-terminal-equipment-create.md): Utilize esse endpoint para criar assuciação de terminal com equipamento: - [Lista de Modelo](https://devs.bs2.com/reference/post_v1-terminal-model-list.md): Utilize esse endpoint para listar os Modelos: - [Criar Modelo](https://devs.bs2.com/reference/post_v1-terminal-model-create.md): Utilize esse endpoint para criar os Modelos: - [Obter Parâmetros usuário](https://devs.bs2.com/reference/get_v1-user-params.md): Utilize esse endpoint para listar os parâmetros do usuário: - [Listar Usuarios](https://devs.bs2.com/reference/post_v1-user-list.md): Utilize esse endpoint para listar os usuários: - [Lista de Usuarios Responsavel Comercial](https://devs.bs2.com/reference/get_v1-user-userresponsiblecommercial.md): Utilize esse endpoint para listar os usuarios responsavéis Comercial: ## Changelog - [Webhook Pix: ID único por evento](https://devs.bs2.com/changelog/webhook-pix-id-único-por-evento.md) - [Novo webhook do Pix](https://devs.bs2.com/changelog/novo-webhook-do-pix.md) - [Atualizações](https://devs.bs2.com/changelog/atualizações.md) - [Lançamentos e atualizações](https://devs.bs2.com/changelog/lançamentos-e-atualizações.md) - [Pix para clientes](https://devs.bs2.com/changelog/bolepix.md)