Listar pagamentos agendados, pagos ou cancelados

POST

/api/PixAutomatico/Pagador/ListarAgendamentos

PixAutomatico

Funcionalidade principal

O endpoint Pagador/ListarAgendamentos recupera a lista de parcelas ou débitos individuais que estão na "fila" para serem processados. Enquanto a lista de recorrências mostra os "contratos", este endpoint mostra os lançamentos futuros, permitindo que o usuário saiba exatamente quanto e quando sairá dinheiro de sua conta nos próximos dias ou meses.

Casos de uso comuns

Previsão de gastos: O usuário consulta o App para ver quais contas de consumo (luz, internet, condomínio) já foram agendadas pelas empresas para o mês atual.

Conferência de valores: Verificar se o valor agendado por uma empresa de serviços variáveis está de acordo com o esperado antes que o débito ocorra.

Gestão de saldo: Planejar a manutenção de saldo em conta para garantir que os agendamentos pendentes sejam liquidados sem erros.

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/ListarAgendamentos' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "Status": [
            "Agendados"
        ]
    }
}'

Response Example

{
    "Data": {
        "Id": 0,
        "DataGravacao": "string",
        "RecebedorNome": "string",
        "RecebedorCnpj": "string",
        "Frequencia": "string",
        "Valor": 0,
        "DataAgendamento": "string",
        "DataPagamento": "string",
        "HoraPagamento": "string",
        "Status": "Agendado"
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:21:40

Página anterior

Cancelar uma recorrência cadastrada

Próxima página

Consultar um agendamento

Listar pagamentos agendados, pagos ou cancelados

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns