Listar pagamentos agendados

POST

/api/CashOut/ConsultarPagamentosAgendados

CashOut

Funcionalidade principal

O ConsultarPagamentosAgendados recupera a lista de obrigações financeiras que aguardam o horário de corte bancário ou a data de vencimento escolhida pelo usuário para serem processadas. É essencial para a gestão de fluxo de caixa, permitindo que a empresa saiba exatamente quanto de saldo precisa manter na conta para honrar os compromissos agendados.

Casos de uso comuns

Extrato de futuros: Exibir no aplicativo do usuário uma seção de "Próximos Pagamentos" para que ele não se esqueça das contas agendadas.

Previsão de saldo: O financeiro de uma empresa consulta a API para garantir que as entradas de capital do dia serão suficientes para cobrir os boletos agendados para a tarde.

Gestão de cancelamento: Localizar o ID de um agendamento específico para que o usuário possa cancelá-lo antes da execução (usando o endpoint de cancelamento correspondente).

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

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/CashOut/ConsultarPagamentosAgendados' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCliente": 0,
        "CodigoCanal": 0,
        "DataInicial": "string",
        "DataFinal": "string",
        "Status": 0
    }
}'

Response Example

{
    "Data": [
        {
            "DataSolicitacaoAgendamento": "string",
            "DataAgendamento": "string",
            "DataVencimento": "string",
            "Valor": 0,
            "CodigoBarras": "string",
            "Status": "string",
            "Descricao": "string"
        }
    ],
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:28:01

Página anterior

Liquidar impostos e taxas governamentais

Próxima página

Cadastrar novo favorecido para TED

Listar pagamentos agendados

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns