Cobrando com boleto bancário

Sobre o produto

🚧

Emissão de boletos registrados

Devido as novas regulamentações da Febraban para emissão de boletos registrados é necessário o envio dos dados completos do pagador (customer) e do vendedor (seller). É necessário enviar obrigatoriamente o CPF/CNPJ, Nome Completo, Endereço, Bairro, Cidade, Estado, CEP e País.
​Clique aqui e saiba mais sobre a Nova Plataforma de Cobrança.

O boleto bancário da Zoop é um web service que disponibiliza operações de venda através de boleto registrado com base nos dados do comprador, de maneira totalmente segura e escalável. Ele foi criado para facilitar aos desenvolvedores recebimento de pagamentos em dinheiro através da emissão de títulos de cobrança em aplicativos e no e-commerce.

Para usar o serviço de pagamentos através de boleto da Zoop, você precisa:

  • Criar um novo comprador informando os dados de cobrança necessários a emissão do boleto.
  • Criar uma nova transação de boleto através do serviço de pagamentos associando o comprador e o vendedor da sua plataforma, encaminhando o boleto gerado para o comprador realizar o pagamento dentro do prazo determinado.
  • Após o pagamento e posterior conciliação bancária pelo serviço da Zoop, seu sistema é notificado, seguindo o fluxo de cobrança para liberação do produto ou serviço.

Recursos

Início imediato

Emita boletos registrados aderentes à regulamentação do BACEN, imediatamente e sem a necessidade de se cadastrar em nenhum banco.

Integração com a CIP

Com a nossa solução seu boleto é disponibilizado on-line na CIP, ficando disponível para pagamento imediato na rede bancária.

Conciliação automática

Nosso sistema identifica automaticamente os boletos pagos, sem a necessidade da sua empresa ter esforço manual.

Boleto customizável

Você deixa o boleto com a cara do seu negócio. Suportamos a personalização das informações, descrição, logomarca, prazo de vencimento, etc.

Split de pagamento

É possível dividir automaticamente entre diversas contas as vendas com Boleto, permitindo novos modelos de comissionamento entre recebedores.

Disponibilização

Geração de boleto e visualização em HTML, possibilidade de download e impressão, além de envio por e-mail

API Rest

É possível através da API fazer a gestão das transações do tipo boleto. Integrado com o ecosistema de APIs Zoop.

Notificações e eventos

Notificação através de webhooks de eventos de confirmação e rejeição dos pagamentos.

Como funciona uma transação

Estados de uma transação

Durante o fluxo de compra uma transação tem diferentes estados de acordo com as atualizações aplicadas.

Você pode verificar o estado atual através do campo status, sempre retornado no objeto da transação. Também é possível verificar o histórico de uma transação através do campo history.

new: Uma nova transação foi criada e as informações foram recebidas com sucesso para processamento.
pending: A transação foi processada pela Zoop, o boleto foi gerado, e está pendente para pagamento.
succeeded: O pagamento do boleto foi identificado e compensado pela Zoop.
failed: Ocorreu uma falha ao processar a transação
canceled: O pagamento foi cancelado/anulado pelo vendedor ou pelo aplicativo. As taxas cobradas originalmente também são anuladas.
refunded: A transação foi estornada e o saldo disponível foi liberado.

{
    "id": "eb5b0e986645401ca97309dbba56f4a9",
    "resource": "transaction",
    "status": "succeeded",

    ...

    "history": [
        {
            "id": "432a62c2d0384eb8b09b5661774f12e9",
            "transaction": "eb5b0e986645401ca97309dbba56f4a9",
            "amount": "336.75",
            "operation_type": "created",
            "status": "succeeded",
            "response_code": null,
            "response_message": null,
            "authorization_code": null,
            "authorizer_id": null,
            "authorization_nsu": null,
            "created_at": "2018-10-23 15:18:50"
        },
        {
            "id": "9df4d81b1e344e38849af95e4394a8e6",
            "transaction": "eb5b0e986645401ca97309dbba56f4a9",
            "amount": "0.00",
            "operation_type": "paid",
            "status": "succeeded",
            "response_code": null,
            "response_message": null,
            "authorization_code": null,
            "authorizer_id": null,
            "authorization_nsu": null,
            "created_at": "2018-11-09 13:27:32"
        }
    ]
}

Prazos, horários e conciliação

Prazos de emissão

Os boletos são emitidos online e ficam disponíveis imediatamente na CIP (Câmara Interbancária de pagamentos). Isso significa que assim que gerado o mesmo já está disponível para pagamento em toda rede bancária conveniada.

Prazos de pagamento

Por padrão os boletos bancários são configurados com vencimento de D+3, podendo ser pagos até a data de vencimento sem ônus de multas e juros. O meio de pagamento através de boletos bancários permite que os mesmos sejam aceitos após o vencimento. Também é possível configurar multas e juros após o vencimento.

Caso deseje aumentar a data de expiração do boleto deve se utilizar o campo expiration_date. É possível também estipular uma data máxima para pagamento utilizando o campo payment_limit_date.

Prazos de compensação / conciliação

Assim que os bancos nos notificam dos pagamentos, executamos um processo de conciliação dos pagamentos processados com os pagamentos recebidos.

Esse processo ocorre diariamente em dias úteis no período da manhã, atualmente entre o período de 9h ao 12h.

O prazo da conciliação de boletos é de 1-3 dias úteis, na grande maioria dos casos os boletos são conciliados em 1 dia útil.

Na prática: os boletos bancários emitidos em uma segunda-feira, e pagos no mesmo dia, serão conciliados no próximo dia útil, nesse exemplo, terça-feira.

Em alguns raros casos por falhas de comunicação ou atrasos de repasses é necessário o processamento em uma janela secundária, que ocorre de 12h até as 17h do mesmo dia.

Prazos de recebimento

Os boletos possuem plano padrão de recebimento em D+0.

O saldo fica disponível logo após o processo de conciliação, e é possível realizar um saque ou fazer uma transferência dos valores desde que sejam respeitadas as janelas desses serviços.

Anatomia do layout

Campo

Campo no JSON

Obs

1

Pagador/CPF/CNPJ/Endereço

customer

Representa o buyer ou seller que irá pagar o boleto

2

Data de Vencimento

payment_method.expiration_date

Caso não seja enviada uma data, o padrão é D+3.

3

Valor do Documento

amount

Enviar valor em centavos

4

Informações de Responsabilidade do Beneficiário

body_instructions

Informações de instruções de pagamento para o caixa (é responsabilidade do caixa acatar)

5

Sacador/Avalista

on_behalf_of

Representa as informações do seller

Tipos de integração

Existem dois modelos de integração, você pode utilizar o boleto com o layout fornecido pela Zoop de acordo com as especificações do banco, ou você pode montar o layout internamente na sua aplicação caso precise de um boleto ainda mais personalizado.

Layout Zoop

Esse é o modelo padrão, utilizado pela maioria dos clientes. Você realiza uma venda, nós retornamos um url pública no atributo payment_method.url você pode fornecer diretamente na sua aplicação ou para o seu usuário.

Nesse modelo a responsabilidade de montar e exibir o layout do boleto bancário é da Zoop.

🚧

Layout do Boleto

O layout do boleto pode ser atualizado a qualquer momento sem a necessidade de qualquer aviso prévio. Poderão ocorrer modificações no html de conteúdo, cores, tamanhos, disposição dos elementos e formatações para atender novas exigências regulatórias ou melhorias na experiência do produto.

Layout Próprio

Você realiza uma venda normalmente, coleta os dados de códigos de barras e demais informações enviados no response e exibe através de layout qualquer outro meio.

Nesse modelo a responsabilidade de montar e exibir o layout do boleto bancário é do integrador.

Updated 8 days ago



Cobrando com boleto bancário


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.