4. Consulta margem consignável

Método:GET

Endpoint**

https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee/{{productId}}/get-balance?taxpayer_id={{taxpayerId}}

Headers

Chave	Valor	Descrição
Authorization	`Bearer {{originatorAccessToken}}`	Token de autenticação do originador

Parâmetros de Query

Parâmetro	Obrigatório	Exemplo	Descrição
`taxpayer_id`	sim	`86144456015`	CPF do cliente para o qual será consultada a margem

Exemplo de Requisição (

curl --location 'https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee/330ab1f3-3b21-4188-b213-d853b98f0f92/get-balance?taxpayer_id=86144456015' \
--header 'Authorization: Bearer {{originatorAccessToken}}'

Exemplo de Resposta (200 OK)

{
    "id": "4bbb49b3-22ca-48bc-bab9-cfd3df454dd0",
    "links": [
        {
            "employer": {
                "code": "1",
                "document": "79053468000102",
                "name": "Teixeira"
            },
            "employee": {
                "code": "7206587535",
                "document": "54807923188",
                "name": "Dr. Arthur Vasconcelos"
            },
            "config": {
                "agency": "3a7e1beb-c64f-4936-8555-b9edb42c3328",
                "consignee": "3b9be0e7-3af9-4ca4-ad31-26233a58486a"
            },
            "products": [
                {
                    "balance_check_id": "b6ce7bf7-8ea7-4fb5-8a66-aa010860c435",
                    "authorization": {
                        "details": [
                            {
                                "type_product": "LOAN",
                                "authorized": true
                            }
                        ]
                    },
                    "available_balance": 928.62
                }
            ],
            "meta_data": {
                "nationality_country": {
                    "description": "BRASIL",
                    "code": "76"
                },
                "termination_reason_code": "0",
                "birth_date": "1989-10-15",
                "worker_category_code": "101",
                "gender": {
                    "description": "Masculino",
                    "code": 1
                },
                "job_code": {
                    "description": "AGENTE DE VIAGEM",
                    "code": "354815"
                },
                "economic_activity_code": {
                    "description": "TRATAMENTO DE DADOS, PROVEDORES DE SERVICOS DE APLICACAO E SERVICOS DE HOSPEDAGEM NA INTERNET",
                    "code": "6311900"
                },
                "politically_exposed_person": {
                    "description": "Pessoa Não Exposta Politicamente",
                    "code": 0
                },
                "base_margin_value": "3420",
                "amount_loans_assets_suspended": "1",
                "admission_date": "2020-08-29",
                "total_earnings": "4071",
                "employer_activity_start_date": "2020-09-03",
                "mother_name": "Catarina Inclusao Massa Extra",
                "has_disregarded_balance": false
            },
            "balance_check_date": "2025-10-29T22:42:29.3373344+00:00"
        }
    ]
}

Campo	Tipo	Descrição
`balance_check_id`	string	Identificador único da verificação de margem (necessário nas etapas seguintes)
``available_balance`	number	Valor da margem consignável disponível

⚙️
Importante:
O campo balance_check_id deve ser armazenado, pois será utilizado para vincular a operação durante a criação da CCB

⚙️Importante:

⚙️
Importante: