Consultar um agendamento

POST

/api/PixAutomatico/Pagador/ConsultarAgendamento

PixAutomatico

Funcionalidade principal

O endpoint Pagador/ConsultarAgendamento recupera os dados granulares de um único lançamento futuro. Enquanto a listagem oferece uma visão geral, a consulta por ID revela detalhes como a identificação enviada pelo recebedor, o status exato do processamento e o vínculo com o contrato de recorrência original.

Casos de uso comuns

Auditoria de cobrança: O usuário clica em um agendamento específico no extrato de "Futuros" para verificar se o valor cobrado por uma empresa de serviços variáveis (ex: conta de água) está correto.

Verificação de status de falha: Se um agendamento não foi liquidado, o usuário consulta este endpoint para entender o motivo técnico (saldo insuficiente, teto excedido, etc.).

Preparação para cancelamento: Obter os detalhes necessários de um agendamento antes de decidir cancelá-lo individualmente.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Correto

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/PixAutomatico/Pagador/ConsultarAgendamento' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "IdAgendamento": 0
    }
}'

Response Example

{
    "Data": {
        "Id": 0,
        "DataGravacao": "string",
        "Valor": 0,
        "StatusAgendamento": "string",
        "StatusRecorrencia": "string",
        "DataEfetivacaoAgendamento": "string",
        "RecebedorNome": "string",
        "RecebedorInstituicao": "string",
        "RecebedorCpfCnpj": "string",
        "NumeroContrato": "string",
        "IdentificacaoOpcional": "string",
        "ValorPisoMaximo": 0,
        "Frequencia": "string",
        "DataProximoPagamento": "string",
        "DataUltimoPagamento": "string",
        "Recorrencia": {
            "IdRecorrencia": 0,
            "DataGravacao": "string"
        }
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:22:05

Página anterior

Listar pagamentos agendados, pagos ou cancelados

Próxima página

Cancelar um agendamento de pagamento da recorrência

Consultar um agendamento

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns