Invoice Overview
BudPay's Invoice API enables you to create, manage, and send professional invoices to your customers. With support for multiple payment methods and automatic payment tracking, you can streamline your billing process and get paid faster.
What is BudPay Invoice?
BudPay Invoice is a comprehensive invoicing solution that allows businesses to:
- Create Professional Invoices: Generate detailed invoices with line items, customer information, and billing details
- Accept Multiple Payment Methods: Customers can pay via card, bank transfer, or mobile money
- Track Payment Status: Monitor invoice payments in real-time with automatic notifications
- Automate Collections: Send payment reminders and reduce manual follow-ups
- Manage Customer Records: Keep track of customer information and payment history
Key Features
1. Easy Invoice Creation
Create invoices with a simple API call. Include multiple line items, custom invoice numbers, and detailed billing information.
2. Flexible Payment Options
Customers can pay invoices using:
- Credit/Debit Cards (Visa, Mastercard, Verve)
- Bank Transfer (Direct bank account payment)
- Mobile Money (Available in supported countries)
3. Automated Notifications
- Email notifications sent to customers when invoices are created
- Payment confirmation emails for both merchant and customer
- Webhook notifications for real-time payment updates
4. Multi-Currency Support
Create invoices in multiple currencies including:
- NGN (Nigerian Naira)
- USD (US Dollar)
- GHS (Ghanaian Cedi)
- KES (Kenyan Shilling)
5. Payment Tracking
- Real-time payment status updates
- Comprehensive payment history
- Easy reconciliation with transaction records
How It Works
The invoice flow is simple and straightforward:
Step 1: Create Invoice
Merchant → API Request → BudPaySend customer and invoice details to BudPay's create invoice endpoint.
Step 2: Share Payment Link
BudPay → Payment Link → CustomerBudPay generates a unique payment link that you share with your customer.
Step 3: Customer Pays
Customer → Payment → BudPayCustomer opens the link and completes payment using their preferred method.
Step 4: Receive Notification
BudPay → Webhook/Email → MerchantYou receive instant notification when payment is completed.
Use Cases
Freelancers & Consultants
Send professional invoices for services rendered with detailed line items for different project phases or deliverables.
E-commerce Businesses
Generate invoices for bulk orders or B2B transactions with itemized product lists and shipping details.
Service Providers
Bill customers for recurring services, subscription renewals, or one-time service fees.
Agencies & Studios
Create detailed invoices for client projects with multiple service categories and transparent pricing.
API Endpoints
BudPay Invoice API provides the following endpoints:
| Endpoint | Method | Description |
|---|---|---|
/api/v2/create_invoice | POST | Create a new invoice |
/api/v2/get_invoice/{invoice_id} | GET | Retrieve invoice details |
/api/v2/list_invoices | GET | List all invoices |
/api/v2/update_invoice/{invoice_id} | PUT | Update invoice details |
/api/v2/cancel_invoice/{invoice_id} | POST | Cancel an invoice |
Invoice Status Types
Invoices in BudPay can have the following statuses:
| Status | Description |
|---|---|
pending | Invoice created but payment not yet received |
paid | Invoice fully paid by customer |
partially_paid | Invoice partially paid (if partial payments are enabled) |
overdue | Invoice past due date without payment |
cancelled | Invoice cancelled by merchant |
Best Practices
Pro Tips for Using BudPay Invoices
-
Clear Descriptions: Provide detailed, clear descriptions for each line item to avoid customer confusion.
-
Reasonable Due Dates: Set realistic payment deadlines that give customers adequate time to process payment.
-
Professional Details: Include complete customer information (name, address, contact) for professional invoices.
-
Custom Invoice Numbers: Use your own invoice numbering system for better record-keeping and accounting.
-
Verify Payments: Always verify payment status via the API before fulfilling orders or delivering services.
-
Send Reminders: Use the reminder feature to automatically follow up on unpaid invoices.
-
Track Everything: Monitor all invoices regularly to identify payment patterns and manage cash flow.
Security & Compliance
BudPay Invoice API is built with security in mind:
- Encrypted Communication: All API requests use HTTPS encryption
- API Key Authentication: Secure authentication using Bearer tokens
- PCI DSS Compliant: Card payment processing meets industry security standards
- Data Protection: Customer information is securely stored and protected
Getting Started
Ready to start using BudPay Invoice? Here's what you need:
- BudPay Account: Sign up for a BudPay merchant account
- API Keys: Get your API keys from the BudPay dashboard
- Webhook URL: Configure your webhook endpoint for payment notifications
- Integration: Follow our Create Invoice guide to make your first API call
Important: Always use your test API keys during development and switch to live keys only when ready for production.
Support & Resources
Need help with BudPay Invoice?
- API Documentation: Detailed guides for each endpoint
- Code Examples: Sample code in multiple programming languages
- Support Team: Contact our technical support team for assistance
- Community: Join our developer community for tips and best practices
Next Steps
- Create Your First Invoice - Learn how to create invoices via API
- Manage Invoices - Update, retrieve, and cancel invoices
- Handle Webhooks - Process payment notifications automatically
- Test Integration - Try the API in test mode