Voltar para Finance 360 API

Capacidade Financeira

CAPACIDADE_FINANCEIRA

Capacidade de pagamento (affordability) estimada do CPF — quanto sobra após as despesas.

Endpoint

POST /api/client/provider/open-finance

Método

POST

Autenticação

Bearer JWT

Descrição

Retorna a capacidade de pagamento (affordability) estimada do CPF — o valor que resta após as despesas mensais.

Request Body

Content-Type: application/json
Campo Tipo Obrigatorio Descricao
document string Sim CPF do consultado (11 dígitos, somente números).
product_code array Sim Lista de códigos de produto a consultar. Pode combinar vários relatórios Open Finance numa única requisição.

Exemplo

{
    "document": "12345678901",
    "product_code": [
        "CAPACIDADE_FINANCEIRA"
    ]
}

Exemplo cURL

curl -X POST \
  https://positivaconnect.positivaconsultas.com.br/api/client/provider/open-finance \
  -H "Authorization: Bearer {seu_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "12345678901",
    "product_code": ["CAPACIDADE_FINANCEIRA"]
  }'

Formato do Envelope de Resposta

200 OK 
{
  "success": true,
  "document": "12345678901",
  "provider": "open-finance",
  "query_date": "2026-03-18T10:00:00",
  "results": {
    "CAPACIDADE_FINANCEIRA": {
      "success": true,
      "data": { ... }
    }
  }
}

Quando results.CAPACIDADE_FINANCEIRA.success for false, indica falha de comunicação com o provider externo (timeout, erro 5xx). Erros de autorização são rejeitados antes da consulta com HTTP 403.

Campos do data

Campo Descrição
reportStatus Código HTTP do status do relatório na Klavi (200 = sucesso).
requestId Identificador único da requisição na Klavi.
productName Código do produto consultado na Klavi (ex.: pf_klavi_income_eco).
productVersion Versão do produto (ex.: V1).
productReportTime Data e hora de geração do relatório (ISO 8601).
enquiryCpf CPF consultado.
capacity.labelDetails Array de indicadores. Cada item tem labelCode, labelName e labelValue.
capacity.labelDetails[].labelCode P000008 (Capacidade de pagamento / Affordability, em R$).
capacity.personalInfo.civilName Nome civil do consultado.
capacity.personalInfo.accounts Instituições Open Finance vinculadas (bacenName, brandName, compeCode).

Exemplo de Resposta

Conteúdo de results.CAPACIDADE_FINANCEIRA.data

200 OK 
{
    "reportStatus": 200,
    "requestId": "6552f43143ac4e8b91fe42f74efb4964",
    "productName": "pf_klavi_capacity_eco",
    "productVersion": "V1",
    "productReportTime": "2026-08-19T17:49:25.335Z",
    "enquiryCpf": "76109277673",
    "capacity": {
        "labelDetails": [
            {
                "labelCode": "P000008",
                "labelName": "Affordability",
                "labelValue": 30347.01
            }
        ],
        "personalInfo": {
            "accounts": [
                {
                    "bacenName": "Klavi OP Mock Institution",
                    "brandName": "Banco Brasileiro",
                    "compeCode": "11110"
                }
            ],
            "civilName": "Tatiana Galvão"
        }
    }
}

Respostas de Erro

400

invalid_request

Documento inválido, product_code ausente ou vazio

401

unauthenticated

Token JWT ausente ou inválido

403

product_not_authorized

Um ou mais produtos informados não estão contratados. A requisição inteira é rejeitada.

404

product_not_found

Um dos códigos em product_code não existe ou está inativo