ResgataInstall

Summary

Simulate an FGTS withdrawal using a proposal protocol number, specifying the bank and desired withdrawal amount to estimate the financial results of an FGTS credit anticipation.

Inputs

• Numero De Protocolo (required) — The protocol number of the service or proposal to simulate the FGTS withdrawal from.
• Banco (required) — The bank code indicating which financial institution to use for the simulation. Options: BMP, BMG, C6, PAN, Safra.
• Valor Desejado (required) — The desired amount for anticipation. Set to 0 to use the available balance automatically.
• Options — Optional parameters including a Timeout in seconds to specify the maximum wait time for the operation.

Output shape

a single JSON object representing the FGTS withdrawal simulation result returned from the API

The output contains simulation details from the API call to /api/v1/proposals/fgts/simulation including terms, amounts, and conditions. The operation awaits the API response up to the optional timeout duration (default 300 seconds). Errors are returned in JSON if the operation fails.