Welcome to the API
Complete banking and PIX API for Brazilian financial operations
Welcome to the API documentation! Our comprehensive banking API provides everything you need to build modern financial applications for the Brazilian market.
What is this API?
This is a complete banking and payment infrastructure platform that enables businesses to:
- 🏦 Manage Bank Accounts: Create and manage digital bank accounts
- 💸 Process PIX Payments: Send and receive instant PIX transfers
- 📊 Track Transactions: Monitor all financial operations in real-time
- 🔗 Integrate Webhooks: Receive real-time notifications for account events
- 📄 Generate Reports: Create comprehensive financial reports and statements
Key Features
Instant PIX Transfers
Send and receive money instantly using PIX, Brazil's instant payment system. Support for all PIX key types: CPF, CNPJ, email, phone, and random keys.
Complete Account Management
Full control over digital bank accounts including balance inquiries, transaction history, and account statements.
Real-Time Notifications
Configure webhooks to receive instant notifications about transactions, balance changes, and account events.
Developer-Friendly
RESTful API with comprehensive documentation, code examples, and dedicated support for developers.
API Overview
Our API is organized into the following modules:
| Module | Description |
|---|---|
| Account API | Manage accounts, balances, and transactions |
| Cashin API | Receive money with PIX: QR codes, payment codes, cash in queries and chargebacks |
| Cashout API | Create and manage outbound transfers |
| DICT API | Register and manage PIX keys |
| Webhook API | Manage webhook configurations and logs |
Getting Started
Ready to start building? Follow these steps:
- Get Started - Set up your development environment
- Authentication - Learn about API authentication
- Explore APIs - Browse the API reference documentation
- Test Integration - Use our sandbox environment for testing
API Characteristics
RESTful Architecture
Clean, predictable URLs and standard HTTP methods (GET, POST, PUT, DELETE).
JSON Format
All requests and responses use JSON format for easy parsing and integration.
Secure Authentication
Industry-standard Bearer token authentication with HMAC signatures for enhanced security.
Comprehensive Error Handling
Detailed error messages with HTTP status codes to help you debug quickly.
Base URLs
Production
https://api.bnscred.com.brSandbox (for testing)
https://sandbox-api.example.comWhat's New
Stay updated with the latest API changes:
- ✨ May 2026: Enhanced webhook retry logic
- 🚀 April 2026: New transaction filtering options
- 🔒 March 2026: Improved security with mandatory HMAC for API audience
Next Steps
Ready to build something amazing? Let's get started! 🚀