Listar Operações Crédito CLT

Este endpoint retorna a lista de operações de Crédito Privado CLT cadastradas no sistema, permitindo filtrar e identificar o status atual de cada operação.
Os status refletem a fase do processo em que a operação se encontra, desde a análise inicial até a liquidação ou cancelamento.

Endpoint listar as operações de crédito clt

URL: https://bff.v8sistema.com/private-consignment/operation

Método HTTP: GET

Autenticação: Requer token JWT válido no header da requisição.

Exemplo de requisição

https://bff.v8sistema.com/private-consignment/operation?startDate=2025-08-14T00%3A00%3A00.000Z&endDate=2025-08-14T20%3A00%3A00.000Z&limit=1&page=2&provider=QI

Parâmetros da Requisição

startDate string indica o início do intervalo de busca por operações. No exemplo, é "2025-08-14T00:00:00.000Z", ou seja, meia-noite do dia 14 de agosto de 2025 (UTC).
endDate string marca o final do intervalo de consulta. No exemplo, "2025-08-14T20:00:00.000Z", ou seja, 20h do mesmo dia (UTC).
limit string define o número máximo de registros que devem ser retornados pela chamada. Neste caso, o valor 1 indica que queremos somente um resultado por página.
page string indica qual página de resultados deve ser retornada, no contexto de paginação, sendo 2 o segundo bloco de resultados com base no limit.
provider string especifica o identificador do provedor para o qual se quer listar as operações — aqui é QI.

Resposta

Em caso de sucesso (código HTTP 200), a resposta será a seguinte

{
      "operationId": "3af47cb5-f116-4d3b-bd92-9706058c84c4",
      "issueAmount": "3895.19",
      "disbursedIssueAmount": "3791.53",
      "documentNumber": "03898739007",
      "contractNumber": "ZIS749878677",
      "name": "GABRIEL FRANCA",
      "partnerId": "12548",
      "partnerInternalId": "0bd9c031-fcd6-43dc-9937-68ca0f557af1",
      "status": "formalization",
      "history": [
        {
          "id": "0083af6f-57eb-4aaf-83de-3eaddadb929c",
          "action": "created",
          "partner_id": "12548",
          "partner_internal_id": "0bd9c031-fcd6-43dc-9937-68ca0f557af1",
          "description": "",
          "reason": "",
          "created_at": "2025-08-14T17:57:06.017746"
        }
      ],
      "createdAt": "2025-08-14T17:57:06.017Z"
    }

operationId string
Identificador único da operação de crédito CLT no sistema da V8 Digital, usado para consultas e ações posteriores relacionadas à mesma.
issueAmount string

Valor bruto contratado da operação, antes de qualquer desconto ou taxa, representado como string para manter a precisão decimal.
disbursedIssueAmount string

Valor líquido efetivamente liberado ao cliente, após deduções como tarifas, seguros ou encargos.
documentNumber string

Número do documento do cliente (CPF), retornado sem formatação.
contractNumber string

Número do contrato gerado para a operação no provedor parceiro.
name string

Nome completo do cliente tomador do crédito.
partnerId string
Código identificador do parceiro comercial vinculado à operação, conforme padrão interno da V8 Digital.
partnerInternalId string
Identificador único interno do parceiro no sistema, no formato UUID.
status string
Status atual da operação, podendo assumir valores como: formalization, analysis, manual_analysis, awaiting_call, processing, paid, canceled, pending, refunded.
history string
Lista contendo o histórico de eventos da operação, onde cada item descreve uma ação registrada durante o ciclo de vida da proposta.
- id string
  Identificador único do evento no histórico.
- action string
  Ação realizada, como por exemplo created, updated, canceled.
- partner_id string
  Identificador do parceiro no contexto do evento registrado.
- partner_internal_id string
  Identificador interno do parceiro no contexto do evento.
- description string
  Texto descritivo sobre o evento (pode estar vazio caso não haja descrição específica).
- reason string
  Motivo associado ao evento (pode estar vazio).
- created_at string
  Data e hora em que o evento foi registrado, no formato ISO 8601.
createdAt string
Data e hora da criação da operação no sistema, no formato ISO 8601.

Descrição dos possíveis status:

formalization → Aguardando formalização (assinatura do contrato e confirmação de aceite).
analysis → Em análise automática pelos sistemas de crédito.
manual_analysis → Em análise manual por equipe de crédito.
awaiting_call → Aguardando contato telefônico ou retorno do cliente.
processing → Proposta aprovada e em processamento para pagamento.
paid → Operação liquidada e valor creditado.
canceled → Operação cancelada antes da formalização ou liquidação.
pending → Operação com pendências a serem resolvidas.
refunded → Operação reembolsada após liquidação ou cancelamento com valor devolvido.

Endpoint para visualizar os dados de uma operação crédito CLT

URL: https://bff.v8sistema.com/private-consignment/operation/{idOperation}

Método HTTP: GET

Autenticação: Requer token JWT válido no header da requisição.

Resposta

Em caso de sucesso (código HTTP 200), a resposta será a seguinte

{
  "id": "string",
  "status": "string",
  "document_number": "string",
  "partner_id": "string",
  "partner_internal_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "contract_number": "string",
  "contract_url": "string",
  "borrower": {
    "id": "string",
    "name": "string",
    "email": "string",
    "individual_document_number": "string",
    "document_number": "string",
    "document_type": "string",
    "mother_name": "string",
    "gender": "string",
    "birth_date": "string",
    "registration_number": "string",
    "nationality": "string",
    "marital_status": "string",
    "person_type": "string",
    "political_exposition": true,
    "created_at": "string",
    "borrower_phone": {
      "id": "string",
      "number": "string",
      "area_code": "string",
      "country_code": "string"
    },
    "borrower_address": {
      "id": "string",
      "city": "string",
      "state": "string",
      "number": "string",
      "street": "string",
      "complement": "string",
      "postal_code": "string",
      "neighborhood": "string"
    },
    "borrower_bank": {
      "bank_id": "string",
      "bank_code": "string",
      "account_digit": "string",
      "branch_number": "string",
      "account_number": "string",
      "pix_key": "string",
      "pix_key_type": "string",
      "transfer_method": "string",
      "percentage_receivable": 0,
      "active": true
    }
  },
  "operation_call": {
    "id": "string",
    "call_url": "string",
    "ip_approver": "string",
    "user_requester": "string",
    "approver": "string",
    "approved_at": "string",
    "finished": true
  },
  "operation_data": {
    "operation_amount": "string",
    "disbursed_issue_amount": "string",
    "issue_amount": "string",
    "first_due_date": "string",
    "number_of_installments": 0,
    "monthly_interest_rate": "string",
    "installment_face_value": "string"
  },
  "operation_history": [
    {
      "id": "string",
      "action": "string",
      "partner_id": "string",
      "partner_internal_id": "string",
      "description": "string",
      "reason": "string",
      "created_at": "string"
    }
  ],
  "formalizations": [
    {
      "status": "string",
      "score": "string",
      "documents": [
        {
          "document_type": "string",
          "presigned_url": "string"
        }
      ]
    }
  ],
  "consult_data": {
    "employer_document_number": "string",
    "employer_name": "string"
  },
  "provider": "string",
  "regular_at_the_federal_revenue_checked": true