6.3. Solicitar Informações de Pagamentos do Sacado¶

🔗 Endpoint¶

Método	URL
	`/public/api/v1/duplicata-escritural/sacados/solicitar-informacoes-pagamentos`

🧾 Descrição¶

Solicita informações sobre os pagamentos de duplicatas vinculadas a um sacado. Permite filtrar por CPF/CNPJ, ISPB, identificadores específicos de duplicatas e período de vencimento. O resultado é retornado de forma assíncrona via WebHook.

📤 Requisição¶

📋 Payload (JSON)¶

{
  "tipoPessoaSacado": 2,
  "cpfOuCnpjSacado": "98765432000155",
  "indicadorISPBSacado": "60701190",
  "codigoIdentificacaoDuplicata": [
    "DUP-2025-001",
    "DUP-2025-002"
  ],
  "dataInicioVencimento": "2025-09-01",
  "dataFimVencimento": "2025-12-31"
}

🧾 Detalhamento dos Campos¶

Campo	Tipo	Obrigatório	Descrição
tipoPessoaSacado	integer	Não	Tipo do documento do sacado (ver TipoDocumentoPessoa)
cpfOuCnpjSacado	string	Não	CPF ou CNPJ do sacado para filtro (somente números)
indicadorISPBSacado	string	Não	Código ISPB do banco do sacado
codigoIdentificacaoDuplicata	string[]	Não	Lista de códigos de identificação de duplicatas específicas
dataInicioVencimento	string	Não	Data de início do período de vencimento (YYYY-MM-DD)
dataFimVencimento	string	Não	Data de fim do período de vencimento (YYYY-MM-DD)

🔢 TipoDocumentoPessoa¶

Código	Significado
1	CPF
2	CNPJ

🧪 Exemplo de cURL¶

curl -X POST https://api.vehub.com.br/public/api/v1/duplicata-escritural/sacados/solicitar-informacoes-pagamentos \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d '{
    "tipoPessoaSacado": 2,
    "cpfOuCnpjSacado": "98765432000155",
    "dataInicioVencimento": "2025-09-01",
    "dataFimVencimento": "2025-12-31"
  }'

📥 Responses¶

✅ 200 OK¶

{
  "mensagem": "Solicitação de informações de pagamentos registrada com sucesso!"
}

✅ 202 Accepted¶

{
  "mensagem": "Solicitação recebida e será processada em breve.",
  "identificadorProcessamento": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890"
}

❌ 400 Bad Request¶

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Período de vencimento inválido: dataFimVencimento deve ser maior ou igual a dataInicioVencimento."
  ]
}

🕒 Observações¶

Todos os campos são opcionais, permitindo uma consulta ampla ou filtrada conforme necessário.
O resultado é retornado de forma assíncrona via WebHook.
Quando o retorno for 202 Accepted, o processamento ocorrerá de forma assíncrona.