Este método permite criar uma transação híbrida (boleto + pix), para a função de checkout transparente (implementado dentro do sistema web do comércio) de forma a permitir gerar um PDF contendo um boleto e o pix relacionado, além de receber a linha digitável, nosso número, o contéudo e URL do QRCode associado a transação. Notar que no momento da criação do boleto híbrido, a transação apresentará o estado “Pendente”. O sistema então verificará automaticamente pelo pagamento do referido boleto ou do crédito do pix relacionado, e quanto este ocorrer, invoca a URL de confirmação indicada pelo comércio, para notificar do pagamento, o qual deverá consultar o estado da transação neste momento e realizar a respectiva baixa no seu sistema. Notar que o boleto híbrido é suportado somente pelo provedor Arbi.
O pix gerado nesta modalidade herdará as mesmas características do boleto, ou seja, informações como desconto, multa e juros também estarão presentes no pix no momento do pagamento pelo cliente final do comércio.
Requisição
| Campo | Tipo | Descrição |
|---|---|---|
| Valor | Numérico com 2 decimais | Valor da compra |
| DataVencimento | Data | Data de vencimento do boleto |
| URLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final. |
| ClienteDescricao | Texto | Descrição da compra. |
| ClienteIP | Texto | IP do cliente final da transação. |
| ClienteCPFCNPJ | Texto | CPF/CNPJ do cliente final da transação. |
| ClienteNome | Texto | Nome do cliente final da transação. |
| ClienteEMail | Texto | E-mail do cliente final da transação (opcional). |
| ClienteEndereco | Texto | Endereço do cliente final da transação (opcional). |
| ClienteBairro | Texto | Bairro do cliente final da transação (opcional). |
| ClienteCidade | Texto | Cidade do cliente final da transação (opcional). |
| ClienteCEP | Texto | CEP do cliente final da transação (opcional). |
| ClienteUF | Texto | UF do cliente final da transação (opcional). |
| ClienteDDD | Texto | DDD do telefone do cliente final da transação (opcional). |
| ClienteNumeroCelular | Texto | Número do telefone do cliente final da transação (opcional). |
| NumeroPedido | Texto | Número do pedido para controles internos (opcional). |
| DataEmissao | Data | Data de emissão do boleto. |
| TipoDesconto | Texto | Tipo do desconto a ser aplicado, sendo os valores possíveis: NaoTemDesconto, ValorFixoAteDataInformada, PercentualADataInformada. |
| ValorDesconto | Numérico com 2 decimais | Valor do desconto a ser aplicado. |
| DataLimitePagamento | Data | Data limite para pagamento do título.Após esta data, o mesmo é baixado junto a CIP. |
| DocumentoRevisao | Texto | Versão do documento da cobrança (padrão 3). |
| TipoMulta | Texto | Tipo da multa a ser aplicada, sendo os valores possíveis: NaoTemMulta, ValorFixo, ValorPercentual. |
| ValorMulta | Numérico | Valor da multa a ser aplicada. |
| TipoJuros | Texto | Tipo dos juros a serem aplicadas, sendo os valores possíveis: ValorAoDia, TaxaMensal, Isento. |
| ValorJuros | Numérico | Valor do juros a ser aplicado. |
| TransacaoId | Numérico | Campo auxiliar para identificação da transação (opcional). |
| SolicitacaoPagador | Texto | Campo auxiliar para informação adicional ao pagador (opcional). |
| InfoAdicional | Texto | Campo para informações adicionais à transação (opcional). |
| TipoPix | Texto | Modalidade do PIX atrelada ao boleto híbrido, sendo os valores possíveis: DinamicoVencimento. |
| PixComVencimentoEMulta | – | Array para composição do PIX. |
| CalendarioValidadeAposVencimento | Numérico | Dias até a expiração do Qr Code a partir da Data de Criação ou Vencimento (opcional). |
| CalendarioVencimento | Data | Data de vencimento do PIX.Geralmente utilizada a mesma data de vencimento do boleto.Formato YYYY-MM-DDT00:00:00 |
| ModalidadeDesconto | Texto | Tipo do desconto a ser aplicado, sendo os valores possíveis: ValorFixoAteDataInformada, PercentualADataInformada.Geralmente utilizada no mesmo formato do boleto. |
| ValorDesconto | Numérico | Valor do desconto a ser aplicado. |
| ModalidadeAbatimento | Texto | Tipo do abatimento a ser aplicado, sendo os valores possíveis: ValorFixo, Percentual. |
| ValorAbatimento | Numérico | Valor do abatimento a ser aplicado. |
| DescontosDataFixa | – | Desconto concedido por data fixa, sendo composto por: data: Descontos por pagamento antecipado, com data fixa.valorPerc: Desconto em valor absoluto ou percentual por dia, útil ou corrido, conforme a modalidade. |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Retorno | Texto | Retorno da chamada, podendo possuir os valores OK ou ERRO. |
| DetalhesErro | Texto | Detalhes do erro gerado, caso o retorno seja ERRO. |
| Identificador | Texto | Identificador da transação. |
| NossoNumero | Texto | Nosso número do boleto gerado. |
| LinhaDigitavel | Texto | Linha digitável do boleto gerado. |
| CodigoBarras | Texto | Código equivalente ao binário do código de barras do boleto gerado. |
| BoletoPDF | Texto | PDF do boleto codificado em texto formato Base64. |
| QRCodeTexto | Texto | Texto do QRCode para realizar o pagamento via Pix. |
| QRCodeImagem | Texto | URL que gera a imagem do QRCode relacionado a transação. |