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 FGTS API to manage FGTS (Fundo de Garantia do Tempo de Serviço) operations, specifically for simulating and creating loan proposals based on FGTS balances. The "Simulate by Installments" operation allows users to simulate a loan proposal by specifying particular installments (parcels), enabling more granular control over which portions of the FGTS balance are considered in the simulation.

Typical use cases include:

  • Financial institutions or fintechs offering FGTS-backed loans who want to simulate loan conditions based on specific installment data.
  • Automating FGTS loan simulations within workflows that require installment-level detail.
  • Providing Brazilian clients with formatted financial data tailored to local conventions.

Example: A lender wants to simulate a loan proposal considering only certain FGTS installments with specified release and available values, to tailor the offer precisely to the client's situation.

Properties

Name Meaning
Formatação Brasileira (brazilianFormat) When enabled, formats dates as DD/MM/YYYY and numeric values with two decimal places, suitable for Brazilian interfaces.
CPF (installmentCpf) Customer's CPF number (Brazilian individual taxpayer registry identification), digits only. Required.
Banco (installmentBank) Partner bank for the operation. Currently supports option: BMP. Required.
Table ID (tableId) ID of the table obtained from the initial simulation (e.g., "51acd201-0dc8-475e-9f43-e74c423cb6a0"). Required.
Parcelas (installments) JSON array of installments to manipulate. Each installment must have:
- date (string, format YYYY-MM-DD)
- released_value (number, amount released)
- available_value (number, amount available). Required.

Output

The output is a JSON object representing the result of the installment-based simulation request to the Bankerize FGTS API. It contains detailed information about the simulated proposal, including financial figures and terms calculated based on the provided installments.

If the "Formatação Brasileira" property is enabled, date fields will be formatted as DD/MM/YYYY and numeric values will be formatted with two decimal places for easier readability in Brazilian contexts.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Bankerize FGTS API.
  • The node makes HTTP POST requests to the Bankerize API endpoint /proposals/fgts/installment-simulation.
  • Proper network connectivity to the Bankerize API service is necessary.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

Common Issues

  • Invalid CPF: The CPF must contain exactly 11 digits. Input with incorrect length or non-numeric characters will cause errors.
  • Missing or invalid Table ID: The Table ID is mandatory and must be obtained from a prior simulation.
  • Malformed installments JSON: The installments input must be valid JSON and contain at least one installment object with required fields.
  • Installment validation errors: Each installment must have a valid date in YYYY-MM-DD format, positive numbers for released_value and available_value, and released_value cannot exceed available_value.
  • API authentication failures: Ensure the API key credential is correctly configured and valid.
  • Network or API errors: May occur due to connectivity issues or API downtime; error details are returned in the output JSON.

Error Messages and Resolutions

  • "CPF é obrigatório para simulação por parcelas": Provide a valid CPF.
  • "CPF deve conter exatamente 11 dígitos": Check CPF length and remove any formatting characters.
  • "Banco é obrigatório para simulação por parcelas": Select a valid partner bank.
  • "Table ID é obrigatório - obtenha este ID na simulação inicial": Use a valid Table ID from a previous simulation.
  • "Array de parcelas é obrigatório" or "Array de parcelas deve ser um JSON válido": Provide a well-formed JSON array for installments.
  • "Parcela X: campo 'date' é obrigatório" or "data deve estar no formato YYYY-MM-DD": Correct the date format in each installment.
  • "Parcela X: 'released_value' deve ser um número maior que zero" or similar for available_value: Ensure numeric values are positive.
  • "Parcela X: 'released_value' não pode ser maior que 'available_value'": Adjust values so released_value ≤ available_value.
  • API response errors include status codes and messages; check API credentials and network.

Links and References

Discussion