dedicated_virtual_account.md

DedicatedVirtualAccount

A collection of endpoints for creating and managing payment accounts for customers

Methods

Method	HTTP	Path	Summary
dedicated_account_add_split	POST	/dedicated_account/split	Split Dedicated Account Transaction
dedicated_account_assign	POST	/dedicated_account/assign	Assign Dedicated Account
dedicated_account_available_providers	GET	/dedicated_account/available_providers	Fetch Bank Providers
dedicated_account_create	POST	/dedicated_account	Create Dedicated Account
dedicated_account_deactivate	DELETE	/dedicated_account/{id}	Deactivate Dedicated Account
dedicated_account_fetch	GET	/dedicated_account/{id}	Fetch Dedicated Account
dedicated_account_list	GET	/dedicated_account	List Dedicated Accounts
dedicated_account_remove_split	DELETE	/dedicated_account/split	Remove Split from Dedicated Account
dedicated_account_requery	GET	/dedicated_account/requery	Requery Dedicated Account

---

dedicated_account_add_split

HTTP: POST
Path: /dedicated_account/split

paystack.dedicated_virtual_account.dedicated_account_add_split({ ... })

Body Fields

Name	Required
account_number	true
subaccount	false
split_code	false

dedicated_account_assign

HTTP: POST
Path: /dedicated_account/assign

paystack.dedicated_virtual_account.dedicated_account_assign({ ... })

Body Fields

Name	Required
email	true
first_name	true
last_name	true
phone	true
preferred_bank	true
country	true
account_number	false
bvn	false
bank_code	false
subaccount	false
split_code	false

dedicated_account_available_providers

HTTP: GET
Path: /dedicated_account/available_providers

paystack.dedicated_virtual_account.dedicated_account_available_providers

dedicated_account_create

HTTP: POST
Path: /dedicated_account

paystack.dedicated_virtual_account.dedicated_account_create({ ... })

Body Fields

Name	Required
customer	true
preferred_bank	false
subaccount	false
split_code	false

dedicated_account_deactivate

HTTP: DELETE
Path: /dedicated_account/{id}

paystack.dedicated_virtual_account.dedicated_account_deactivate(id)

Path Parameters

Name	Required
id	true

dedicated_account_fetch

HTTP: GET
Path: /dedicated_account/{id}

paystack.dedicated_virtual_account.dedicated_account_fetch(id)

Path Parameters

Name	Required
id	true

dedicated_account_list

HTTP: GET
Path: /dedicated_account

paystack.dedicated_virtual_account.dedicated_account_list({ ... })

Query Fields

Name	Required
active	false
customer	false
currency	false
provider_slug	false
bank_id	false
perPage	false
page	false

dedicated_account_remove_split

HTTP: DELETE
Path: /dedicated_account/split

paystack.dedicated_virtual_account.dedicated_account_remove_split({ ... })

Body Fields

Name	Required
account_number	true

dedicated_account_requery

HTTP: GET
Path: /dedicated_account/requery

paystack.dedicated_virtual_account.dedicated_account_requery({ ... })

Query Fields

Name	Required
account_number	false
provider_slug	false
date	false