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ítuloNão
URLConfirmacaoTextoURL de confirmação do comércio para indicar que o pagamento está em estado finalNão
ClienteDescricaoTextoDescrição da compraSim
ClienteIPTextoIP do cliente final da transaçãoNão
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transaçãoSim
ClienteNomeTextoNome do cliente final da transaçãoSim
ClienteEMailTextoE-mail do cliente final da transaçãoNão
ClienteEnderecoTextoEndereço do cliente final da transaçãoSim
ClienteBairroTextoBairro do cliente final da transaçãoSim
ClienteCidadeTextoCidade do cliente final da transaçãoSim
ClienteCEPTextoCEP do cliente final da transaçãoSim
ClienteUFTextoUF do cliente final da transaçãoSim
ClienteDDDTextoDDD do telefone do cliente final da transaçãoNão
ClienteNumeroCelularTextoNúmero do telefone do cliente final da transaçãoNão
NumeroPedidoTextoNúmero do pedido e/ou carrinho de comprasNão
TipoMultaTextoTipo da multa a ser aplicadoNão
ValorMultaNúmeroValor da multa a ser aplicadaNão
MultaNúmeroValor de multa após vencimentoNão
TipoJurosTextoTipo do juro a ser aplicadoNão
ValorJurosNúmeroValor do Juros a ser aplicadoNão
TipoDescontoTextoTipo do desconto a ser aplicadoNão
ValorDescontoNúmeroValor do desconto a ser aplicadoNão
DataDescontoTextoData do descontoNão
ValorDesconto2NúmeroValor do desconto a ser aplicadoNão
DataDesconto2TextoData do descontoNão
ValorDesconto3NúmeroValor do desconto a ser aplicadoNão
DataDesconto3TextoData do descontoNão
Mensagem2TextoMensagem orientativa inserida no boletoNão
Mensagem3TextoMensagem orientativa inserida no boletoNão
Mensagem4TextoMensagem orientativa inserida no boletoNão
Mensagem5TextoMensagem orientativa inserida no boletoNão
NumeroDocumentoTextoDescritivo para localização futura do boletoNão
ReferenciaTextoReferência para localização futura da transaçãoNão
RetornoBase64BooleanoAceita os valores true ou false, informando para retornar PDF do boleto codificado em texto formato Base64Não
EntradaCNABBooleanoAceita os valores true ou false, informando se a origem do boleto é CNABNão
NossoNumeroTextoNosso número do boleto geradoNão
CarteiraTextoNúmero identificador da carteira junto ao bancoNão
ArbiCnabNumeroOperacaoTextoCódigo do número de operação utilizado para geração de boleto via CNABNão
NotaFiscalTextoNúmero da nota fiscalNã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!