Virtual Accounts Overview
Virtual Accounts let you give customers a bank account number to pay into. When a customer transfers to the account, funds are automatically routed to your BudPay wallet.
🇳🇬
Nigeria Only: This feature is only available to businesses in Nigeria.
Overview
You can create two types of virtual account:
| Type | Description |
|---|---|
| Reserved | A permanent account that can receive multiple payments over time, suited to recurring payments, subscriptions, and customer wallets |
| Checkout | A temporary account for a single payment of a fixed amount, which expires after a set number of minutes |
Key Features
| Feature | Description |
|---|---|
| Reserved & Checkout Accounts | Create permanent accounts or short-lived, fixed-amount accounts |
| Choice of Bank | Pick the partner bank the account is issued from |
| Automatic Routing | Payments are automatically credited to your BudPay wallet |
| Your Own References | Look up any account by the reference you assigned it |
| Real-Time Notifications | Receive webhooks when payments are received |
Supported Banks
Bank Partners: Call Fetch Bank List for the current list of partner banks and their bankCode values.
Partner banks include Globus Bank, Parallex Bank, UBA, Stanbic IBTC, Access Bank, FCMB, Sterling Bank, and Wema Bank.
Virtual Account Workflow
1. Choose a Bank
- Call Fetch Bank List to get the available banks
- Pick the
bankCodeyou want the account issued from
2. Create Virtual Account
- Send the customer's details, a unique
reference, and the account type - For
checkoutaccounts, also set theamountandexpiryInMinutes - Receive the account number and bank details instantly
3. Customer Makes Payment
- Customer transfers to the virtual account number
- Payment is processed automatically by the bank
- Funds are credited to your BudPay wallet
4. Receive Notification
- A webhook is sent to your server with payment details
- Use your
referenceto reconcile the payment - Update your system with payment confirmation
Available Endpoints
| Endpoint | Method | Description |
|---|---|---|
| Fetch Bank List | GET | Get the partner banks available for virtual accounts |
| Create Virtual Account | POST | Create a reserved or checkout virtual account |
| Fetch by Reference | GET | Get a virtual account by the reference you assigned |
| Fetch by Account Number | GET | Get a virtual account by its account number |
Legacy Endpoints
These endpoints work with dedicated virtual accounts assigned to a customer code.
| Endpoint | Method | Description |
|---|---|---|
| List Dedicated Accounts | GET | Retrieve all dedicated accounts on your integration |
| Bulk Dedicated Accounts | POST | Generate multiple dedicated accounts in batch |
Next Steps
- Fetch Bank List - See which banks you can use
- Create Virtual Account - Create your first virtual account
- Fetch by Reference - Look up an account you created