Dedicated Virtual Accounts
Create and manage unique payment accounts for your customers. Each customer gets a dedicated bank account number that routes payments directly to your BudPay wallet.
🇳🇬
Nigeria Only: This feature is only available to businesses in Nigeria.
Supported Banks: Wema Bank, VedantMFB, and Coronation Bank.
Create Dedicated Virtual Account
Assign a dedicated virtual account to a customer.
Endpoint: POST https://api.budpay.com/api/v2/dedicated_virtual_account
Parameters
This section details the header information required for creating a dedicated virtual account.
| Field Name | Description |
|---|---|
| URL | https://api.budpay.com/api/v2/dedicated_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 |
|---|---|---|---|
customer | String | Yes | Customer code (e.g., CUS_3hqlcizuoffygev) |
Sample Request
curl https://api.budpay.com/api/v2/dedicated_virtual_account \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{ "customer": "CUS_3hqlcizuoffygev" }' \
-X POSTSample Response
{
"status": true,
"message": "NUBAN successfully created",
"data": {
"bank": {
"name": "Wema Bank",
"id": 1,
"bank_code": "000017",
"prefix": "802"
},
"account_name": "Samji Ventures / Tolu Oye",
"account_number": 72354838393,
"currency": "NGN",
"status": null,
"reference": "xq3tvdirdamgorc",
"assignment": "reserved",
"id": 47,
"created_at": "2022-03-12T05:03:18.000000Z",
"updated_at": "2022-03-12T05:03:18.000000Z",
"customer": {
"id": 4,
"first_name": "Tolu",
"last_name": "Oye",
"email": "toluxsys@yahoo.ca",
"customer_code": "CUS_ctiv4kdyniqtjqe",
"phone": "07036218209"
}
}
}Try it out
Response Fields
| Field | Description |
|---|---|
account_name | Generated account name (Business Name / Customer Name) |
account_number | Dedicated NUBAN account number |
bank.name | Bank providing the virtual account |
bank.bank_code | Bank's CBN code |
currency | Account currency (NGN) |
reference | Unique reference for the account |
customer | Customer details attached to the account |