Introdução - Pague contas
O Pague Contas permite criar pagamentos de boletos pela API do Asaas utilizando a linha digitável do título.
Nesta página, você entenderá o fluxo geral da operação, a diferença entre pagar no mesmo dia e agendar uma data futura e como acompanhar o processamento.
Antes de começar
Para utilizar o Pague Contas:
- a conta deve ter concluído a prova de vida;
- obtenha a linha digitável do boleto;
- considere o tipo, o valor, o vencimento e a data desejada para o pagamento;
- configure Webhooks para acompanhar as mudanças de estado da operação.
As regras de horário e processamento variam conforme o boleto. Consulte Pagamento imediato x Pagamento agendado e Regras importantes antes de implementar essas validações.
Como funciona
A criação do pagamento utiliza o endpoint POST /v3/bill. O campo identificationField informa a linha digitável, a partir da qual o Asaas identifica e valida os dados disponíveis do boleto.
Quando quiser programar o pagamento para uma data futura, utilize scheduleDate.
Consulte a referência completa do endpoint Criar um pagamento de conta.
%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
A["Obter a linha digitável"] --> B["Definir quando pagar"]
B --> C["Criar o pagamento"]
C --> D["Validar o boleto"]
D --> E["Processar a operação"]
E --> F["Receber Webhooks"]
F --> G["Atualizar o pagamento"]
classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px
classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px
classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px
class A inicio
class B,C,D,E,F validacao
class G sucesso
linkStyle default stroke:#94A3B8,stroke-width:2px
Pagamento no mesmo dia ou agendado
Escolha o fluxo conforme a necessidade da operação.
| Necessidade | Como seguir |
|---|---|
| Pagar no mesmo dia | Considere o tipo e o valor do boleto, o dia da operação e o horário-limite aplicável |
| Programar uma data futura | Informe scheduleDate e valide as regras de agendamento e vencimento |
Não fixe uma única regra de horário para todos os boletos. Contas de consumo, boletos de cobrança e operações de maior valor possuem limites diferentes.
Consulte Pagamento imediato x Pagamento agendado para implementar os dois cenários e Regras importantes para tratar as condições específicas do boleto.
Acompanhe o processamento por Webhooks
A criação da operação não confirma que o boleto foi pago. O pagamento pode passar por estados intermediários antes de ser concluído, falhar, ser cancelado ou estornado.
Utilize os Eventos para Pague Contas para receber automaticamente as mudanças de estado.
Prefira Webhooks a consultas periódicas da API. Utilize uma consulta GET quando precisar recuperar o estado atual de uma operação de forma pontual.
Consulte Status possíveis para definir como sua aplicação deve interpretar cada estado.
Sandbox
No Sandbox, utilize boletos criados na própria conta Sandbox. O ambiente simula o fluxo do Pague Contas, mas não realiza compensação bancária nem movimenta valores reais.
Use esse ambiente para validar o payload, o tratamento de erros e o recebimento de Webhooks.
Consulte Testando no Sandbox.
Próximos passos
Updated 13 days ago