Bankerize - FGTS icon

Bankerize - FGTS

Gerenciar operações FGTS da API Bankerize: simular propostas (incluindo por parcelas), criar propostas e consultar status. Use para realizar operações de antecipação do Saque-Aniversário FGTS.
Join our community

Actions4

Overview

This node integrates with the Bankerize API to manage FGTS (Fundo de Garantia do Tempo de Serviço) financial operations. It supports simulating loan proposals based on a client's FGTS balance, creating proposals, and consulting proposal statuses. The "Simulate" operation specifically allows users to request simulation of FGTS loan proposals by providing client identification and preferences.

Common scenarios for this node include:

  • Financial institutions or fintechs offering FGTS-backed loans who want to simulate loan conditions before creating proposals.
  • Automating the retrieval of multiple loan simulation options filtered and sorted according to business rules.
  • Integrating FGTS loan simulations into customer onboarding workflows to provide personalized financing options.

Practical example:

  • A bank wants to simulate loan proposals for a client identified by CPF, specifying a desired net loan value and filtering results to certain partner banks. The node fetches available loan tables, filters out invalid ones, sorts them by net value descending, and optionally translates response fields to Portuguese for local display.

Properties

Name Meaning
CPF Client's CPF number (Brazilian individual taxpayer registry identification), digits only, required for simulation.
Banco Partner bank for the operation. Currently supports option: BMP.
Valor Desejado Desired net loan amount (liquid value). Leave empty or "null" to request maximum possible value. Must be a number between 1 and 999,999 if provided.
Filtrar Por ID Da Tabela Filter response to show only tables with specified IDs. Use commas to separate multiple IDs. Leave empty to return all available tables. Example format: UUID strings.
Traduzir Resposta Boolean flag to translate response field names from English to Portuguese (e.g., "error" → "erro", "table" → "tabela").
Ordenar Resposta Choose how to sort returned simulations:
- Sem Ordenação (Padrão): Keep original API order
- Maior Valor Líquido Para O Cliente: Sort by net_value descending
- Maior TC: Sort by tc_percentage descending
- Menor Juros Bruto: Sort by monthly_fee ascending
- Menor CET Anual: Sort by annual_cet ascending
Restringir Tabelas Com Erro When enabled, removes all tables that have error: true in the response, useful to show only valid and usable simulations.
Formatação Brasileira When enabled, formats dates as DD/MM/YYYY and numeric values with two decimal places, suitable for Brazilian user interfaces.

Output

The output JSON structure depends on the API response for the simulation request:

  • data: An array of simulation tables, each containing:
    • error: Boolean indicating if the table has an error.
    • table: Object with table details such as id and name.
    • tc_percentage: Percentage value related to the total cost (TC).
    • simulation: Object containing:
      • rules: Simulation rules, e.g., whether installment-based simulation is allowed.
      • payload: Detailed financial data including:
        • net_value: Net loan value for the client.
        • gross_value: Gross loan value.
        • Other financial metrics like fees, interest rates, CET (total effective cost), etc.

If the "Traduzir Resposta" property is enabled, all field names in the response are translated to Portuguese equivalents (e.g., error → erro, table → tabela).

If "Formatação Brasileira" is enabled, date fields are formatted as DD/MM/YYYY and numeric values are formatted with two decimal places.

In case of errors, the output includes fields such as:

  • error: true
  • status: HTTP status code
  • statusText: Status text message
  • message: Error message from the API or node
  • data: Additional error data if available

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Bankerize API.
  • The node makes HTTP POST requests to the Bankerize FGTS simulation endpoint (/proposals/fgts/simulate).
  • Proper configuration of the API credentials in n8n is necessary.
  • The node expects the CPF to be exactly 11 digits and validates input formats strictly.
  • Optional environment selection affects API base URLs (production vs development).

Troubleshooting

Common Issues

  • Invalid CPF format: The CPF must contain exactly 11 digits. Input with fewer or more digits will cause an error.
  • Missing required parameters: CPF and Banco are mandatory; missing these will throw errors.
  • Invalid desired value: If provided, it must be a positive number between 1 and 999,999.
  • Empty or malformed table IDs filter: If filtering by table IDs, ensure correct UUID format and comma separation.
  • API authentication failure: Invalid or missing API credentials will prevent successful requests.
  • Network or API errors: HTTP errors from the Bankerize API are caught and returned with status codes and messages.

Error Messages and Resolution

  • "CPF é obrigatório para simulação": Provide a valid CPF string.
  • "CPF deve conter exatamente 11 dígitos": Ensure CPF contains only digits and is exactly 11 characters long.
  • "Banco é obrigatório para simulação": Select a valid partner bank.
  • "Valor desejado deve ser um número entre R$ 1,00 e R$ 999.999,00 ou deixe em branco para valor máximo": Correct the desired value input.
  • Errors with HTTP status and message from the API indicate issues like invalid parameters or server problems; check API documentation and credentials.
  • Unexpected errors include detailed information in the output JSON for debugging.

Links and References

This summary covers the "Simulate" operation of the Bankerize FGTS node, describing its purpose, inputs, outputs, dependencies, and common troubleshooting points based on static analysis of the source code and provided properties.

Discussion