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) operations. Specifically, it allows users to simulate FGTS loan proposals, create new proposals, and retrieve the status of existing proposals. The "Get Proposal" operation fetches detailed information about a specific FGTS proposal using its unique proposal code.

Typical use cases include:

  • Retrieving the current status and details of an FGTS loan proposal for review or further processing.
  • Integrating FGTS proposal data into workflows that require up-to-date financial product information.
  • Displaying proposal details in user interfaces, especially with optional Brazilian formatting for dates and numbers.

Example: A financial service platform can use this node to fetch and display the details of a customer's FGTS loan proposal by providing the proposal code, enabling customer support or automated processes to access proposal status and terms.

Properties

Name Meaning
Formatação Brasileira (brazilianFormat) When enabled, formats dates as DD/MM/YYYY and numeric values with two decimal places. Ideal for Brazilian interfaces. (Boolean)
Proposal Code (proposalCode) The unique code identifying the FGTS proposal to be retrieved. This is required to query the proposal. (String)

Output

The output JSON contains the full details of the requested FGTS proposal as returned by the Bankerize API. If the "Formatação Brasileira" option is enabled, date fields and numeric values within the response are formatted for Brazilian conventions (dates as DD/MM/YYYY and numbers with two decimals).

The structure typically includes:

  • Proposal metadata such as IDs, status, and timestamps.
  • Financial details including amounts, fees, interest rates, and payment schedules.
  • Any messages or error information related to the proposal retrieval.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Bankerize API.
  • The node makes HTTP GET requests to the Bankerize API endpoint /proposals/{proposalCode}.
  • Proper network connectivity to the Bankerize API service is necessary.
  • No additional environment variables beyond the API credentials are required.

Troubleshooting

  • Missing or invalid proposal code: The node requires a non-empty proposal code string with at least 10 characters. Errors will occur if this is missing or too short.
  • API authentication errors: Ensure the provided API key credential is valid and has permissions to access proposal data.
  • Network or API errors: The node captures HTTP errors and returns structured error information including status codes and messages. Common issues include timeouts, unauthorized access, or proposal not found.
  • Formatting issues: If Brazilian formatting is enabled but the data does not appear correctly formatted, verify that the input flag is set properly and that the API response contains expected date and numeric fields.

Common error message example:

  • "Código da proposta é obrigatório para consulta" — means the proposal code was not provided.
  • "Código da proposta deve ter pelo menos 10 caracteres" — means the proposal code is too short.

Resolving these involves supplying a valid, correctly formatted proposal code.

Links and References

Discussion