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;
- O tomador autorize a Via Capital a consultar seu saldo do FGTS por meio do aplicativo oficial do FGTS.
Resposta Síncrona
GET: https://platform.flowfinance.com.br/banking/originator/guarantee/{product-id}/get-balance
Parâmetros da requisição
| Campo | Descrição | Tipo |
|---|---|---|
| taxpayer_id | CPF do tomador (somente números) | String |
Retorno com margem disponível:
{
"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"
}
]
}
Retorno sem margem disponível:
{
"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": 0.0
}
],
"config": {
"agency": "12a19cde-54ff-4305-ab2e-180480a0389a",
"consignee": "468f5087-d35f-45dd-96db-3cf71a83fe08"
},
"meta_data": {
"periods": [],
"has_disregarded_balance": false
},
"balance_check_date": "2025-08-11T16:59:48.4594101+00:00"
}
]
}
Retorno quando o tomador não aprovou a consulta na CEF:
{
"links": [
{
"employee": {
"code": "N/A",
"document": "02736958438",
"name": "N/A"
},
"products": [
{
"authorization": {
"details": [
{
"type_product": "LOAN",
"authorized": false
}
]
},
"available_balance": 0.0
}
],
"config": {
"agency": "12a19cde-54ff-4305-ab2e-180480a0389a",
"consignee": "468f5087-d35f-45dd-96db-3cf71a83fe08"
},
"meta_data": {
"periods": [],
"has_disregarded_balance": false
},
"balance_check_date": "2025-08-11T16:59:48.4594101+00:00"
}
]
}
Parâmetros de retorno
| Campo | Descrição | Tipo | Exemplo |
|---|---|---|---|
| employee.code | Código identificador do funcionário. | string | 12356 |
| employee.document | Documento de identificação (CPF). | string | 02736958438 |
| employee.name | Nome do funcionário. | string | Maria Silva |
| products.balance_check_id | Identificador único da verificação de saldo. | string | 8a83a290-ba56-452a-8c4c-19918cab0a2e |
| products.authorization.details.type_product | Tipo do produto autorizado | string | LOAN |
| products.authorization.details.authorized | Indica se o tomador autorizou a consulta | boolean | true |
| products.available_balance | Saldo disponível para o produto consultado. | number | 81655.50 |
| config | Informações de configuração vinculadas à consulta. | object | { "agency": "...", "consignee": "..." } |
| config.agency | Identificador da agência. | string | 12a19cde-54ff-4305-ab2e-180480a0389a |
| config.consignee | Identificador do consignatário. | string | 468f5087-d35f-45dd-96db-3cf71a83fe08 |
| meta_data.periods.amount | Valor disponível no período específico. | number | 6982.77 |
| meta_data.periods.credit_date | Data prevista para o crédito. | YYYY-MM-DD | 2026-07-01 |
| meta_data.periods.available | Indica se o crédito do período está disponível. | boolean | true |
| meta_data.has_disregarded_balance | Indica se existe saldo desconsiderado na análise. | boolean | false |
| balance_check_date | Data e hora da verificação de saldo. | string | 2025-08-11T16:59:48.4594101+00:00 |
Resposta Assíncrona
Caso ocorra alguma instabilidade no momento da consulta de margem, faremos a tratativa interna com um processo de resposta assíncrona.
{
"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.
Updated about 12 hours ago