FgtsOperation

Fluxo de utilização das APIS de FGTS

Para iniciar o processo de utilização das apis é necessário gerar o token de acesso.

1 - Verificar saldo total disponível para utilização

O primeiro passo é verificar o saldo do cliente pelo CPF através da API CheckBalance, ela vai retornar um objeto as seguintes informações:

CSS

{
  "balanceId": 0,
  "documentNumber": "string",
  "desiredAmount": 0,
  "installments": [
    {
      "dueDate": "2023-12-07T21:53:15.242Z",
      "balanceAvailable": 0,
      "anticipatedValue": 0,
      "preFixedAmount": 0,
      "taxAmount": 0
    }
  ],
  "operatingFee": 0,
  "tac": 0,
  "disbursementDate": "2023-12-07T21:53:15.242Z",
  "assignmentAmount": 0,
  "disbursedIssueAmount": 0,
  "feeAmount": 0,
  "cet": 0,
  "cetAnnual": 0,
  "iofAmount": 0,
  "totalPreFixedAmount": 0,
  "anticipatedAmount": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

2 - Consultar condições do valor desejado para compra

Depois de consultar o saldo o cliente na API de CheckBalance, podemos continuar o fluxo chamando a API de Simulate, onde será necessário passar duas informações, o balanceId e o valor que deseja sumular.

IMPORTANTE: o BalanceId é a propriedade do objeto retornando na api do CheckBalance.

Retorno é um objeto as seguintes informações:

CSS

{
  "documentNumber": "string",
  "desiredAmount": 0,
  "installments": [
    {
      "dueDate": "2023-12-06T17:58:32.324Z",
      "balanceAvailable": 0,
      "anticipatedValue": 0,
      "preFixedAmount": 0,
      "taxAmount": 0
    }
  ],
  "operatingFee": 0,
  "tac": 0,
  "disbursementDate": "2023-12-06T17:58:32.324Z",
  "assignmentAmount": 0,
  "disbursedIssueAmount": 0,
  "feeAmount": 0,
  "cet": 0,
  "cetAnnual": 0,
  "iofAmount": 0,
  "totalPreFixedAmount": 0,
  "anticipatedAmount": 0,
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

3 - Solicitar utilização do FGTS

Após a simulação API de Simulate, podemos seguir com a solicitação de utilização do FGTS na API de CreateDebit, onde será necessário passar todas as informações do cliente.

IMPORTANTE: o retorno dessa api é um texto com o código da operação

4 - Consultar dados da operação FGTS por código

Para verificar o status da operação é podemos chamar a API de GetOperation, onde será necessário passar o código da operação retornardo anteriormente na API de CreateDebit.

Retorno é um objeto as seguintes informações:

CSS

{
  "code": "string",
  "value": 0,
  "rgNumber": "string",
  "rgOrgan": "string",
  "rgState": "string",
  "rgIssueDate": "2023-12-06T17:58:32.324Z",
  "cpf": "string",
  "name": "string",
  "email": "string",
  "phone": "string",
  "birth": "2023-12-06T17:58:32.324Z",
  "gender": 0,
  "fatherName": "string",
  "motherName": "string",
  "addressStreet": "string",
  "addressNumber": "string",
  "addressAdditional": "string",
  "addressPostalCode": "string",
  "addressNeighborhood": "string",
  "addressCity": "string",
  "addressState": "string",
  "status": 0,
  "user": "string",
  "store": "string",
  "creationTime": "2023-12-06T17:58:32.324Z",
  "paymentDate": "2023-12-06T17:58:32.324Z",
  "tags": [
    "string"
  ]
}