DiscordStatus
Guias / Guides

Introdução - Cobranças

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

Você vai criar cobranças pela API do Asaas, escolher a forma de pagamento e acompanhar o status até a conciliação.

As cobranças registram valores a receber na conta Asaas e disponibilizam meios de pagamento para o cliente, como Pix, boleto bancário, cartão de crédito, cartão de débito ou TED, conforme a configuração utilizada.

Quando utilizar cobranças

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

Alguns cenários comuns incluem:

  • vendas avulsas;
  • cobrança de serviços prestados;
  • mensalidades ou pagamentos recorrentes controlados pela sua aplicação;
  • checkout transparente, com os dados enviados pelo back-end;
  • envio de uma fatura para o cliente pagar em uma tela hospedada;
  • geração de cobranças com Pix, boleto ou cartão.

Caso o objetivo seja permitir que o cliente escolha produtos, revise um resumo da compra ou acesse uma tela de pagamento hospedada com mais contexto, avalie também o uso de Link de Pagamento ou Checkout.

Antes de criar uma cobrança

Antes de criar uma cobrança:

  • cadastre um cliente no Asaas;
  • armazene o identificador do cliente, enviado no campo customer;
  • defina a forma de pagamento;
  • defina o valor da cobrança;
  • defina a data de vencimento;
  • escolha como acompanhar o status da cobrança após a criação.

O campo customer representa o ID do cliente no Asaas. Ele é retornado na criação do cliente e deve ser armazenado pela sua aplicação para uso nas próximas operações.

Fluxo básico de criação

Em uma integração típica, o fluxo de cobranças segue esta jornada:

Criar cliente
↓
Armazenar o ID do cliente
↓
Criar cobrança
↓
Exibir ou enviar a fatura ao cliente
↓
Acompanhar o status da cobrança
↓
Conciliar o pagamento no sistema de origem

Crie uma cobrança

  1. Crie um cliente e armazene o ID retornado.

  2. Crie a cobrança informando os campos principais, como:

    • customer: ID do cliente no Asaas;
    • billingType: forma de pagamento;
    • value: valor da cobrança;
    • dueDate: data de vencimento no formato AAAA-MM-DD.

  3. Escolha a forma de pagamento da cobrança. Consulte os guias:

  4. Se quiser permitir que o cliente escolha a forma de pagamento, crie uma cobrança com múltiplas opções de pagamento.

  5. Para usar a integração como checkout transparente, envie os dados da cobrança pelo back-end para a API.

  6. Para usar uma tela de pagamento hospedada, utilize a Fatura da cobrança ou crie um Link de Pagamento.

  7. Opcionalmente, configure o redirecionamento automático após o pagamento em Faturas e Links de Pagamento.

Acompanhamento da cobrança

Após a criação, acompanhe a cobrança pelo status retornado pela API ou por meio de webhooks.

Esse acompanhamento é importante para identificar eventos como:

  • cobrança criada e aguardando pagamento;
  • pagamento confirmado ou recebido;
  • cobrança vencida;
  • cobrança cancelada ou removida;
  • falha em pagamentos com cartão.

Para reduzir consultas manuais e manter seu sistema atualizado, recomendamos configurar Webhooks para receber automaticamente as mudanças de status.

Cuidados importantes

  • Armazene o ID da cobrança retornado pela API para consultas, atualizações e conciliação.
  • Evite criar cobranças duplicadas em reprocessamentos ou retentativas automáticas.
  • Valide valor, vencimento e cliente antes de enviar a requisição.
  • Em cobranças com cartão, trate retornos de falha e oriente o cliente a revisar os dados de pagamento.
  • Em cobranças com boleto ou Pix, considere o prazo de vencimento e as regras de expiração da forma de pagamento.
  • Se a cobrança estiver vinculada a processos internos, use identificadores próprios da sua aplicação para facilitar a conciliação.

Opcional: notificações de cobranças

Você pode configurar as notificações que seu cliente receberá por e-mail, SMS ou WhatsApp.

As notificações disponíveis incluem:

  1. aviso de cobrança recebida;
  2. aviso antes do vencimento;
  3. aviso no dia do vencimento;
  4. aviso de cobrança vencida;
  5. aviso periódico após o vencimento;
  6. aviso de cobrança atualizada;
  7. envio da linha digitável no dia do vencimento.

As notificações ajudam a reduzir inadimplência, mas devem ser configuradas de acordo com a jornada da sua integração e com a comunicação que sua empresa deseja manter com o cliente.

Próximos passos

Após entender o fluxo básico de cobranças, consulte os guias específicos da forma de pagamento que será utilizada:


Updated 1 day ago

Did this page help you?