Check Balance

Consulta o saldo/limite disponível de garantia (consignado) para um CPF.

GET https://platform.flowfinance.com.br/banking/originator/guarantee/{{product_id}}/get-balance?taxpayer_id={{taxpayer_id}}

Headers: Authorization: Bearer {{access_token}}

Path / Query params

ParamLocalDescrição
product_idpathProduto de crédito
taxpayer_idqueryCPF do trabalhador

Exemplo (cURL)

curl "https://platform.flowfinance.com.br/banking/originator/guarantee/{{product_id}}/get-balance?taxpayer_id={{taxpayer_id}}" \
  -H "Authorization: Bearer {{access_token}}"

Resposta 200

{
  "id": "bal_...",
  "available_limit": 854.16
}

Efeitos: Grava balance_check_id (= id).