> ## Documentation Index > Fetch the complete documentation index at: https://paystack-sdk.efobi.dev/llms.txt > Use this file to discover all available pages before exploring further. # Virtual Account > Dedicated Virtual Account API methods for creating and managing virtual accounts The VirtualAccount class provides methods for interacting with Paystack's Dedicated Virtual Account API. Virtual accounts allow you to receive payments via bank transfers with automatically generated account numbers. ## Overview The VirtualAccount class allows you to: * Create dedicated virtual accounts for customers * Assign virtual accounts to existing customers * List and fetch virtual account details * Manage splits on virtual accounts * Requery accounts for new transactions * Deactivate virtual accounts * Fetch available bank providers ## Methods ### create Creates a dedicated virtual account. ```typescript theme={null} async create(input: VirtualAccountCreateInput): Promise ``` Customer ID or code The preferred bank slug for the virtual account Subaccount code to assign to the virtual account Split code to assign to the virtual account Customer's first name Customer's last name Customer's phone number The bank name The bank ID The bank slug The account name The generated virtual account number Whether the account is assigned The account currency Whether the account is active Customer details including id, email, and customer\_code **Example:** ```typescript theme={null} const { data, error } = await paystack.virtualAccount.create({ customer: "CUS_abc123", preferred_bank: "wema-bank" }); if (data) { console.log(data.data.account_number); } ``` *** ### assign Assigns a dedicated virtual account to a customer. ```typescript theme={null} async assign(input: VirtualAccountAssignInput): Promise ``` Customer's email address Customer's first name Customer's last name Customer's phone number Customer's country code Customer's account number for validation (Nigeria only) Customer's Bank Verification Number (Nigeria only) Customer's bank code Subaccount code to assign Split code to assign **Example:** ```typescript theme={null} const { data, error } = await paystack.virtualAccount.assign({ email: "customer@example.com", first_name: "John", last_name: "Doe", phone: "+2348012345678", country: "NG", bvn: "12345678901" }); if (data) { console.log(data.message); } ``` *** ### list Lists dedicated virtual accounts. ```typescript theme={null} async list(input: VirtualAccountListInput): Promise ``` Filter by active status Filter by currency (defaults to NGN) Filter by provider slug Filter by bank ID Filter by customer ID or code Array of virtual account objects Bank details (name, id, slug) The account name The account number Whether the account is assigned Whether the account is active Associated customer details Pagination metadata including total, page, perPage, and pageCount **Example:** ```typescript theme={null} const { data, error } = await paystack.virtualAccount.list({ active: true, currency: "NGN", customer: "CUS_abc123" }); if (data) { console.log(`Found ${data.meta.total} virtual accounts`); } ``` *** ### fetch Retrieves details of a dedicated virtual account. ```typescript theme={null} async fetch(dedicated_account_id: string): Promise ``` The ID of the dedicated virtual account Bank details (name, id, slug) The account name The account number Whether the account is assigned The currency Whether the account is active Full customer details including metadata and phone The split configuration if any **Example:** ```typescript theme={null} const { data, error } = await paystack.virtualAccount.fetch("12345"); if (data) { console.log(data.data.account_number); } ``` *** ### requery Requeries a dedicated virtual account for new transactions. ```typescript theme={null} async requery(input: VirtualAccountRequeryInput): Promise ``` The virtual account number The provider slug ISO date to check for transactions (optional) **Example:** ```typescript theme={null} const { data, error } = await paystack.virtualAccount.requery({ account_number: "0123456789", provider_slug: "wema-bank", date: "2024-01-15" }); if (data) { console.log(data.message); } ``` *** ### deactivate Deactivates a dedicated virtual account. ```typescript theme={null} async deactivate(dedicated_account_id: string): Promise ``` The ID of the dedicated virtual account to deactivate The deactivated virtual account details with active status set to false **Example:** ```typescript theme={null} const { data, error } = await paystack.virtualAccount.deactivate("12345"); if (data) { console.log(`Account ${data.data.account_number} deactivated`); } ``` *** ### addSplit Adds a split to a dedicated virtual account. ```typescript theme={null} async addSplit(input: VirtualAccountAddSplitInput): Promise ``` Customer ID or code Subaccount code Split code Preferred bank slug Updated virtual account with split\_config containing the split\_code **Example:** ```typescript theme={null} const { data, error } = await paystack.virtualAccount.addSplit({ customer: "CUS_abc123", split_code: "SPL_xyz789" }); if (data) { console.log(data.data.split_config.split_code); } ``` *** ### removeSplit Removes a split from a dedicated virtual account. ```typescript theme={null} async removeSplit(input: VirtualAccountRemoveSplitInput): Promise ``` The virtual account number The account ID Empty object indicating split has been removed The account number **Example:** ```typescript theme={null} const { data, error } = await paystack.virtualAccount.removeSplit({ account_number: "0123456789" }); if (data) { console.log("Split removed successfully"); } ``` *** ### fetchBanks Fetches available bank providers for dedicated virtual accounts. ```typescript theme={null} async fetchBanks(): Promise ``` Array of available bank providers The provider slug The bank ID The bank name The provider ID **Example:** ```typescript theme={null} const { data, error } = await paystack.virtualAccount.fetchBanks(); if (data) { data.data.forEach(bank => { console.log(`${bank.bank_name}: ${bank.provider_slug}`); }); } ``` ## Related Resources * [Dedicated Virtual Accounts Guide](/guides/virtual-accounts) * [Split API Reference](/api-reference/split)