Listar instruções de pagamento

Lista as instruções de pagamento de Pix Automático conforme os filtros informados.

Cada instrução representa o processamento de uma cobrança recorrente na instituição do pagador. Use esta operação para localizar instruções por autorização, cliente, cobrança ou estado atual.

Para consultar os detalhes de uma instrução específica, utilize Recuperar uma única instrução de pagamento.

📘

Acompanhamento de mudanças

Para acompanhar criação, agendamento, recusa e cancelamento das instruções, utilize Webhooks em vez de consultar este endpoint repetidamente.

O estado DONE pode ser retornado pela API, mas a conclusão financeira da cobrança deve ser acompanhada pelos eventos de cobrança previstos no fluxo do Pix Automático.

Consulte os Fluxos de Webhook do Pix Automático.

Conteúdos relacionados

Guides

Webhooks

Query Params
string

Filtrar pelo identificador único da autorização da instrução

string

Filtrar pelo identificador único do cliente

string

Filtrar pelo identificador único da cobrança

string
enum

Filtrar pelo status da instrução

Allowed:
Responses

403

Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json