Documentação das APIs

Cria uma transação 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ção
ValorNumérico com 2 decimaisValor da compra
DataVencimentoDataData de vencimento quando pago via boleto
URLConfirmacaoTextoURL de confirmação do comércio para indicar que o pagamento está em estado final.
ClienteDescricaoTextoDescrição da compra.
ClienteIPTextoIP do cliente final da transação.
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.
ClienteNomeTextoNome do cliente final da transação.
ClienteEMailTextoE-Mail do cliente final da transação (opcional).
ClienteEnderecoTextoEndereço do cliente final da transação (opcional).
ClienteBairroTextoBairro do cliente final da transação (opcional).
ClienteCidadeTextoCidade do cliente final da transação (opcional).
ClienteCEPTextoCEP do cliente final da transação (opcional).
ClienteUFTextoUF do cliente final da transação (opcional).
ClienteDDDTextoDDD do telefone do cliente final da transação (opcional).
ClienteNumeroCelularTextoNúmero do telefone do cliente final da transação (opcional).
NumeroPedidoTextoNúmero do pedido e/ou carrinho de compras (opcional)

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.
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!