Skip to main content
Use estas consultas para acompanhar as recorrências: quais foram autorizadas, quais estão pendentes ou canceladas e quais cobranças estão agendadas.
Hoje, o Pix Automático não tem webhooks próprios de autorização nem de agendamento. Consulte periodicamente para acompanhar as mudanças de status. O pagamento de cada cobrança chega pelo webhook PIX_RECEIVED, como qualquer Pix recebido.

​
Listar autorizações

O parâmetro flow é obrigatório e define de que lado você está: Filtros opcionais: status, authorizationResult, beneficiaryDocument, payerDocument, payerPersonType, payerAgencyNumber, payerAccountNumber e intervalos de data (recurrenceStartDateFrom/To, recurrenceCreatedDateTimeFrom/To, recurrenceUpdatedDateTimeFrom/To). A lista vem ordenada pela última atualização, da mais recente para a mais antiga.

​
Consultar uma autorização

Use o id da listagem, que é um GUID interno. Não é o recurrenceId.
cURL
Se o id não existir, a resposta é 204 No Content, sem corpo.

​
Status da autorização

A autorização tem dois campos de status. O authorizationResult diz o que o pagador decidiu. O status diz se o processamento terminou. Uma recorrência ativa tem authorizationResult igual a ACCEPTED e status igual a SUCCESS.

​
Listar agendamentos

Os agendamentos são as cobranças de cada ciclo, à espera da data de débito.
Nos agendamentos, o flow é invertido em relação às autorizações: 0 é o lado recebedor e 1 é o lado pagador.

​
Status do agendamento

O schedulePurpose indica o tipo da cobrança: FIRST_ATTEMPT (cobrança original do ciclo), RETRY_AFTER_EXPIRATION (retentativa após o vencimento) ou RESEND_DUE_TO_SETTLEMENT_ERROR (reenvio por erro na liquidação).

​
Paginação

As duas listagens retornam o array no corpo. A paginação vem no header Pagination, com chaves em PascalCase:
Header

​
Referência da API

Listar autorizações

GET /baas/api/v1/pix/automatic/authorizations

Consultar autorização

GET /baas/api/v1/pix/automatic/authorizations/{id}

Listar agendamentos

GET /baas/api/v1/pix/automatic/scheduling