---
title: "Transacional - PF"
description: "API Transacional PF - Transações financeiras ágeis e seguras para Pessoa Física"
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/creditos/73ab840f-74a7-407b-843f-08b66c0d2d33
markdown: https://doc.apibrasil.io/apis/creditos/73ab840f-74a7-407b-843f-08b66c0d2d33.md
source: apibrasil-documentation
---

# Transacional - PF

> API Transacional PF - Transações financeiras ágeis e seguras para Pessoa Física

- **Categoria:** Busca & Cobrança
- **Cobrança:** por consulta, só com o Bearer Token
- **Preço:** R$ 0,60 por consulta
- **Limite:** 999.000 por mês
- **Cadastro:** exige CNPJ
- **Versão:** v1
- **Publicada por:** APIBrasil
- **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/73ab840f-74a7-407b-843f-08b66c0d2d33/openapi.json

## Como chamar

**Endereço base:** `https://gateway.apibrasil.io/api/v2`

Autenticação: cabeçalho `Authorization: Bearer <token>`. Nada além disso.

Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção.

## Endpoints (1 endpoint)

### 1. POST /consulta/cpf/credits

API Transacional PF - Decisão de crédito rápida e assertiva

A API Transacional - PF permite consultar em tempo real o CPF de consumidores para apoiar decisões de crédito mais rápidas, seguras e rentáveis. Com o endpoint POST /transacional-pf/consulta/cpf/credits, você integra em poucas horas ao seu sistema e passa a receber respostas estruturadas com informações essenciais de crédito, score e comportamento financeiro. O retorno da API é otimizado para automação de regras, análise de risco, pré-aprovação de ofertas e validação de clientes em jornadas 100% digitais. Ao incorporar essa API no seu fluxo de análise, você reduz inadimplência, acelera a aprovação de propostas e melhora a experiência do usuário com decisões instantâneas e baseadas em dados.

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits`
- **Versão da rota:** v1

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Corpo da requisição**

```json
{
  "tipo": "transacional-pf",
  "cpf": "00000000000",
  "homolog": true
}
```

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cpf/credits" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN" \
  -d '{"tipo":"transacional-pf","cpf":"00000000000","homolog":true}'
```

Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação.

**Resposta de exemplo, do catálogo**

```json
{
  "user": {
    "first_name": "[omitido]",
    "email": "[omitido]",
    "cellphone": "[omitido]",
    "notification": "yes"
  },
  "balance": "860,270",
  "tax": "0,000",
  "error": true,
  "message": "Resposta inesperada do servidor"
}
```

Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica.

## Armadilhas: o que uma integração erra sem avisar

Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto:

1. **O erro chega no CORPO, com HTTP 200.**
   A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`.

2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.**
   Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los.

3. **Cada chamada custa dinheiro.**
   Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas.

4. **HTTP 402 é saldo insuficiente, e repetir não resolve.**
   É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos.

5. **`extra_charges` cobra à parte do preço da consulta.**
   Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois.

## Ver também

- Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/73ab840f-74a7-407b-843f-08b66c0d2d33/openapi.json
- Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md)
- SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md)
- Índice da documentação: https://doc.apibrasil.io/llms.txt
- Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/73ab840f-74a7-407b-843f-08b66c0d2d33