BRPIX MERCHANT API

Documentação da API

Gateway de pagamentos de alta performance para Pix In, Pix Out, cobranças e split multi-nível. Integração simples, segura e em conformidade com o BACEN.

Base URL https://api.brpix.app
● API Online
⏱ < 300ms resposta
✓ BACEN Compliant
🔒 mTLS Disponível
🔄 Idempotência
🛡️

Autenticação obrigatória em todas as rotas

Todas as requisições exigem um Bearer JWT obtido via POST /v1/auth/token. Para operações de cashout (Pix Out), também é necessário certificado mTLS ativo.

Guia de Integração
Início Rápido
Autentique, consulte o saldo e gere uma cobrança Pix em menos de um minuto.
1

Obter credenciais

Acesse o painel BRPix para gerar sua API Key (key_id + key_secret) em Configurações → Credenciais.

2

Autenticar e obter o access_token

Troque suas credenciais por um JWT de curta duração. Renove via POST /v1/auth/refresh.

Shell 
# Trocar key_id + key_secret por JWT
curl -sX POST https://api.brpix.app/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"key_id":"bk_<seu_id>","key_secret":"<seu_secret>"}' \
  | jq -r '.access_token'
3

Consultar saldo disponível

Passe o JWT no header Authorization para acessar os recursos protegidos.

Shell 
curl -s https://api.brpix.app/v1/balance \
  -H "Authorization: Bearer <access_token>"
4

Gerar cobrança Pix

Crie um QR Code Pix com split opcional. O header Idempotency-Key evita cobranças duplicadas em retries.

Shell 
curl -sX POST https://api.brpix.app/v1/pix/charges \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <access_token>" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "amount": "100.00",
    "description": "Pedido #4521",
    "expires_in": 3600
  }'
Resposta 201 Created
{
  "id": "3f7a2b1c-...",
  "status": "PENDING",
  "amount": "100.00000",
  "qr_code": "00020101...",
  "expires_at": "2026-10-09T22:00:00Z"
}
Guias
Documentação por tópico
Guias detalhados para cada funcionalidade da API.
🔑

Autenticação

Token flow, refresh, revogação, scopes disponíveis e IP whitelist.
⚡

Cobranças Pix

Ciclo de vida, split multi-nível, webhook de confirmação e exemplos completos.
🔄

Idempotência

Como usar o header Idempotency-Key para evitar duplicidade em retries.
⚠️

Erros

Formato unificado, todos os códigos de erro e como tratar cada caso.
Referência
Endpoints da API
Todos os endpoints disponíveis no BRPix Merchant API v1.0.0.
🔑 Autenticação
POST /v1/auth/token Obter access_token via API Key POST /v1/auth/refresh Renovar access_token via refresh_token POST /v1/auth/revoke Revogar token imediatamente
💰 Saldo & Extrato
GET /v1/balance Consultar saldo disponível e bloqueado GET /v1/transactions Extrato paginado de movimentações
⚡ Cobranças Pix (Pix In)
POST /v1/pix/charges Criar cobrança Pix com QR Code e split opcional GET /v1/pix/charges/:id Consultar status de uma cobrança DEL /v1/pix/charges/:id Cancelar cobrança PENDING GET /v1/pix/keys Listar chaves Pix cadastradas
🔁 Transferências Pix (Cashout)
POST /v1/pix/transfers Criar transferência Pix assíncrona · requer mTLS GET /v1/pix/transfers/:id Consultar status da transferência

Referência interativa OpenAPI

Explore todos os schemas, tente requisições ao vivo e veja respostas reais diretamente no browser.

Abrir Swagger UI →