Recupera os dados e o estado atual de uma instrução de pagamento de Pix Automático pelo ID.
Use esta operação para consultas pontuais quando o identificador da instrução já for conhecido, inclusive para confirmar seu estado atual ou investigar uma recusa. Para localizar instruções quando o ID não for conhecido, utilize Listar instruções de pagamento.
A resposta permite relacionar a instrução à cobrança por paymentId e à autorização de origem por authorization.id. Quando status for REFUSED, utilize refusalReason para identificar a causa da recusa.
A API Key utilizada deve possuir a permissão PIX_AUTOMATIC:READ.
Acompanhamento de mudançasPara acompanhar agendamento, recusa e cancelamento das instruções, utilize Webhooks em vez de consultar este endpoint repetidamente.
O estado
DONEpode 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.
Conteúdos relacionados
Guides
Webhooks
Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.
Not found