For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
StatusDashboard
  • Getting Started
    • Introduction
    • Authentication
    • Rate Limits
    • Error Handling
  • Guides
    • Cash-In (Receiving Payments)
    • Cash-Out (Sending Payments)
    • PIX Keys Management
    • Webhooks Integration
    • MED (Special Returns)
  • API Reference
LogoLogo
StatusDashboard
On this page
  • BRZ Public API
  • Base URLs
  • Key Features
  • Quick Start
  • Common Headers
Getting Started

Introduction

Was this page helpful?
Edit this page

Authentication

Next
Built with

BRZ Public API

Welcome to the BRZ Public API documentation. This API provides a complete PIX gateway with direct connection to BACEN, without external providers.

Base URLs

Base URL: https://api.brzip.com.br

All endpoints use the base path /api/v1/.

Key Features

  • PIX Cash-In: Generate QR codes and receive PIX payments instantly.
  • PIX Cash-Out: Send PIX payments to any bank account in Brazil.
  • PIX Keys (DICT): Register and manage PIX keys directly with BACEN.
  • MED (Special Returns): Respond to and manage special return requests from BACEN.
  • Webhooks: Real-time notifications for all transaction events.

Quick Start

Follow these steps to get started:

1

Step 1 — Open Your Account

Visit brzip.com.br/abrasuaconta and fill out the account opening form. Once your account is approved, you will be notified via email.

2

Step 2 — Generate Your API Credentials

After approval, log in to the Web Banking portal. Inside the platform, you can generate your API credentials (key_id and secret_key) by navigating to Settings > Security > API Keys.

3

Step 3 — Generate Bearer Token

With your credentials, generate your Bearer Token with POST /api/v1/auth/bearer-token — see Authentication for details.

4

Step 4 — Register a PIX Key

Register a PIX key with POST /api/v1/pix/keys. Just send {"key_type": "EVP"} — account data is auto-filled from onboarding.

5

Step 5 — Start Operating!

You are now ready to create charges (Cash-In), make transfers, and check balances.

Common Headers

HeaderRequiredDescription
AuthorizationYes (Bearer)Bearer <token> for PIX endpoints
x-key-idYes (Cash-In)API Key ID
x-secret-keyYes (Cash-In)API Key Secret
X-Idempotency-KeyRecommendedPrevents duplicate operations (UUID)
Content-TypeYes (POST/PUT)Always application/json