Pular para o conteúdo principal

Consulta de CPF

O serviço de consulta de CPF permite que o usuário envie uma solicitação de saldo com um CPF específico, indicando o processador responsável pela operação. O serviço retorna o status da consulta e as informações relacionadas ao CPF solicitado.

Endpoint​

  • Método: POST
  • URL: https://bff-dev.granatech.com.br/api/balance-solicitation

Corpo da Requisição​

A requisição deve incluir os seguintes campos:

  • document (string): CPF a ser consultado (formato 000.000.000-00).
  • processorName (string): Nome do processador que irá realizar a consulta. Atualmente, os valores permitidos são UY3, ZIPDIN e QITECH.
  • name (string, opcional): Nome para identificar a consulta além do CPF.

Exemplo de Corpo da Requisição​

{
  "document": "013.628.991-60",
  "processorName": "ZIPDIN",
  "name": "Samira"
}

Exemplo de Requisição com curl​

curl -X POST https://bff-dev.granatech.com.br/api/balance-solicitation \
  -H "Content-Type: application/json" \
  -d '{"document": "013.628.991-60", "processorName": "ZIPDIN", "name": "Samira"}'

Resposta da API​

A resposta bem-sucedida da API retorna um objeto JSON contendo informações sobre a solicitação de saldo.

Exemplo de Resposta​

{
  "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",
  "BalanceSolicitationStatus": {
    "id": "PENDING",
    "statusMessage": "ENVIANDO_A_BANCARIZADORA",
    "createdAt": "2024-10-14T00:04:00.232Z"
  }
}

Descrição dos Campos da Resposta​

  • id (string): Identificador único da solicitação de saldo.
  • document (string): CPF do usuário solicitado (sem formatação).
  • name (string): Nome associado à consulta, se fornecido.
  • status (string): Status da solicitação (por exemplo, PENDING).
  • visible (boolean): Indica se a solicitação é visível.
  • userId (string): Identificador do usuário que realizou a solicitação.
  • processorId (string): Identificador do processador que irá realizar a consulta.
  • corbanId (integer): Identificador do Corban associado à consulta.
  • createdAt (string): Data e hora de criação da solicitação.
  • BalanceSolicitationStatus (object): Detalhes sobre o status da solicitação, incluindo:
    • id (string): Identificador do status (por exemplo, PENDING).
    • statusMessage (string): Mensagem que descreve o status atual (por exemplo, ENVIANDO_A_BANCARIZADORA).
    • createdAt (string): Data e hora em que o status foi atualizado.

Notas​

  • Certifique-se de fornecer o CPF corretamente formatado para que a consulta seja processada adequadamente.
  • Utilize o campo name para identificar a consulta de forma única, caso necessário.
  • O campo processorName aceita apenas os valores: UY3, ZIPDIN, ou QITECH.
  • Para verificar o status da solicitação, consulte o campo BalanceSolicitationStatus na resposta.