Fluxos de Webhook do Pix Automático
Entenda os fluxos de Webhook do Pix Automático
Acompanhe o ciclo de vida das autorizações e instruções de pagamento do Pix Automático pelos eventos enviados por Webhook.
Esta página apresenta as sequências esperadas de eventos. Para consultar todos os eventos, payloads e campos retornados, acesse Eventos para Pix Automático.
Antes de começar
Antes de acompanhar os fluxos:
- implemente a criação da autorização e das cobranças recorrentes;
- configure um Webhook para receber os eventos do Pix Automático.
Consulte:
AtençãoOs Webhooks seguem a premissa at least once. Um mesmo evento pode ser reenviado.
Utilize o
iddo evento para implementar idempotência e não dependa apenas da ordem de entrega para determinar o estado atual do recurso.
Fluxo da autorização
Na Jornada 3, a autorização é ativada após a conclusão do primeiro pagamento.
Se o QR Code expirar sem pagamento ou o pagador não concluir o processo de autorização, ela pode ser recusada.
%%{init: {"flowchart": {"nodeSpacing": 28,"rankSpacing": 32,"diagramPadding": 8,"padding": 10}}}%%
flowchart TD
A["PIX_AUTOMATIC_RECURRING<br/>AUTHORIZATION_CREATED"] --> B{"Primeiro pagamento<br/>foi concluído?"}
B --> BSim(("Sim"))
B --> BNao(("Não"))
BSim --> C["PAYMENT_CREATED"]
C --> D["PAYMENT_RECEIVED"]
D --> E["PIX_AUTOMATIC_RECURRING<br/>AUTHORIZATION_ACTIVATED"]
BNao --> F["PIX_AUTOMATIC_RECURRING<br/>AUTHORIZATION_REFUSED"]
classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px,font-size:17px
classDef decisao fill:#FEF3C7,stroke:#D97706,color:#78350F,stroke-width:3px,font-size:17px
classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px,font-size:17px
classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px,font-size:17px
classDef analise fill:#FEE2E2,stroke:#DC2626,color:#7F1D1D,stroke-width:3px,font-size:17px
classDef respostaSim fill:#22C55E,stroke:#15803D,color:#FFFFFF,stroke-width:3px,font-size:16px
classDef respostaNao fill:#EF4444,stroke:#B91C1C,color:#FFFFFF,stroke-width:3px,font-size:16px
class A inicio
class B decisao
class C,D validacao
class E sucesso
class F analise
class BSim respostaSim
class BNao respostaNao
linkStyle default stroke:#94A3B8,stroke-width:2px
linkStyle 1 stroke:#22C55E,stroke-width:4px
linkStyle 2 stroke:#EF4444,stroke-width:4px
Com a autorização em ACTIVE, novas cobranças recorrentes podem ser vinculadas a ela.
Encerramento da autorização
Após a ativação, acompanhe também os eventos que encerram a recorrência:
| Evento | Quando ocorre | Efeito |
|---|---|---|
PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED | A autorização é cancelada | Novas instruções de pagamento deixam de ser criadas |
PIX_AUTOMATIC_RECURRING_AUTHORIZATION_EXPIRED | A autorização atinge o finishDate | A recorrência deixa de permanecer ativa |
Quando uma autorização é cancelada, instruções já agendadas também podem ser canceladas.
Fluxo das instruções de pagamento
Ao criar uma cobrança vinculada a uma autorização ativa, o Asaas gera uma instrução de pagamento para o banco pagador.
A instrução pode ser recusada durante o agendamento ou após ter sido agendada.
%%{init: {"flowchart": {"nodeSpacing": 28,"rankSpacing": 32,"diagramPadding": 8,"padding": 10}}}%%
flowchart TD
A["PAYMENT_CREATED"] --> B["PIX_AUTOMATIC_RECURRING<br/>PAYMENT_INSTRUCTION<br/>CREATED"]
B --> C{"Agendamento<br/>foi aceito?"}
C --> CSim(("Sim"))
C --> CNao(("Não"))
CSim --> D["PIX_AUTOMATIC_RECURRING<br/>PAYMENT_INSTRUCTION<br/>SCHEDULED"]
CNao --> E["PIX_AUTOMATIC_RECURRING<br/>PAYMENT_INSTRUCTION<br/>REFUSED"]
D --> F{"Pagamento<br/>foi liquidado?"}
F --> FSim(("Sim"))
F --> FNao(("Não"))
FSim --> G["PAYMENT_CONFIRMED"]
FNao --> H["PIX_AUTOMATIC_RECURRING<br/>PAYMENT_INSTRUCTION<br/>REFUSED"]
classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px,font-size:17px
classDef decisao fill:#FEF3C7,stroke:#D97706,color:#78350F,stroke-width:3px,font-size:17px
classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px,font-size:17px
classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px,font-size:17px
classDef analise fill:#FEE2E2,stroke:#DC2626,color:#7F1D1D,stroke-width:3px,font-size:17px
classDef respostaSim fill:#22C55E,stroke:#15803D,color:#FFFFFF,stroke-width:3px,font-size:16px
classDef respostaNao fill:#EF4444,stroke:#B91C1C,color:#FFFFFF,stroke-width:3px,font-size:16px
class A inicio
class C,F decisao
class B,D validacao
class G sucesso
class E,H analise
class CSim,FSim respostaSim
class CNao,FNao respostaNao
linkStyle default stroke:#94A3B8,stroke-width:2px
linkStyle 2 stroke:#22C55E,stroke-width:4px
linkStyle 3 stroke:#EF4444,stroke-width:4px
linkStyle 7 stroke:#22C55E,stroke-width:4px
linkStyle 8 stroke:#EF4444,stroke-width:4px
Uma instrução recusada pode indicar falha no agendamento ou na liquidação, como ausência de saldo ou limite no banco pagador.
Consulte Motivos de Recusa para identificar o comportamento esperado em cada cenário.
Cancelamento das instruções
Além das recusas, uma instrução agendada pode ser cancelada.
| Cenário | Sequência esperada |
|---|---|
| Instrução cancelada | PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CANCELLED |
| Cobrança paga por outro meio | PAYMENT_CONFIRMED → PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CANCELLED |
| Autorização cancelada com instrução agendada | PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED → PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CANCELLED |
Se a cobrança for paga por outro meio, a instrução automática é cancelada para evitar uma nova execução.
Como tratar os eventos
Ao receber um evento:
- utilize o
idpara evitar processamento duplicado; - relacione o recurso retornado aos registros da sua aplicação;
- atualize o estado interno conforme o evento recebido;
- consulte o recurso pela API quando precisar confirmar seu estado atual.
Para conhecer os payloads e campos específicos de autorizações, instruções e elegibilidade, consulte Eventos para Pix Automático.
Próximos passos
Updated 15 days ago
