API Collections
Test the BudPay API from Postman. The collection includes ready-made requests for accepting payments, sending payouts, and managing your account.
Get the Collection
Why Use Our Collection?
Every request is preconfigured with the correct URL, headers, and a sample body, so you only need to add your API key.
| Benefit | What it means for you |
|---|---|
| Zero configuration | Import once, every request is ready to go |
| Test without code | Explore APIs before writing a single line |
| Switch environments | Switch between test and live mode by changing one variable |
Everything You Need
| Category | What you can do |
|---|---|
| Accept Payments | Cards, bank transfers, mobile money, invoices, payment links |
| Send Money | Single transfers, bulk payouts, beneficiary management |
| Virtual Accounts | Create dedicated accounts for customers |
| Customers | Create and manage customer records |
| Bills Payment | Airtime, data, TV, electricity, internet |
| Identity | BVN lookup, bank account verification |
| Transactions | History, refunds, status checks |
| Wallet | Balance, settlements, fee info |
Quick Start
1. Import the Collection
Open Postman, click Import, and select the downloaded JSON file.
2. Add Your API Key
Navigate to the collection variables and set your secret_key:
- Test mode: Use keys from your test dashboard (opens in a new tab) (
sk_test_...) - Live mode: Use production keys (
sk_live_...)
3. Make Your First Request
Try GET /bank_list/NGN to confirm your setup is working.
Use test mode during development. No real money moves, and you can experiment freely.
Pro Tips
Organize with Environments
Create separate Postman environments for test and production:
| Environment | Secret Key | When to use |
|---|---|---|
| BudPay Test | sk_test_xxxxx | Development, debugging, demos |
| BudPay Live | sk_live_xxxxx | Production only |
Testing Your Integration
BudPay provides a comprehensive sandbox environment for testing:
Test Card Numbers:
| Card Type | Number | CVV | Expiry |
|---|---|---|---|
| Visa | 4242424242424242 | 123 | 12/25 |
| Visa (V2) | 4000000000001091 | 484 | 12/29 |
| Mastercard | 5123450000000008 | 100 | 12/25 |
| Verve | 5060990580000217499 | 123 | 12/25 |
Test Mobile Money Numbers:
- Kenya (M-Pesa):
254712345678 - Ghana (MTN):
233244000000
Remember: Always use test credentials in sandbox mode. Switch to live keys only when ready for production.
Ready to Integrate?
Once you have tested the APIs, dive into the full documentation:
- Authentication: Secure every API call
- Accept Payments: Start collecting payments today
- Payouts: Send money anywhere
- Webhooks: Get notified in real-time