Este endpoint permite criar uma transação de boleto, para a função de checkout transparente (implementado dentro do sistema web do comércio) de forma a permitir gerar um boleto com as informações indicadas e receber a linha digitável, nosso número e PDF do referido boleto, além de enviar um E-mail ao usuário final que deverá realizar o pagamento.
Atenção que no momento da criação do boleto, a transação apresentará o estado “Pendente”. O sistema então verificará automaticamente pelo pagamento do referido boleto, 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.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Valor | Numérico | Valor da compra | Sim |
| DataVencimento | Data | Data de vencimento quando pago via boleto | Sim |
| DataLimitePagamento | Data | Data limite para pagamento do título | Não |
| URLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final | Não |
| ClienteDescricao | Texto | Descrição da compra | Sim |
| ClienteIP | Texto | IP do cliente final da transação | Não |
| ClienteCPFCNPJ | Texto | CPF/CNPJ do cliente final da transação | Sim |
| ClienteNome | Texto | Nome do cliente final da transação | Sim |
| ClienteEmail | Texto | E-mail do cliente final da transação | Não |
| ClienteEndereco | Texto | Endereço do cliente final da transação | Sim |
| ClienteBairro | Texto | Bairro do cliente final da transação | Sim |
| ClienteCidade | Texto | Cidade do cliente final da transação | Sim |
| ClienteCEP | Texto | CEP do cliente final da transação | Sim |
| ClienteUF | Texto | UF do cliente final da transação | Sim |
| ClienteDDD | Texto | DDD do telefone do cliente final da transação | Não |
| ClienteNumeroCelular | Texto | Número do telefone do cliente final da transação | Não |
| NumeroPedido | Texto | Número do pedido e/ou carrinho de compras | Não |
| TipoMulta | Texto | Tipo da multa a ser aplicado - NaoTemMulta, ValorFixo, ValorPercentual | Não (1) |
| ValorMulta | Numérico | Valor da multa a ser aplicada | Não |
| Multa | Numérico | Valor de multa após vencimento | Não |
| TipoJuros | Texto | Tipo do juro a ser aplicado - ValorAoDia, TaxaMensal, Isento | Não (2) |
| ValorJuros | Numérico | Valor do Juros a ser aplicado | Não |
| TipoDesconto | Texto | Tipo do desconto a ser aplicado - NaoTemDesconto, ValorFixoAteDataInformada, PercentualADataInformada | Não (3) |
| ValorDesconto | Numérico | Valor do desconto a ser aplicado | Não |
| DataDesconto | Data | Data do desconto | Não (4) |
| ValorDesconto2 | Numérico | Valor do desconto a ser aplicado | Não |
| DataDesconto2 | Data | Data do desconto | Não (5) |
| ValorDesconto3 | Numérico | Valor do desconto a ser aplicado | Não |
| DataDesconto3 | Data | Data do desconto | Não (6) |
| Mensagem2 | Texto | Mensagem orientativa inserida no boleto | Não |
| Mensagem3 | Texto | Mensagem orientativa inserida no boleto | Não |
| Mensagem4 | Texto | Mensagem orientativa inserida no boleto | Não |
| Mensagem5 | Texto | Este campo não deve ser utilizado | Não |
| NumeroDocumento | Texto | Descritivo para localização futura do boleto | Não |
| Referencia | Texto | Referência para localização futura da transação | Não |
| RetornarBase64 | Booleano | Indica se deve retornar PDF do boleto codificado em texto Base64 | Não |
| EntradaCNAB | Booleano | Indica se a origem do boleto é CNAB | Não |
| NossoNumero | Texto | Nosso número do boleto gerado | Não |
| Carteira | Texto | Número identificador da carteira junto ao banco | Não |
| ArbiCnabNumeroOperacao | Texto | Código do número de operação utilizado para geração de boleto via CNAB | Não |
| NotaFiscal | Texto | Número da nota fiscal | Não |
| CNABArquivo | Texto | Arquivo CNAB para geração do boleto | Não |
(1) - Obrigatório caso ValorMulta ou Multa seja informado.
(2) - Obriatório caso ValorJuros seja informado.
(3) - Obrigatório caso ValorDesconto seja informado.
(4) - Obrigatório caso seja informado mais de um desconto.
(5) - Obrigatório caso ValorDesconto2 seja informado.
(6) - Obrigatório caso ValorDesconto3 seja informado.
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 |
| CodigoErro | Texto | Código do erro retornado |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||