Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Consulta de Margem

Suggest Edits

A Consulta de Margem é o processo que verifica o valor disponível que o trabalhador pode comprometer para contratar crédito consignado.

Essa verificação garante que a instituição financeira saiba exatamente qual é o limite seguro de crédito que pode ser oferecido, com base no saldo de margem consignável disponível.

Antes de aprovar o crédito, a instituição realiza essa consulta para confirmar se o trabalhador possui saldo suficiente e está apto para a operação, protegendo tanto o tomador quanto a própria instituição.


GET https://platform.flowfinance.com.br/banking/originator/guarantee/{product-id}/get-balance

CURL da chamada

curl -X GET 'https://platform.flowfinance.com.br/banking/originator/guarantee/{SEU_PRODUCT_ID{/get-balance?taxpayer_id=12345678996' \
-H 'Authorization: Bearer SEU_TOKEN_DE_ACESSO'

Parâmetros da Requisição

ParâmetroTipoObrigatórioDescriçãoExemplo
taxpayer_idstringSimDocumento do tomador (CPF).12345678996

Exemplo de retorno

👍

Sucesso 201


{
  "links": [
    {
      "employer": {
        "code": "26239",
        "document": "34621748000123",
        "name": "UNIVERSIDADE FEDERAL DO PARA",
        "codeEmployee": ""
      },
      "employee": {
        "code": "0235950",
        "document": "10531165272",
        "name": "VALDIR EMANUEL DA LUZ TEIXEIRA"
      },
      "products": [
        {
          "balanceCheckId": "47f0ed2f-3043-498b-bbd8-61e9e134704e",
          "authorization": {
            "details": [
              {
                "typeProduct": "CARD_CREDIT",
                "authorized": false
              }
            ]
          },
          "rubric": {
            "code": "35044",
            "description": "AMORT CARTAO CREDITO - CELCOIN"
          },
          "agreement": "703742",
          "availableBalance": 0
        },
        {
          "balanceCheckId": "219c531c-462e-4d1b-a29c-c3f220a00594",
          "authorization": {
            "details": [
              {
                "typeProduct": "CARD_BENEFICIARY",
                "authorized": false
              }
            ]
          },
          "rubric": {
            "code": "35045",
            "description": "AMORT CARTAO BENEFICIO - CELCOIN"
          },
          "agreement": "703743",
          "availableBalance": 0
        }
      ],
      "config": {
        "agency": "48050af5-eb05-4062-b2fc-d6e6dcfe8b69",
        "consignee": "5e7bb235-f24f-43e2-80fd-f8fef8c3d0e7"
      },
      "metaData": {
        "homeAccount": "00000003927**",
        "pensionTypeCode": "",
        "classificationDescription": "Estável",
        "payingUnitCode": "26239000000852",
        "functionalStatusCode": "EST02",
        "linkTypeCode": "S",
        "pensionDueDate": null,
        "payingUnitState": "PA",
        "homeBank": "001",
        "homeAgency": "0076**",
        "pensionTypeDescription": "",
        "functionalStatusDescription": "APOSENTADO",
        "classificationCode": "1",
        "linkTypeDescription": "Servidor"
      },
      "balanceCheckDate": "2025-07-25T16:02:16.8693189+00:00"
    }
  ]
}

Updated about 8 hours ago