Introdução - Cobranças

Aprenda o passo a passo para criar cobranças no Asaas.

Crie e acompanhe cobranças

As cobranças registram valores a receber na conta Asaas e disponibilizam formas de pagamento para seus clientes.

Neste fluxo, sua integração cadastra o cliente, cria a cobrança, disponibiliza o pagamento e acompanha o status até a conciliação.

📘
Importante
Ao concluir este guia, você saberá criar uma cobrança, escolher a forma de pagamento e acompanhar o resultado pela API e por Webhooks.

Quando utilizar

Utilize cobranças quando sua integração precisar gerar um valor a receber para um cliente cadastrado no Asaas.

Alguns cenários comuns são:

vendas avulsas;
cobrança de serviços prestados;
mensalidades controladas pela sua aplicação;
checkout transparente;
envio de uma fatura hospedada;
recebimentos por boleto, Pix ou cartão de crédito.

Para disponibilizar uma página em que o cliente preenche os próprios dados ou escolhe produtos e condições de pagamento, consulte:

Antes de começar

Para criar uma cobrança:

cadastre ou localize o cliente;
armazene o ID retornado no campo id;
defina a forma de pagamento;
defina o valor;
informe a data de vencimento;
prepare o acompanhamento do status.

O ID do cliente deve ser enviado no campo customer durante a criação da cobrança.

Como funciona

Criar ou localizar o cliente
        ↓
Armazenar o ID do cliente
        ↓
Criar a cobrança
        ↓
Disponibilizar o pagamento
        ↓
Acompanhar o status
        ↓
Conciliar no sistema de origem

1. Cadastre o cliente

Antes de criar a cobrança, cadastre o pagador e armazene o ID retornado pela API.

Consulte o guia: Cadastro de clientes.

⚠️
Atenção
O Asaas permite clientes duplicados.
Reutilize o ID armazenado pela sua aplicação ou consulte os clientes existentes antes de criar um novo cadastro.

2. Crie a cobrança

Envie uma requisição ao endpoint de criação de cobranças.

Os principais campos são:

Campo	Finalidade
`customer`	ID do cliente no Asaas
`billingType`	Forma de pagamento
`value`	Valor da cobrança
`dueDate`	Data de vencimento no formato `AAAA-MM-DD`
`externalReference`	Identificador da cobrança no seu sistema

Consulte o endpoint: Criar nova cobrança.

Após a criação, armazene o ID da cobrança retornado pela API. Ele será necessário para consultas, atualizações, estornos e conciliação.

3. Escolha a forma de pagamento

O comportamento da cobrança depende do valor enviado em billingType.

Consulte o guia correspondente:

Para permitir que o cliente escolha a forma de pagamento na Fatura, utilize a configuração correspondente disponibilizada pelo endpoint.

Para dividir o valor em parcelas, consulte Criar uma cobrança parcelada.

4. Disponibilize o pagamento

Após criar a cobrança, sua aplicação pode:

utilizar a URL retornada para exibir a Fatura;
enviar a Fatura ao cliente;
apresentar o boleto, QR Code Pix ou formulário de cartão no próprio fluxo;
utilizar um Link de Pagamento;
utilizar o Asaas Checkout.

Experiência	Quando utilizar
Fatura da cobrança	Para utilizar a página de pagamento vinculada a uma cobrança já criada
Link de Pagamento	Para permitir que o cliente preencha os próprios dados
Asaas Checkout	Para direcionar o cliente a uma página hospedada dentro de um fluxo de compra

Para direcionar o cliente de volta à sua aplicação após o pagamento, consulte Redirecionamento após o pagamento.

5. Acompanhe o status

Após a criação, acompanhe a cobrança para identificar eventos como:

cobrança aguardando pagamento;
pagamento confirmado ou recebido;
cobrança vencida;
cobrança removida ou restaurada;
estorno;
chargeback;
falha no processamento do cartão.

Utilize os Webhooks para receber automaticamente as alterações ocorridas na conta.

Para conhecer os eventos relacionados ao ciclo das cobranças, consulte Eventos para cobranças.

📘
Importante
Não considere apenas a resposta da requisição de criação.
Algumas alterações ocorrem de forma assíncrona e devem ser acompanhadas por Webhooks ou consultas posteriores.

6. Concilie o pagamento

Ao receber uma atualização:

identifique a cobrança pelo campo id;
localize o registro correspondente no seu sistema;
valide o novo status;
atualize o pedido, serviço ou saldo interno;
registre a data e o resultado do processamento.

Utilize externalReference para relacionar a cobrança a um pedido, contrato ou registro da sua aplicação.

Implemente idempotência para evitar que um mesmo evento seja processado mais de uma vez.

Configure as notificações

O Asaas pode enviar notificações relacionadas às cobranças por canais como e-mail, SMS ou WhatsApp, conforme a disponibilidade e a configuração da conta.

As notificações podem incluir:

aviso de criação da cobrança;
lembrete antes do vencimento;
aviso no dia do vencimento;
aviso de atraso;
lembretes após o vencimento;
aviso de atualização;
envio da linha digitável.

Consulte o guia de Notificações.

👍
Recomendado
Defina a estratégia de comunicação antes de criar os clientes e as cobranças, evitando notificações duplicadas entre o Asaas e a sua aplicação.

Cuidados importantes

Armazene os IDs do cliente e da cobrança.
Utilize externalReference para facilitar a conciliação.
Valide cliente, valor e vencimento antes da criação.
Evite cobranças duplicadas em retentativas e reprocessamentos.
Implemente idempotência no processamento dos Webhooks.
Trate falhas e recusas de cartão.
Considere as regras de vencimento e expiração de boleto e Pix.
Não considere uma cobrança criada como uma cobrança paga.
Consulte novamente a operação quando houver timeout ou resposta inconclusiva antes de repetir a criação.

Próximos passos

Updated 5 days ago

Did this page help you?