{"info":{"_postman_id":"0d1b7d26-f09a-49fb-bcd4-0089651249f0","name":"ZenithPay_old","description":"

API Documentation: Assign Dedicated Virtual Account

This document outlines the process for assigning a dedicated virtual account to an API user using the dedicated_account/assign endpoint.

Endpoint

POST https://zenithpay.ng/api/dedicated_account/assign

Description

This endpoint allows you to programmatically assign a dedicated virtual account to a specified API user. This account can then be used for receiving payments and will be linked to the provided user details.

Authentication

This endpoint requires authentication using a Bearer Token.

Header: Authorization: Bearer YOUR_AUTH_TOKEN
\n
Replace YOUR_AUTH_TOKEN with your actual authentication token obtained from XpressVerify.
\n

Request

Method

POST

Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Value	Description
`Content-Type`	`application/x-www-form-urlencoded`	The media type of the request body. (As per the provided `CURLOPT_POSTFIELDS` array)
`Accept`	`application/json`	Specifies that the client can process JSON responses.
`Accept-Encoding`	`gzip, deflate`	(Optional) Indicates acceptable content encodings.
`Authorization`	`Bearer YOUR_AUTH_TOKEN`	Your unique authentication token.

Body (Form Data)

The request body should be sent as application/x-www-form-urlencoded with the following parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description	Example
`bvn`	`string`	Yes	The Bank Verification Number (BVN) of the user.	`12345678910`
`account_name`	`string`	Yes	The desired name for the virtual account.	`ZTS`
`first_name`	`string`	Yes	The first name of the user.	`John`
`last_name`	`string`	Yes	The last name of the user.	`Doe`
`email`	`string`	Yes	The email address of the user. This will be used for notifications.	`JohnDoe@doe.ng`

Example Request (PHP cURL)

PHP

$curl = curl_init();\ncurl_setopt_array($curl, array(\n  CURLOPT_URL => '{{BaseURL}}/api/dedicated_account/assign',\n  CURLOPT_RETURNTRANSFER => true,\n  CURLOPT_ENCODING => '',\n  CURLOPT_MAXREDIRS => 10,\n  CURLOPT_TIMEOUT => 0,\n  CURLOPT_FOLLOWLOCATION => true,\n  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n  CURLOPT_CUSTOMREQUEST => 'POST',\n  CURLOPT_POSTFIELDS => array('bvn' => '12345678910','account_name' => 'ZTS','first_name' => 'John','last_name' => 'Doe','email' => 'JohnDoe@doe.ng'),\n  CURLOPT_HTTPHEADER => array(\n    'Accept: application/json',\n    'Accept-Encoding: gzip, deflate,',\n    'Authorization: Bearer YOUR_AUTH_TOKEN' // <--- Add your bearer token here\n  ),\n));\n$response = curl_exec($curl);\ncurl_close($curl);\necho $response;\n?>\n\n

Note: Replace YOUR_AUTH_TOKEN with your actual authentication token.

Response

The API will respond with a JSON object.

Success Response (Status Code: `200 OK`)

{\n    \"status\": true,\n    \"response_code\": \"00\",\n    \"accountReference\": \"ZTSVA-01JXBCKMGSDD6FXDNTNB\",\n    \"accountName\": \"ZTS PAYYOURBILLS(ZTS)\",\n    \"customerEmail\": \"John@Doe.ng\",\n    \"customerName\": \"John\",\n    \"bankName\": \"PALMPAY\",\n    \"accountNumber\": \"1234567890\",\n    \"identityType\": \"personal\",\n    \"BVN\": \"12345678911\",\n    \"accountStatus\": \"Enabled\",\n    \"createdOn\": \"2025-06-09T22:22:33.417004Z\",\n    \"processed_by\": \"ZTSPayPoint\"\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"API Documentation: Assign Dedicated Virtual Account","slug":"api-documentation-assign-dedicated-virtual-account"}],"owner":"13400303","collectionId":"0d1b7d26-f09a-49fb-bcd4-0089651249f0","publishedId":"2sB2x9krVa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-19T12:47:19.000Z"},"item":[{"name":"Dedicate Account","id":"f5c885d4-a6b7-4349-b882-8a1bdbd0271c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Accept-Encoding","value":"gzip, deflate, br","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"bvn","value":"","type":"text","uuid":"2b8d968f-6af1-43c6-acf9-2890010d4761"},{"key":"account_name","value":"","type":"text","uuid":"bb35750d-49a4-4447-8a33-f70a0ec52ee7"},{"key":"first_name","value":"","type":"text","uuid":"9bfb9816-865d-45af-9187-261aa40de7d9"},{"key":"last_name","value":"","type":"text","uuid":"9255641c-faa2-457f-8ce9-06733787af74"},{"key":"email","value":"","type":"text","uuid":"ed241b1a-3324-4f24-acf1-2dc93e751e97"}]},"url":"https://zenithpay.ng/api/dedicated_account/assign","urlObject":{"protocol":"https","path":["api","dedicated_account","assign"],"host":["zenithpay","ng"],"query":[],"variable":[]}},"response":[{"id":"60b2bd3d-4ac6-407c-b445-9a0e411cce53","name":"Dedicate Account","originalRequest":{"method":"POST","header":[],"url":"https://zenithpay.ng/api/dedicated_account/assign"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f5c885d4-a6b7-4349-b882-8a1bdbd0271c"},{"name":"New Request","id":"b7090fe4-a11b-44b4-aba1-d4c0b09d7583","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"b7090fe4-a11b-44b4-aba1-d4c0b09d7583"}]}