Boleto

Este guia orienta a integração de cobranças por boleto bancário em sua aplicação, um método de cobrança regulamentado pelo Banco Central e amplamente utilizado por clientes que não utilizam cartão de crédito. A Pinbank oferece soluções que abrangem desde a emissão de boletos para vendas diretas até fluxos complexos e personalizáveis para marketplaces, garantindo que o lojista receba seus valores após a compensação bancária.

Fluxo

A jornada de cobrança via boleto é estruturada em etapas claras para garantir a liquidação dos valores:

Geração da cobrança: O lojista solicita a emissão do boleto informando os dados do pagador, do beneficiário e os detalhes financeiros (valor e vencimento).

Pagamento: O cliente efetua o pagamento através de bancos, lotéricas ou aplicativos bancários utilizando o código de barras gerado.

Compensação e divisão: Após o processamento bancário, o sistema identifica o pagamento. Caso a transação possua regras de Split, a Pinbank realiza a divisão automática e o repasse para cada recebedor envolvido.

Gestão e baixa: O lojista pode monitorar o status da cobrança via API ou solicitar a baixa manual caso o boleto não deva mais ser pago.

Vantagens e diferenciais

Ampla aceitação: Atende a uma vasta parcela de consumidores que preferem boletos como documento oficial de cobrança.

Split de pagamento automático: Solução ideal para marketplaces e franquias, automatizando o repasse de valores e simplificando a gestão de múltiplos recebedores.

Conciliação eficiente: APIs de consulta em lote e resumo permitem obter métricas claras sobre a performance das cobranças.

Flexibilidade de emissão: Suporte para boletos de cobrança padrão e boletos com regras de divisão específicas.

Jornada de integração

Abaixo, detalhamos as APIs utilizadas para orquestrar os cenários de cobrança:

1. Cobrança padrão

Ideal para vendas diretas e faturas de serviços tradicionais.

Gerar boleto de cobrança: Emite o boleto e retorna os dados necessários para o pagamento do cliente.

Consultar o status de um boleto: Verifica a situação de um documento específico através do NossoNumero.

Consultar boletos em lote: Recupera o status de diversos boletos emitidos em um período determinado.

Obter métricas e indicadores de cobrança: Obtém métricas e indicadores consolidados de cobrança por período.

Cancelar cobrança via boleto: Realiza a baixa manual de cobranças que não serão mais liquidadas.

2. Cobrança com split de pagamento

Ideal para marketplaces e plataformas de afiliados onde um pagamento deve ser rateado.

Emitir boleto com split de valores: Emite o boleto incorporando as regras de rateio entre os recebedores no momento da geração.

Gestão de ciclo de vida: Para este fluxo, utilizam-se as mesmas APIs de Consulta (individual, lote ou resumo) e Baixa descritas no cenário de Cobrança Padrão.

Fluxo#

Vantagens e diferenciais#

Jornada de integração#

1. Cobrança padrão#

2. Cobrança com split de pagamento#

Fluxo

Vantagens e diferenciais

Jornada de integração

1. Cobrança padrão

2. Cobrança com split de pagamento