v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBCriaTransacaoBoleto
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. <br />
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. <br />
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Valor | Numérico com 2 decimais | Valor da compra | Sim |
| DataVencimento | Texto | Data de vencimento quando pago via boleto | Sim |
| DataLimitePagamento | Texto | 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 | Não |
| ValorMulta | Número | Valor da multa a ser aplicada | Não |
| Multa | Número | Valor de multa após vencimento | Não |
| TipoJuros | Texto | Tipo do juro a ser aplicado | Não |
| ValorJuros | Número | Valor do Juros a ser aplicado | Não |
| TipoDesconto | Texto | Tipo do desconto a ser aplicado | Não |
| ValorDesconto | Número | Valor do desconto a ser aplicado | Não |
| DataDesconto | Texto | Data do desconto | Não |
| ValorDesconto2 | Número | Valor do desconto a ser aplicado | Não |
| DataDesconto2 | Texto | Data do desconto | Não |
| ValorDesconto3 | Número | Valor do desconto a ser aplicado | Não |
| DataDesconto3 | Texto | Data do desconto | Não |
| 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 | Mensagem orientativa inserida no boleto | 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 |
| RetornoBase64 | Booleano | Aceita os valores true ou false, informando para retornar PDF do boleto codificado em texto formato Base64 | Não |
| EntradaCNAB | Booleano | Aceita os valores true ou false, informando 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 |
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 |
post/api/CriaTransacaoBoleto
Headers
Aeskeystring required
Request body
Example request
{
"Valor": 103.67,
"DataVencimento": "2026-06-05T09:47:50.9680678-03:00",
"DataLimitePagamento": "2026-06-20T09:47:50.9680678-03:00",
"URLConfirmacao": "https://www.meusite.com.br/webhook/confirmacao-transacao",
"ClienteDescricao": "Cliente Gold Nivel 25",
"ClienteIP": "127.0.0.1",
"ClienteCPFCNPJ": "48455151480",
"ClienteNome": "Renato Samuel Augusto Baptista",
"ClienteEmail": "renatosamuel@umdominio.com.br",
"ClienteEndereco": "Rua Canadá, 257",
"ClienteBairro": "Bacacheri",
"ClienteCidade": "Curitiba",
"ClienteCEP": "82510290",
"ClienteUF": "PR",
"ClienteDDD": "41",
"ClienteNumeroCelular": "999293802",
"NumeroPedido": "pedido.2026052109",
"TipoMulta": "ValorFixo",
"ValorMulta": 3.22,
"Multa": 13.04,
"TipoJuros": "ValorAoDia",
"ValorJuros": 2.75,
"TipoDesconto": "ValorFixoAteDataInformada",
"ValorDesconto": 9.99,
"DataDesconto": "2026-05-25T09:47:50.9680678-03:00",
"ValorDesconto2": 6.99,
"DataDesconto2": "2026-05-29T09:47:50.9680678-03:00",
"ValorDesconto3": 3.99,
"DataDesconto3": "2026-06-02T09:47:50.9680678-03:00",
"Mensagem2": "Nao receber depois de 05/06/2026",
"Mensagem3": "Não aplicar o desconto após o vencimento.",
"Mensagem4": "Aplicar 5% de desconto antes do vencimento.",
"Mensagem5": "Inseria sua mensgagem aqui.",
"NumeroDocumento": "1829310288",
"Referencia": "2112513",
"RetornarBase64": false,
"EntradaCNAB": false,
"NossoNumero": "00009540025",
"Carteira": "121",
"ArbiCnabNumeroOperacao": "0000496",
"NotaFiscal": "004179629",
"CNABArquivo": "CNAB arquivo.txt"
}Response
Método executado com sucesso