Consulta de Margem

A Consulta de Margem é um processo que verifica o valor disponível que o trabalhador pode utilizar para a antecipação do Saque-Aniversário FGTS.

Essa consulta é importante para garantir que a instituição financeira saiba exatamente qual é o limite de crédito seguro que pode ser oferecido ao tomador, baseado no saldo do FGTS e nas regras do produto.

Antes de conceder o crédito, a instituição realiza a Consulta de Margem para confirmar se o trabalhador tem saldo suficiente e está habilitado para a operação, protegendo assim tanto o tomador quanto a instituição.

Pré-requisito

Para que a consulta de margem ocorra com sucesso, é necessário que:

• O tomador seja optante pelo Saque Aniversário FGTS;
  • Se não, a API retornará 400 - Trabalhador não possui adesão ao saque aniversário vigente na data corrente
• O tomador autorize a Via Capital a consultar seu saldo do FGTS por meio do aplicativo oficial do FGTS.
  • Se não, a API retornará 400 - 7 - Instituição Fiduciária não possui autorização do Trabalhador para Operação Fiduciária.

Resposta Síncrona

cURL

curl --location --request GET 'https://platform.flowfinance.com.br/banking/originator/guarantee/123456789/get-balance' \
--header 'Authorization: Bearer ....' \
--form 'taxpayer_id="123456789"'

200 OK Retorno com Margem Disponível

Response

{
    "links": [
        {
            "employee": {
                "code": "N/A",
                "document": "02736958438",
                "name": "N/A"
            },
            "products": [
                {
                    "balance_check_id": "8a83a290-ba56-452a-8c4c-19918cab0a2e",
                    "authorization": {
                        "details": [
                            {
                                "type_product": "LOAN",
                                "authorized": true
                            }
                        ]
                    },
                    "available_balance": 81655.50
                }
            ],
            "config": {
                "agency": "12a19cde-54ff-4305-ab2e-180480a0389a",
                "consignee": "468f5087-d35f-45dd-96db-3cf71a83fe08"
            },
            "meta_data": {
                "periods": [
                    {
                        "amount": 6982.77,
                        "credit_date": "2026-07-01",
                        "available": true
                    },
                    {
                        "amount": 6633.63,
                        "credit_date": "2027-07-01",
                        "available": true
                    },
                    {
                        "amount": 6301.95,
                        "credit_date": "2028-07-01",
                        "available": true
                    },
                    {
                        "amount": 5986.85,
                        "credit_date": "2029-07-01",
                        "available": true
                    },
                    {
                        "amount": 5687.51,
                        "credit_date": "2030-07-01",
                        "available": true
                    },
                    {
                        "amount": 5403.14,
                        "credit_date": "2031-07-01",
                        "available": true
                    },
                    {
                        "amount": 5132.98,
                        "credit_date": "2032-07-01",
                        "available": true
                    },
                    {
                        "amount": 4876.33,
                        "credit_date": "2033-07-01",
                        "available": true
                    },
                    {
                        "amount": 4632.51,
                        "credit_date": "2034-07-01",
                        "available": true
                    },
                    {
                        "amount": 4400.89,
                        "credit_date": "2035-07-01",
                        "available": true
                    },
                    {
                        "amount": 4180.84,
                        "credit_date": "2036-07-01",
                        "available": true
                    },
                    {
                        "amount": 3971.80,
                        "credit_date": "2037-07-01",
                        "available": true
                    },
                    {
                        "amount": 3646.43,
                        "credit_date": "2038-07-01",
                        "available": true
                    },
                    {
                        "amount": 3222.68,
                        "credit_date": "2039-07-01",
                        "available": true
                    },
                    {
                        "amount": 2739.28,
                        "credit_date": "2040-07-01",
                        "available": true
                    },
                    {
                        "amount": 2221.18,
                        "credit_date": "2041-07-01",
                        "available": true
                    },
                    {
                        "amount": 1776.94,
                        "credit_date": "2042-07-01",
                        "available": true
                    },
                    {
                        "amount": 1307.34,
                        "credit_date": "2043-07-01",
                        "available": true
                    },
                    {
                        "amount": 915.13,
                        "credit_date": "2044-07-01",
                        "available": true
                    },
                    {
                        "amount": 640.59,
                        "credit_date": "2045-07-01",
                        "available": true
                    },
                    {
                        "amount": 447.89,
                        "credit_date": "2046-07-01",
                        "available": true
                    },
                    {
                        "amount": 268.74,
                        "credit_date": "2047-07-01",
                        "available": true
                    },
                    {
                        "amount": 139.05,
                        "credit_date": "2048-07-01",
                        "available": true
                    },
                    {
                        "amount": 69.53,
                        "credit_date": "2049-07-01",
                        "available": true
                    },
                    {
                        "amount": 34.76,
                        "credit_date": "2050-07-01",
                        "available": false
                    },
                    {
                        "amount": 17.38,
                        "credit_date": "2051-07-01",
                        "available": false
                    },
                    {
                        "amount": 8.69,
                        "credit_date": "2052-07-01",
                        "available": false
                    }
                ],
                "has_disregarded_balance": false
            },
            "balance_check_date": "2025-08-11T16:59:48.4594101+00:00"
        }
    ]
}

Parâmetros de retorno

Resposta Assíncrona

Caso ocorra alguma instabilidade no momento da consulta de margem, faremos a tratativa interna com um processo de resposta assíncrona.

Response 202

{
    "message": "Request accepted for asynchronous processing"
}

Isso indica que a solicitação foi aceita e será processada posteriormente.

Quando a consulta for concluída, o resultado será enviado ao originador por meio de um webhook com o evento GuaranteeBalanceUpdate.

Tabela de Retornos que recebemos da CEF: