API Reference
Detailed information on all available API endpoints
API Reference
Bridge Developer API endpoints use JSON over HTTPS. All requests require authentication.
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
Airtime and bills
Send Airtime / Top-up
POST /send_airtime — airtime and top-up (trans_type ATP)
Bill Payments
POST /pay_bill — utilities and services (trans_type BLP)
Account Management
Get Account Balance
Check your account balance and available funds
Get Transaction Status
Verify the status of a specific transaction
Communication
Send SMS
POST /sms/send — send a single SMS message
Send Bulk SMS
POST /sms/bulk — send the same message to up to 1,000 recipients
Check SMS Balance
POST /sms/balance — retrieve SMS page-credit balance
Get SMS Send History
POST /sms/history — paginated send records with filters
Common Request Headers
Authorization: Basic <base64_encoded_credentials>
Content-Type: application/jsonResponses
Bodies are JSON with response_message and response_code (and sometimes response_data or redirect_url). Many async operations return 202 when the request is queued. Full code list: Response Codes.
Rate limits
About 100 requests/minute per API key and 20 requests/second burst. Over limit → 429 Too Many Requests.
Errors
Typical HTTP statuses: 400 invalid input, 401 auth failed, 429 rate limited, 500 server error. See Response Codes for response_code values.
Sandbox testing
All sandbox requests use the same base URL, endpoint paths, and Authorization header as production. Only your credentials and test input values differ. See the Introduction for the integration journey overview.
MSISDN allowlist
Mobile money, airtime, SMS, and payout endpoints only accept the numbers below in sandbox mode. Any other number — including real customer numbers — returns an error.
| Network | nw value | Local format | International format | Suffixes |
|---|---|---|---|---|
| MTN | MTN | 0244XXXXXX | 233244XXXXXX | 000000–000009 |
| Vodafone / Telecel | VOD or TEL | 0200XXXXXX | 233200XXXXXX | 000000–000009 |
| AirtelTigo | AIR or TIG | 0270XXXXXX | 233270XXXXXX | 000000–000009 |
Last-digit outcome rule: The last digit of the MSISDN controls the simulated result.
| Last digit | Outcome |
|---|---|
0–8 | Success path — payment 202 + callback, name lookup returns a name, SMS delivers |
9 | Failure path — payment 015 (no callback), name lookup returns null, SMS REFUNDED |
Universal rules
| Scenario | Details | response_code |
|---|---|---|
| Wrong or real MSISDN | Not on allowlist (e.g. 0541840988) | 019 (payments), 228 (lookup), S002 (SMS) |
| Amount too high | amount > 10000 on any payment | 016 |
| Duplicate transaction | Same transaction_id reused | 219 |
| Card PANs | Only four test values accepted (see Card Payment) | 019 for any other PAN |
| Bill pay accounts | 12-digit sandbox account numbers only; MSISDNs not accepted (see Bill Payments) | 019 for wrong input |
Each endpoint page below includes a Sandbox testing section with copy-paste examples for that specific route.
Testing
Import the Postman collection or use the cURL examples on each endpoint page.
Support
Email support@thebridgesolutions.com for integration help.