Eventos para Pix Automático
Escute os eventos do Asaas para manter sua integração sempre em dia
Use os eventos do Pix Automático para acompanhar alterações de elegibilidade, autorizações e instruções de pagamento.
Para acompanhar as sequências entre esses eventos e os eventos das cobranças, consulte Fluxos de Webhook do Pix Automático.
Eventos disponíveis
Elegibilidade
| Evento | Quando ocorre |
|---|---|
PIX_AUTOMATIC_RECURRING_ELIGIBILITY_UPDATED | A elegibilidade da conta é alterada. Utilizado em operações com subcontas. |
Autorizações
| Evento | Quando ocorre |
|---|---|
PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CREATED | A autorização é criada. |
PIX_AUTOMATIC_RECURRING_AUTHORIZATION_ACTIVATED | A autorização é ativada após a conclusão do primeiro pagamento e da autorização pelo pagador. |
PIX_AUTOMATIC_RECURRING_AUTHORIZATION_CANCELLED | A autorização é cancelada. |
PIX_AUTOMATIC_RECURRING_AUTHORIZATION_EXPIRED | A autorização atinge o fim do período de vigência definido em finishDate. |
PIX_AUTOMATIC_RECURRING_AUTHORIZATION_REFUSED | A autorização não é concluída, como quando o QR Code expira sem pagamento ou o pagador não conclui o processo de autorização. |
Instruções de pagamento
| Evento | Quando ocorre |
|---|---|
PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CREATED | A instrução de pagamento é criada. |
PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_SCHEDULED | A instrução é agendada para processamento na instituição do pagador. |
PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_REFUSED | A instrução é recusada durante o agendamento ou processamento. |
PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_CANCELLED | A instrução é cancelada. |
Elegibilidade da conta
O evento PIX_AUTOMATIC_RECURRING_ELIGIBILITY_UPDATED informa alterações na elegibilidade da conta.
eligibility.status pode assumir:
| Status | Significado |
|---|---|
ELIGIBLE | A conta está elegível para utilizar Pix Automático. |
INELIGIBLE | A conta está inelegível para utilizar Pix Automático. |
ImportanteSe uma conta que era elegível (
ELIGIBLE) se tornar inelegível (INELIGIBLE) e posteriormente voltar a serELIGIBLE, não é necessário reconfigurar os eventos de webhook do Pix Automático. Os eventos voltarão a ser enviados normalmente.
{
"id": "evt_ID",
"event": "PIX_AUTOMATIC_RECURRING_ELIGIBILITY_UPDATED",
"dateCreated": "2026-03-05 08:24:11",
"account": {
"id": "accountId",
"ownerId": null
},
"eligibility": {
"status": "INELIGIBLE",
"ineligibleReasons": []
}
}
CampoineligibleReasonsO array
ineligibleReasonscontém a lista de motivos pelos quais a conta está inelegível.
Autorizações
Nos eventos de autorização, o objeto authorization informa o estado atual da recorrência.
authorization.status pode assumir:
| Status | Significado |
|---|---|
CREATED | A autorização foi criada, mas ainda não está ativa. |
ACTIVE | A autorização está ativa e pode ser utilizada nas cobranças recorrentes. |
CANCELLED | A autorização foi cancelada. |
EXPIRED | O período de vigência definido em finishDate foi encerrado. |
REFUSED | O processo inicial de autorização não foi concluído. |
{
"event": "PIX_AUTOMATIC_RECURRING_AUTHORIZATION_ACTIVATED",
"authorization": {
"id": "d51008fa-e28e-4823-82b4-4b1fcf485229",
"status": "ACTIVE",
"customerId": "cus_000006869125",
"frequency": "MONTHLY",
"value": 2.00,
"startDate": "2025-08-01",
"finishDate": "2028-01-01",
"immediateQrCode": {
"conciliationIdentifier": "ASAAS000000000000000000000000550ASA",
"expirationDate": "2025-07-24 18:00:20"
}
}
}Para entender a sequência entre criação, ativação, recusa, cancelamento e expiração, consulte Fluxos de Webhook do Pix Automático.
Instruções de pagamento
As instruções representam o processamento de uma cobrança recorrente na instituição do pagador.
Nos eventos desta página, paymentInstruction.status pode assumir:
| Status | Significado |
|---|---|
AWAITING_REQUEST | A instrução aguarda o envio para processamento. |
SCHEDULED | A instrução foi agendada. |
REFUSED | A instrução foi recusada. |
CANCELLED | A instrução foi cancelada. |
{
"event": "PIX_AUTOMATIC_RECURRING_PAYMENT_INSTRUCTION_SCHEDULED",
"paymentInstruction": {
"id": "f6559451-cb41-4ec6-8487-2cda59a5f184",
"status": "SCHEDULED",
"dueDate": "2024-10-04",
"paymentId": "pay_080225913252",
"authorization": {
"id": "c6b180f0-2196-454c-ac7e-72d662286bd1"
}
}
}Utilize paymentInstruction.paymentId para relacionar a instrução à cobrança e paymentInstruction.authorization.id para identificar a autorização de origem.
O recurso de instrução também pode apresentar DONE como estado atual na API. A conclusão financeira da cobrança deve ser acompanhada pelos eventos de cobrança previstos no fluxo do Pix Automático.
Consulte a referência de uma instrução de pagamento.
Campos importantes
Evento
| Campo | Descrição |
|---|---|
id | Identificador único do evento. Utilize-o para idempotência. |
event | Tipo do evento recebido. |
dateCreated | Data de geração do evento. |
account.id | Identificador da conta relacionada ao evento. |
account.ownerId | Identificador da conta raiz, quando aplicável. |
Elegibilidade
| Campo | Descrição |
|---|---|
eligibility.status | Situação atual da elegibilidade. |
eligibility.ineligibleReasons | Motivos da inelegibilidade. |
Autorização
| Campo | Descrição |
|---|---|
authorization.id | Identificador da autorização. |
authorization.status | Estado atual da autorização. |
authorization.customerId | Cliente associado. |
authorization.frequency | Periodicidade da recorrência. |
authorization.value | Valor da recorrência, quando definido. |
Instrução de pagamento
| Campo | Descrição |
|---|---|
paymentInstruction.id | Identificador da instrução. |
paymentInstruction.status | Estado atual da instrução. |
paymentInstruction.paymentId | Identificador da cobrança relacionada. |
paymentInstruction.authorization.id | Identificador da autorização associada. |
Como tratar os eventos
Ao receber um evento:
- utilize
eventpara identificar o recurso e a alteração ocorrida; - persista o
idantes do processamento para evitar duplicidade; - relacione a elegibilidade, autorização ou instrução aos registros da sua aplicação;
- atualize o estado interno conforme o payload recebido;
- responda
HTTP 200após persistir o evento; - processe regras adicionais de forma assíncrona.
Os Webhooks seguem o modelo at least once, portanto o mesmo evento pode ser reenviado. Utilize o id para implementar idempotência.
Quando utilizar authToken, valide o header asaas-access-token recebido no Webhook.
Consulte como implementar idempotência em Webhooks.
Atenção
- Com a entrada de novos produtos e funções dentro do Asaas, é possível que novos atributos sejam incluídos no Webhook. É muito importante que seu código esteja preparado para não gerar exceções caso o Asaas devolva novos atributos não tratados pela sua aplicação, pois isso poderá causar interrupção na fila de sincronização.
- Enviaremos um e-mail e avisaremos em nosso Discord quando novos campos forem incluídos no Webhook. O disparo será feito para o e-mail de notificação definido nas configurações do webhook.
Próximos passos
Updated 14 days ago
