Bulk Dedicated Virtual Accounts
Generate bulk virtual account numbers for customers using a batch ID.
🇳🇬
Nigeria Only: This feature is only available to businesses in Nigeria.
Supported Banks: Wema Bank and Premium Trust.
Create Bulk Dedicated Virtual Accounts
Endpoint: POST https://api.budpay.com/api/v2/dedicated_bulk_virtual_account
Parameters
This section details the header information required for creating bulk dedicated virtual accounts.
| Field Name | Description |
|---|---|
| URL | https://api.budpay.com/api/v2/dedicated_bulk_virtual_account |
| Method | POST |
| Authorization | Bearer YOUR_SECRET_KEY (Replace with your actual BudPay secret key) |
| Content-Type | application/json |
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
batchId | String | Yes | Batch ID for the bulk creation |
🧪
Testing: Use your test secret key to create bulk accounts in sandbox mode.
Sample Request
curl https://api.budpay.com/api/v2/dedicated_bulk_virtual_account \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "batchId": "65c1368420424" }' \
-X POSTSample Response
{
"status": true,
"message": "NUBAN accounts successfully created",
"totalCreated": 3,
"totalSkipped": 0,
"data": [
{
"businesses_id": 25,
"customer_id": 8242070,
"account_name": "Afg / Test 1 Test 1",
"account_number": "1969038145",
"bank_name": "BudPay Bank",
"currency": "NGN",
"domain": "test",
"status": "active",
"provider_id": "1",
"reference": "js1uydt88xjsvih",
"assignment": "reserved",
"created_at": "2025-07-02T10:11:35.000000Z",
"id": 7912727
},
{
"businesses_id": 25,
"customer_id": 8242071,
"account_name": "Afg / Test 2 Test 2",
"account_number": "1691707728",
"bank_name": "BudPay Bank",
"currency": "NGN",
"domain": "test",
"status": "active",
"provider_id": "1",
"reference": "rdw3ce6i2zr0lqv",
"assignment": "reserved",
"created_at": "2025-07-02T10:11:35.000000Z",
"id": 7912728
},
{
"businesses_id": 25,
"customer_id": 8242072,
"account_name": "Afg / Test 3 Test 3",
"account_number": "1288698105",
"bank_name": "BudPay Bank",
"currency": "NGN",
"domain": "test",
"status": "active",
"provider_id": "1",
"reference": "vdyxm34j3nzlyc8",
"assignment": "reserved",
"created_at": "2025-07-02T10:11:35.000000Z",
"id": 7912729
}
]
}Try it out
Response Fields
| Field | Description |
|---|---|
totalCreated | Number of accounts successfully created |
totalSkipped | Number of accounts skipped (already exist) |
account_name | Generated account name (Business Name / Customer Name) |
account_number | Dedicated NUBAN account number |
bank_name | Bank providing the virtual account |
reference | Unique reference for each account |
status | Account status (active, inactive) |