Acessando a página de Boletos
Para abrir a página Boletos, clique em Payments → Boletos no menu lateral esquerdo. A página exibe todos os boletos da organização em uma tabela de dados, com as seguintes colunas:
- Boleto — o identificador do boleto (e o código de barras/linha digitável quando emitido).
- Pagador — a parte que está sendo cobrada.
- Valor — o valor do boleto.
- Vencimento — a data de vencimento do boleto.
- Status — o estado atual do ciclo de vida (veja Estados).
- Criado em — a data em que o boleto foi emitido.
- Ações — menu de ações.
Emitindo um boleto
Para emitir um boleto, clique no botão + Emitir novo boleto no canto superior direito da página Boletos. Um painel lateral abre com três abas — escolha o tipo de emissão que se encaixa no seu caso de uso:
Tipos de boleto
| Tipo | Descrição |
|---|---|
| Único | Emite um boleto para um único pagador com valor e vencimento fixos. |
| Parcelado | Emite uma série de boletos para o mesmo pagador, distribuídos por vários vencimentos em um intervalo configurado. |
| Lote | Emite até 10 boletos para pagadores diferentes em uma única operação. Cada entrada é enviada individualmente ao provedor. |
Tipo de registro
Os três tipos de emissão incluem um campo Tipo:- Tradicional — boleto padrão registrado junto ao provedor bancário.
- Híbrido — boleto com um QR code Pix incorporado, permitindo que o pagador pague por código de barras ou QR code.
Boleto único
Preencha os campos obrigatórios:Dados do boleto
- Valor (obrigatório) — o valor do boleto (R$).
- Vencimento (obrigatório) — a data até a qual o boleto deve ser pago.
- Account ID (obrigatório) — a conta Midaz a ser associada ao boleto.
- Tipo (obrigatório) — Tradicional ou Híbrido.
- CPF / CNPJ (obrigatório) — o documento fiscal do pagador.
- Nome completo (obrigatório) — o nome completo do pagador.
- Rua (obrigatório) — o logradouro do pagador.
- Número (obrigatório) — o número do endereço.
- Complemento (opcional) — apartamento, sala ou informações adicionais de endereço.
- Bairro (obrigatório) — o bairro do pagador.
- Cidade (obrigatório) — a cidade do pagador.
- Instruções (opcional) — instruções impressas no boleto (por exemplo, juros ou multa após o vencimento).
Série parcelada
Os mesmos campos do Único, com as seguintes diferenças:- Valor total (obrigatório) — o valor integral a ser dividido entre todas as parcelas.
- Primeiro vencimento (obrigatório) — a data de vencimento da primeira parcela; os boletos seguintes são gerados automaticamente.
- Parcelas (obrigatório) — número de boletos a gerar (mínimo de 2).
- Intervalo (dias) (obrigatório) — número de dias entre cada vencimento (padrão 30).
Lote
A aba Lote permite emitir até 10 boletos de uma vez. Cada entrada é enviada individualmente ao provedor. Para cada entrada, preencha: Valor, Vencimento, Account ID, CPF / CNPJ e Nome completo. Use + Adicionar entrada para incluir mais entradas. O contador mostra quantas entradas estão na fila (por exemplo,1 / 10 entradas).
Clique em Emitir lote para enviar todas as entradas.
Estados do boleto
Um boleto passa pelos seguintes estados:
- Em registro — a solicitação de emissão do boleto foi enviada e está sendo registrada.
- Registrado — o boleto foi registrado com sucesso e pode ser pago pelo pagador.
- Pago — o pagador pagou o boleto.
- Expirado — o boleto passou da data de vencimento sem pagamento.
- Cancelado — o boleto foi cancelado antes do pagamento.
- Falha — a solicitação de emissão não pôde ser concluída (veja Tratamento de erros).
Menu de ações disponíveis
Para cada boleto, as seguintes ações podem estar disponíveis no menu de ações (), dependendo do seu estado:
- Ver detalhes — abre os detalhes do boleto, incluindo código de barras, linha digitável e histórico de status.
- Baixar — baixa o documento do boleto.
- Cancelar — cancela um boleto que ainda não foi pago.
Tratamento de erros
Se um boleto não puder ser emitido, ele aparece com o status Falha e um motivo de erro no painel de detalhes. As causas comuns incluem:
- Documento do pagador inválido — o CPF/CNPJ está malformado ou falha na validação. Corrija o documento e emita um novo boleto.
- Valor ou vencimento inválido — o valor é zero/negativo ou o vencimento está no passado. Ajuste os valores e tente novamente.
- Erro de provedor/registro — o registro não pôde ser concluído junto ao provedor bancário. Tente emitir novamente; se persistir, entre em contato com o suporte.