Emissão de Boleto Híbrido
Uma das principais funcionalidades do nosso produto é o processo de emissão.
A geração do código de barras e a geração do QR CODE serão realizadas por meio da criação offline via sistemas do boleto híbrido. Deverão ser enviadas por meio dos contratos estabelecidos no sistema de boleto híbrido, as seguintes informações:
- O código de barras gerado que será transmitido ao sistema de cobrança para registro;
- O QR CODE gerado que será transmitido ao sistema de Pix para registro;
- O produto em mãos dos nossos clientes será: Código de barras/linha digitável offline (com processo de registro de maneira assíncrona) e QR CODE atrelado ao boleto.
Por meio de uma seleção, nossos clientes escolhem a chave Pix cadastrada em sua conta transacional no Banco BS2.
Solicitamos os campos:
| Campo | Descrição | Formato | Obrigatório |
|---|---|---|---|
| chave | Chave Pix utilizada para identificar a cobrança | Texto | Não |
| seuNumero | Identificador único da cobrança fornecido pelo cliente | Texto | Sim |
| dataVencimento | Data em que a cobrança deve ser paga | AAAA-MM-DD | Sim |
| dataLimitePosVencimento | Data limite para pagamento após o vencimento | AAAA-MM-DD | Sim |
| valor | Valor total da cobrança | Numérico com até 2 casas decimais | Sim |
| multa.tipo | Valor da multa aplicada após o vencimento | Texto (ValorFixo ou ValorPercentual) | Não |
| multa.valor | Valor da multa aplicada após o vencimento | Numérico com até 2 casas decimais | Não |
| juros.tipo | Tipo de juros aplicados após o vencimento | Texto (FixoPorDiaCorrido, PercentualAoDiaCorrido, PercentualAoMesCorrido) | Não |
| juros.valor | Valor dos juros aplicados após o vencimento | Numérico com até 2 casas decimais | Não |
| valorDescontoPercentual | Percentual de desconto aplicado sobre o valor total da cobrança | Numérico com até 2 casas decimais | Não |
| valorDescontoFixo | Valor fixo de desconto aplicado sobre o valor total da cobrança | Numérico com até 2 casas decimais | Não |
| dataLimiteDesconto | Data limite para aplicação do desconto sobre a cobrança | AAAA-MM-DD | Não |
| solicitacaoPagador | Informações adicionais ou instruções do pagador | Texto | Não |
| Linha1 | Informação adicional para o boleto (linha 1) | Texto | Não |
| Linha2 | Informação adicional para o boleto (linha 2) | Texto | Não |
| Linha3 | Informação adicional para o boleto (linha 3) | Texto | Não |
| Linha4 | Informação adicional para o boleto (linha 4) | Texto | Não |
| Dados Pagador | |||
| documento | Documento de identificação do pagador (CPF ou CNPJ) | Texto | Sim |
| tipoDocumento | Tipo de documento de identificação do pagador (CPF ou CNPJ) | Texto | Sim |
| nome | Nome completo do pagador | Texto | Sim |
| telefone | Número de telefone do pagador | Texto | Não |
| Endereço de e-mail do pagador | Texto | Não | |
| bairro | Bairro de residência do pagador | Texto | Não |
| logradouro | Logradouro de residência do pagador | Texto | Não |
| numero | Número do endereço do pagador | Texto | Não |
| complemento | Complemento do endereço do pagador | Texto | Não |
| estado | Estado de residência do pagador (UF) | Texto | Não |
| cidade | Cidade de residência do pagador | Texto | Não |
| cep | Código postal (CEP) do endereço do pagador | Texto | Não |
Exemplo de resposta:
| Campo | Descrição | Status | Formato |
|---|---|---|---|
| BoletoHibridoID | Identificador do boleto híbrido solicitado para efeitos de acompanhamento | Criado | GUID |
Registra uma nova solicitação para geração de boleto híbrido.
Regras Gerais
- O Banco BS2 realiza a validação de existência da chave Pix. Chaves inativas não serão listadas para seleção;
- Durante o processo de seleção da chave cadastrada, será validada a existência de processos de portabilidade (eventos realizados pelo mesmo titular para as chaves CNPJ/CPF/e-mail/celular) ou Reivindicação de posse (eventos realizados entre titularidades diferentes; aplica-se para celular/e-mail);
- Em caso de inexistência de chave Pix cadastrada para a conta transacional do nosso cliente, o Banco BS2 realizará o cadastramento do tipo chave aleatória (EVP) e prosseguirá com a solicitação do boleto híbrido;
- Caso nosso cliente possua chaves cadastradas em sua conta transacional e não as selecione no processo de solicitação de emissão do boleto híbrido, nossos sistemas escolherão automaticamente uma chave disponível entre as pré-cadastradas, seguindo a precedência: CNPJ > Celular > E-mail > Chave Aleatória;
- Deve-se considerar que o limite de chaves possíveis para cadastro em uma conta transacional é de 20 chaves por conta. Após a criação automática da primeira chave aleatória, esta será utilizada nas próximas emissões, caso não seja selecionado outro tipo de chave pré-cadastrada (chaves do tipo aleatória não participam dos processos de portabilidade ou reivindicação de posse);
- Importante destacar que, caso ocorra a exclusão da chave Pix por meio de ação do nosso cliente em sua conta transacional, a emissão de novos boletos híbridos deverá ocorrer para a nova chave cadastrada ou por meio do processo automático de criação de nova chave aleatória.
Updated 16 days ago