Consulta do valor disponível para antecipação

Como verificar as garantias disponíveis por período

Antes de simular o empréstimo é recomendado que o correspondente consulte o valor que o titular da conta vinculada do FGTS tem disponível para antecipação. Deste modo é possível evitar erros por saldo insuficiente bem como custos(1) desnecessários.

(1) Chamadas à API da CEF para consulta do saldo disponível para saque aniversário e bloqueio do saldo FGTS são cobradas e seu custo repassado ao correspondente que originou as requisições.

🚧

Importante!

É necessário informar ao interessado que o mesmo deve aderir ao saque aniversário bem como autorizar a Parati Financeira a consultar e solicitar bloqueio de parte do saldo de sua conta FGTS.

Assim como na Simulação de Empréstimo, a consulta do saldo disponível para antecipação não requer que o consumidor interessado possua cadastro na plataforma. Para acessar a feature basta fornecer o CPF do consumidor como parâmetro na url da requisição, conforme exemplo abaixo:

curl --location --request GET 'https://<instance-url>.btcore.app/credit/fgts/balances/38612925991 \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <oauth_bearer_token>'

Importante observar que o valor retornado na consulta acima representa o saldo disponível (por período / ano) para saque aniversário na conta vinculada do FGTS do consumidor. Porém, o valor antecipável pelo consumidor depende das taxas da operação. Para consultar o valor antecipável nos períodos (anos) basta fornecer no corpo da requisição as taxas da operação, conforme exemplo abaixo:

curl --location --request POST 'https://<instance-url>.btcore.app/credit/fgts/balances/38612925991 \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <oauth_bearer_token>' \
--data-raw '{
    "fees": [
        {
            "type": "rate_month",
            "amount": 1.5,
            "embedded": true
        }
    ]
}'

Abaixo são detalhados os parâmetros da chamada ao endpoint de consulta do valor disponível para antecipação.

Campo

Requerido

Tipo

Descrição

number_of_periods

não

Número

Número de períodos do saque aniversário que deseja consultar. Se fornecido, deve ser um inteiro maior que zero

fees

sim

Array de objetos do tipo Fee

Taxas que incidem na operação. Importante: as taxas dos tipos iof e rate_month são obrigatórias

Fee

Campo

Requerido

Tipo

Descrição

type

sim

Enum FeeType [escrow,
iof,
fintech, financial,
rate_month]

Tipo da taxa

amount

não

Decimal com até duas casas de precisão

Valor (percentual) da taxa

embedded

sim

Booleano

Define se o valor da taxa deve ser embutido nas parcelas

calculation_basis

não

Decimal com até duas casas de precisão

Base de cálculo da taxa

O exemplo abaixo representa a resposta obtida a partir da consulta ao valor disponível para antecipação para um dado consumidor, na qual as taxas da operação são fornecidas como parâmetro.

{
   "tax_id": "38612925991",
   "balance_date": "2021-10-27",
   "periods": [
       {
           "amount": 18.95,
           "release_date": "2021-12-01",
           "available_amount": 18.62
       },
       {
           "amount": 18.01,
           "release_date": "2022-12-01",
           "available_amount": 14.77
       },
       {
           "amount": 0,
           "release_date": "2023-12-01",
           "available_amount": 0
       }
   ]
}

As propriedades do objeto JSON retornado no corpo da resposta são detalhadas abaixo.

Campo

Requerido

Tipo

Descrição

tax_id

sim

Texto

CPF do tomador consumidor titular da conta vinculada FGTS

balance_date

sim

Texto

Data da consulta do saldo do saque aniversário no formato yyyy-MM-dd

periods

sim

Array de objetos do tipo Period

Lista de períodos do saque aniversário

Period

release_date

sim

Texto

Data em que o valor da parcela estará disponível para saque aniversário no formato yyyy-MM-dd

amount

sim

Decimal com duas casas de precisão

Valor disponível para saque aniversário

available_amount

não

Decimal com duas casas de precisão

Valor disponível para antecipação


Did this page help you?