get
https://api-sandbox.asaas.com/v3/pix/automatic/paymentInstructions
Endpoint utilizado para consultar as instruções de pagamento associadas a autorizações de Pix Automático.
Cada instrução representa uma tentativa de cobrança automática vinculada a uma cobrança criada no sistema.
Quando uma cobrança recorrente é criada utilizando o campo pixAutomaticAuthorizationId, o Asaas gera automaticamente uma instrução de pagamento para aquela cobrança.
Essa instrução é enviada ao banco do pagador, que agenda o débito automático na data de vencimento da cobrança.
Parâmetros de consulta
authorizationId- Filtra as instruções vinculadas a uma autorização específica de Pix Automático.customerId- Filtra as instruções vinculadas a um cliente específico.paymentId- Filtra as instruções associadas a uma cobrança específica.status- Permite filtrar as instruções pelo status atual do processamento do pagamento.
Status das instruções de pagamento
| Status | Descrição |
|---|---|
AWAITING_REQUEST | A instrução foi criada e está aguardando envio para o banco do pagador. |
SCHEDULED | O banco do pagador aceitou o agendamento do pagamento. |
DONE | O pagamento foi realizado com sucesso. |
REFUSED | O pagamento não foi realizado. Pode ocorrer por falta de saldo ou recusa do banco pagador. |
CANCELLED | A instrução foi cancelada antes da execução do pagamento. |
Casos de uso
Esse endpoint é útil para:
- acompanhar o processamento das cobranças automáticas
- monitorar o agendamento de pagamentos no banco do pagador
- diagnosticar falhas no fluxo de pagamento
- consultar o histórico de tentativas de pagamento automático
Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio.