Cria uma transação via boleto

Este método 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

CampoTipoDescriçãoObrigatório
ValorNumérico com 2 decimaisValor da compraSim
DataVencimentoTextoData de vencimento quando pago via boletoSim
DataLimitePagamentoTextoData limite para pagamento do título.Não
URLConfirmacaoTextoURL de confirmação do comércio para indicar que o pagamento está em estado final.Não
ClienteDescricaoTextoDescrição da compra.Sim
ClienteIPTextoIP do cliente final da transação.Não
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.Sim
ClienteNomeTextoNome do cliente final da transação.Sim
ClienteEMailTextoE-Mail do cliente final da transação.Não
ClienteEnderecoTextoEndereço do cliente final da transação.Sim
ClienteBairroTextoBairro do cliente final da transação.Sim
ClienteCidadeTextoCidade do cliente final da transação.Sim
ClienteCEPTextoCEP do cliente final da transação.Sim
ClienteUFTextoUF do cliente final da transação.Sim
ClienteDDDTextoDDD do telefone do cliente final da transação.Não
ClienteNumeroCelularTextoNúmero do telefone do cliente final da transação.Não
NumeroPedidoTextoNúmero do pedido e/ou carrinho de comprasNão
TipoMultaTextoNaoTemMulta, ValorFixo, ValorPercentual.Não
ValorMultaNúmeroValor da multa a ser aplicada.Não
MultaNúmeroValor de multa após vencimento.Não
TipoJurosTextoTipo do juro a ser aplicado, sendo os valores possíveis: Isento, ValorAoDia ou TaxaMensal.Não
ValorJurosNúmeroValor do Juros a ser aplicado.Não
TipoDescontoTextoTipo do desconto a ser aplicado, sendo os valores possíveis: NaoTemDesconto, ValorFixoAteDataInformada ou PercentualADataInformada.Não
ValorDescontoNúmeroValor do desconto a ser aplicado.Não
DataDescontoTextoData do desconto.Não
ValorDesconto2NúmeroValor do desconto a ser aplicado.Não
DataDesconto2TextoData do desconto.Não
ValorDesconto3NúmeroValor do desconto a ser aplicado.Não
DataDesconto3TextoData do desconto.Não
Mensagem2TextoMensagem orientativa inserida no boleto.Não
Mensagem3TextoMensagem orientativa inserida no boleto.Não
Mensagem4TextoMensagem orientativa inserida no boleto.Não
Mensagem5TextoMensagem orientativa inserida no boleto.Não
NumeroDocumentoTextoDescritivo para localização futura do boleto.Não
ReferenciaTextoReferência para localização futura do boleto.Não
RetornoBase64BooleanoAceita os valores true ou false, informando para retornar PDF do boleto codificado em texto formato Base64.Não
EntradaCNABBooleanoAceita os valores true ou false, informando se a origem do boleto é CNAB.Não
NossoNumeroTextoNosso número do boleto gerado.Não
CarteiraTextoNúmero identificador da carteira junto ao banco.Não
ArbiCnabNumeroOperacaoTextoCódigo do número de operação utilizado para geração de boleto via CNAB.Não
NotaFiscalTextoNúmero da nota fiscal.Não

Resposta

CampoTipoDescrição
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO.
DetalhesErroTextoDetalhes do erro gerado, caso o retorno seja ERRO.
IdentificadorTextoIdentificador da transação.
NossoNumeroTextoNosso número do boleto gerado.
LinhaDigitavelTextoLinha digitável do boleto gerado.
CodigoBarrasTextoCódigo equivalente ao binário do código de barras do boleto gerado.
BoletoPDFTextoPDF do boleto codificado em texto formato Base64.
CodigoErroTextoCódigo do erro retornado
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!