Pular para o conteúdo principal

Visualizar Consultas de CPF

Este serviço permite visualizar as consultas de CPF realizadas, podendo listar todas as consultas de um Corban específico ou consultar uma solicitação individualmente pelo seu balanceSolicitationId.

Endpoint para Listar Consultas​

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/balance-solicitation/corban/{corbanId}

Parâmetros​

  • corbanId (number): ID do Corban pelo qual as consultas devem ser filtradas.

Exemplo de Requisição para Listar Consultas com curl​

curl -X GET https://bff-dev.granatech.com.br/api/balance-solicitation/corban/1

Exemplo de Resposta para Listar Consultas​

A resposta da API é um array de objetos JSON, onde cada objeto representa uma consulta de CPF.

[
  {
    "id": "adfed500-a70a-4df2-a729-4bfffc407a7a",
    "document": "01653826355",
    "name": "",
    "status": "SUCCESS",
    "visible": true,
    "userId": "32194952055.1",
    "processorId": "dc7b2a77-5598-47e2-b0e7-99494628bc3f",
    "corbanId": 1,
    "createdAt": "2024-11-11T20:13:11.782Z",
    "User": {
      "id": "32194952055.1",
      "name": "Luis",
      "lastName": "Silva",
      "document": "32194952055",
      "email": "luis@hotmail.com",
      "cellphone": "38743255161",
      "enabled": true,
      "corbanId": 1
    },
    "Processor": {
      "id": "dc7b2a77-5598-47e2-b0e7-99494628bc3f",
      "name": "UY3",
      "ranking": 2,
      "tac": 0.4
    },
    "BalanceSolicitationStatus": {
      "id": "SUCCESS",
      "statusMessage": "CONSULTA_REALIZADA_COM_SUCESSO",
      "createdAt": "2024-10-14T00:04:00.252Z"
    }
  }
]

Endpoint para Consultar uma Solicitação Específica​

  • Método: GET
  • URL: https://bff-dev.granatech.com.br/api/balance-solicitation/{balanceSolicitationId}

Parâmetros​

  • balanceSolicitationId (string): ID da solicitação específica de saldo a ser consultada.

Exemplo de Requisição para uma Consulta Específica com curl​

curl -X GET https://bff-dev.granatech.com.br/api/balance-solicitation/5663a569-5cae-43f9-bf5a-516eb9548d03

Exemplo de Resposta para uma Consulta Específica​

{
  "id": "5663a569-5cae-43f9-bf5a-516eb9548d03",
  "document": "01362899160",
  "name": "Samira",
  "status": "PENDING",
  "visible": true,
  "userId": "12194952055.1",
  "processorId": "dc1b2a77-5598-47e2-b0e7-99494628bc3f",
  "corbanId": 1,
  "createdAt": "2024-11-11T22:08:19.822Z",
  "User": {
    "id": "12194952055.1",
    "name": "Jota",
    "lastName": "Silva",
    "document": "12194952055",
    "email": "jota@hotmail.com",
    "cellphone": "68743255161",
    "enabled": true,
    "corbanId": 1
  },
  "Processor": {
    "id": "dc1b2a77-5598-47e2-b0e7-99494628bc3f",
    "name": "ZIPDIN",
    "ranking": 1,
    "tac": 0.7
  },
  "BalanceSolicitationStatus": {
    "id": "PENDING",
    "statusMessage": "ENVIANDO_A_BANCARIZADORA",
    "createdAt": "2024-10-14T00:04:00.232Z"
  }
}

Descrição dos Campos da Resposta​

Campos da Consulta de Saldo​

  • id (string): Identificador único da consulta de saldo.
  • document (string): CPF do usuário consultado (sem formatação).
  • name (string): Nome associado à consulta, se fornecido.
  • status (string): Status da consulta (SUCCESS, PENDING, etc).
  • visible (boolean): Indica se a consulta é visível.
  • userId (string): Identificador do usuário que realizou a consulta.
  • processorId (string): Identificador do processador responsável pela consulta.
  • corbanId (integer): Identificador do Corban associado à consulta.
  • createdAt (string): Data e hora de criação da consulta.

Informações do Usuário (User)​

  • id (string): Identificador único do usuário.
  • name (string): Nome do usuário.
  • lastName (string): Sobrenome do usuário.
  • document (string): Documento do usuário (CPF).
  • email (string): Email do usuário.
  • cellphone (string): Número de celular do usuário.
  • enabled (boolean): Indica se o usuário está ativo.
  • corbanId (integer): Identificador do Corban associado ao usuário.

Informações do Processador (Processor)​

  • id (string): Identificador único do processador.
  • name (string): Nome do processador (ex.: UY3, ZIPDIN).
  • ranking (integer): Ranking do processador.
  • tac (float): Taxa associada ao processador.

Informações do Status da Consulta (BalanceSolicitationStatus)​

  • id (string): Identificador do status (ex.: SUCCESS, PENDING).
  • statusMessage (string): Mensagem que descreve o status atual.
  • createdAt (string): Data e hora em que o status foi atualizado.

Notas​

  • Utilize o endpoint de listagem para obter todas as consultas de um Corban específico.
  • Para informações detalhadas sobre uma solicitação individual, use o endpoint específico com o balanceSolicitationId.
  • O campo statusMessage em BalanceSolicitationStatus oferece detalhes adicionais sobre o status de cada consulta.