Pular para o conteúdo principal
Boletos & Bill Payment cobre o trilho de boletos do Brasil: a emissão de boletos bancários e o pagamento de contas como documentos de arrecadação DARF e faturas de serviços públicos e de concessionárias. Na plataforma Lerian, você opera essa capacidade pelo módulo Payments no Lerian Console, um plugin gerenciado do Midaz provisionado para sua organização.

O que você pode fazer


  • Emitir boletos com vencimento, registrados no seu ledger do Midaz. Pela API, um boleto também pode ter multa, juros e descontos, e você pode escolher o nosso número dele.
  • Pagar contas (pagamentos de tributos DARF e contas de serviços públicos e de concessionárias) direto pelo Console.
  • Consultar uma conta pela linha digitável na API antes de pagá-la. A resposta mostra o valor, as datas e quem recebe o dinheiro.
  • Acompanhar operações em um dashboard com cards de KPI, atividade recente e ações rápidas.

Como um pagamento de conta movimenta o dinheiro


  1. O ledger reserva o valor na conta de fundeio. Se o saldo ou o limite de cheque especial não permitir, o pagamento falha aqui, e o BTG não o recebe.
  2. O Payments envia o pagamento ao BTG.
  3. Quando o BTG aceita o pagamento, a API responde 201 e o pagamento fica CREATED. Quando o resultado no BTG é desconhecido, a API responde 202 e o pagamento fica UNCONFIRMED.
  4. Para um pagamento de boleto bancário ou de concessionária, a conciliação lê o pagamento no BTG. Se o BTG não tiver registro dele durante toda a janela que o deploy define, o pagamento falha com PBP-0211, e o Payments libera os fundos.
  5. Para um pagamento de DARF, os fundos continuam reservados até chegar o resultado do BTG.
Não envie um pagamento UNCONFIRMED de novo com um novo Idempotency-Key. O BTG pode já ter o pagamento, e uma segunda requisição pode pagar a conta duas vezes. Reenviar com a mesma chave é seguro.

Encontre um pagamento depois de um erro


Uma requisição que cria um pagamento pode terminar sem o id do pagamento, por exemplo depois de um timeout ou de uma resposta com status 5xx. Primeiro, envie a requisição de novo com o mesmo Idempotency-Key. Depois de um 409 com PBP-0007 ou de um 503 com PBP-0008, espere e envie de novo com a mesma chave. Depois que a mesma chave retornar outra resposta, chame GET /v1/payments com idempotencyKey igual a essa chave para encontrar o que a requisição criou. Envie o mesmo X-Organization-Id dessa requisição. Depois de enviar uma requisição de novo com um novo Idempotency-Key, não a envie de novo com a chave antiga. A chave antiga pode executar a requisição de novo, e as duas requisições podem pagar.

Por onde começar


Payments no Lerian Console

Ative o plugin Payments e faça um primeiro tour pelo módulo.

Visão geral do Payments

O dashboard: cards de KPI, operações recentes e atalhos.

Boletos

Emita, consulte e gerencie boletos.

Pagamento de contas

Pague DARF e contas de serviços públicos pelo Console.