ℹ️
Vá para a referência da API para acessar os exemplos completos de requisição e resposta.

⚠️
Agendamentos só podem ser criados a partir de autorizações que já foram aprovadas pelo pagador.

Para que você possa usar todos os recursos disponíveis em nossa API, é importante que antes você conheça os conceitos envolvidos no agendamento de uma cobrança de Pix automático.

Cada agendamento de cobrança pode conter uma ou mais tentativas de cobrança (ex: primeira tentativa, segunda, terceira...), conforme a política de retentativa definida.

O status do agendamento representa a visão geral do ciclo da cobrança.
O status da tentativa representa a situação específica de cada tentativa individual.

Essa distinção é fundamental para conciliação, retentativas e análise de falha ou sucesso.

Status de um agendamento

Nome	Descrição
`CRIADA`	O agendamento foi criado pelo recebedor e está aguardando envio ao PSP Recebedor.
`ATIVA`	O agendamento foi aceito pelo PSP Recebedor e está válido para execução nas datas previstas.
`CANCELADA`	O agendamento foi cancelado manualmente pelo recebedor (merchant) ou pelo usuário pagador antes da cobrança.
`REJEITADA`	O agendamento foi rejeitado pelo PSP Pagador, normalmente por recusa da autorização ou erro.
`EXPIRADA`	O agendamento foi encerrado automaticamente após todas as tentativas de cobrança falharem dentro da política definida.
`CONCLUIDA`	A cobrança foi realizada com sucesso e o valor foi liquidado via Pix para o recebedor.

Ciclo de vida

Cada agendamento criado evolui por um conjunto simples e previsível de status. Essa estrutura facilita a conciliação, o monitoramento e o tratamento automático no seu sistema.

Abaixo, detalhamos cada etapa do processo, conforme representado no diagrama de transição de estados:

⬜️ CRIADA

O agendamento foi criado pelo recebedor, mas ainda não processado pelo PSP Recebedor.

➡️ Pode evoluir para:

🟦 ATIVA
🟥 CANCELADA
🟨 REJEITADA
🟧 EXPIRADA

🟦 ATIVA

O agendamento foi aceito pelo PSP Recebedor e está válido para execução na data prevista, seguindo a política de retentativas se necessário.

➡️ Pode evoluir para:

🟩 CONCLUÍDA
🟥 CANCELADA
🟨 REJEITADA
🟧 EXPIRADA

🟩 CONCLUÍDA

A cobrança foi executada com sucesso e o valor liquidado via SPI.

➡️ Pode seguir para:

Esse é seu estado final;

🟧 EXPIRADA

Todas as tentativas de cobrança falharam, e o prazo máximo definido na política vigente foi atingido.

➡️ Pode evoluir para:

Esse é seu estado final;

🟥 CANCELADA

O agendamento foi cancelado manualmente, seja pelo recebedor (merchant) ou pelo usuário pagador.

➡️ Pode evoluir para:

Esse é seu estado final;

🟨 REJEITADA

O agendamento foi recusado pelo PSP Pagador, geralmente por negativa do cliente, erro de autenticação ou configuração da instituição.

➡️ Pode evoluir para:

Esse é seu estado final;

Status de uma tentativa de cobrança

As tentativas ocorrem dentro do contexto de um agendamento ativo e refletem o progresso ou resultado de cada envio de cobrança ao pagador.

Status	Descrição
`SOLICITADA`	A tentativa foi iniciada e enviada ao PSP Pagador.
`AGENDADA`	O PSP Pagador aceitou a cobrança e programou o débito conforme as regras do pagador.
`CANCELADA`	A tentativa foi cancelada antes da execução (por pagador ou sistema).
`REJEITADA`	A tentativa foi rejeitada pelo PSP Pagador (ex: erro na conta, cliente recusou, etc).
`EXPIRADA`	A tentativa foi executada, mas não teve saldo ou não houve pagamento no prazo.
`PAGA`	A tentativa resultou em liquidação bem-sucedida.

Relacionamento entre agendamento e tentativas

Status do agendamento	Tentativas esperadas
`CRIADA`	Nenhuma tentativa ainda foi realizada.
`ATIVA`	Tentativas podem ocorrer e mudar de status conforme a execução e política de retentativa.
`CANCELADA`	Pode conter tentativas com status `CANCELADA`.
`REJEITADA`	Pode conter tentativas com status `REJEITADA`.
`EXPIRADA`	Última tentativa tem status `EXPIRADA`.
`CONCLUIDA`	Última tentativa tem status `PAGA`.