Available Environments for BCB API Interaction
To facilitate a smooth and secure integration experience, the BCB API is accessible via distinct environments, each designed for a specific purpose. Understanding and utilizing these environments correctly is crucial for successful development, testing, and live operation.
Authentication credentials (Client ID and Client Secret, and subsequently, Access Tokens) are unique to each environment. You must obtain separate credentials for Sandbox and Production.
- Sandbox Environment
The Sandbox environment is your primary resource for development, testing, and experimentation with the BCB API. It provides a safe, isolated space where you can build and test your integration logic without affecting live data or real financial transactions.
Purpose:
Develop and iterate on your API integration code.
Test API calls, request structures, and response handling.
Simulate various transaction scenarios (e.g., successful payments, failures, edge cases).
Familiarize yourself with the API's behavior and features.
Conduct user acceptance testing (UAT) within a controlled environment.
Data: Contains simulated or non-production data. No real funds are moved, and no actual accounts are affected.
Credentials: Requires specific Sandbox API credentials (Client ID and Client Secret).
Base URL: https://api.uat.bcb.group
- Production Environment
The Production environment is the live system where all real financial transactions and actual data processing occur. Access to this environment should only be granted and utilized once your integration has been thoroughly tested and validated in the Sandbox environment, and you have completed our onboarding and certification process.
Purpose:
Process live financial transactions with real funds.
Interact with your actual BCB accounts and client data.
Execute operations that have real-world financial implications.
Data: Contains live, production-critical data.
Credentials: Requires distinct Production API credentials, issued after successful onboarding and security checks.
Base URL: https://api.bcb.group
**Best Practices for Environment Usage:
**Always Start in Sandbox: Begin all new development and testing in the Sandbox environment. This prevents errors from impacting live operations.
Thorough Testing: Ensure your integration is robust and thoroughly tested in Sandbox before requesting access to Production.
Credential Security: Treat your Production API credentials with the highest level of security. Do not embed them directly in client-side code, and manage them using secure key management practices.
Monitor Live Operations: Once in Production, continuously monitor your integration's performance and transaction statuses.
Updated 3 months ago
