Customers API
The Customers API allows you to create and manage customer records on your BudPay integration. Customer records are essential for tracking transactions, assigning virtual accounts, and managing recurring payments.
Key Features
- Customer Management - Create, update, and retrieve customer information
- Bulk Operations - Create multiple customers in a single API call
- Virtual Account Integration - Link customers to dedicated virtual accounts for seamless payments
- Customer Identification - Unique customer codes for easy reference across transactions
Why Create Customers?
Creating customers on your integration provides several benefits:
| Benefit | Description |
|---|---|
| Transaction Tracking | Associate payments with specific customers for better reporting |
| Virtual Accounts | Assign dedicated virtual accounts to customers for bank transfer payments |
| Customer Insights | View payment history and patterns for each customer |
| Recurring Payments | Enable subscription and recurring billing for registered customers |
Customer Workflow
1. Create Customer → Get customer_code
2. (Optional) Assign Virtual Account → Customer receives unique account number
3. Customer Makes Payment → Payment linked to customer record
4. Track & Manage → View transactions, update detailsAvailable Endpoints
| Endpoint | Method | Description |
|---|---|---|
| Create Customer | POST | Create a single customer |
| Create Bulk Customers | POST | Create multiple customers at once |
| Get Customers By Batch ID | GET | Retrieve customers from a bulk creation batch |
Next Steps
- Create your first customer to start tracking payments
- Create bulk customers for batch onboarding
- Assign virtual accounts to enable bank transfer payments