API Reference
Detailed information on all available API endpoints
API Reference
Bridge Developer API provides several endpoints for different financial operations. All endpoints require authentication and return JSON responses.
Base URL
https://api.bridgeagw.comAvailable Endpoints
Payment Processing
Make Payment
Unified payment endpoint supporting mobile money, cards, deposits, and payouts
Mobile Money Payment
Collect payments from customers via mobile money networks
Card Payment
Process secure payments via credit and debit cards
Payout Payment
Send payments to customers via mobile money
Deposit to Wallet
Fund your transfer wallet using mobile money
Account Management
Get Account Balance
Check your account balance and available funds
Get Transaction Status
Verify the status of a specific transaction
Communication
Common Request Headers
All API requests must include the following headers:
Authorization: Basic <base64_encoded_credentials>
Content-Type: application/jsonCommon Response Format
All API responses follow a consistent format:
Success Response
{
"response_data": {
// Endpoint-specific data
},
"response_message": "Success",
"response_code": "000"
}Error Response
{
"response_message": "Error description",
"response_code": "Error code"
}Rate Limits
API requests are subject to rate limiting to ensure fair usage:
- Rate Limit: 100 requests per minute per API key
- Burst Limit: 20 requests per second
If you exceed these limits, you'll receive a 429 Too Many Requests response.
Error Handling
The API uses standard HTTP status codes and custom response codes:
200 OK: Request successful400 Bad Request: Invalid request parameters401 Unauthorized: Authentication failed429 Too Many Requests: Rate limit exceeded500 Internal Server Error: Server error
For detailed error codes, see the Response Codes section.
Testing
You can test the API endpoints using:
- Postman Collection: Import our Postman collection
- cURL: Use the examples provided in each endpoint documentation
- SDK: Use our official SDKs (coming soon)
Support
If you need help with any API endpoint or encounter issues, please contact our support team.