{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0d1b7d26-f09a-49fb-bcd4-0089651249f0","name":"ZenithPay_old","description":"# API Documentation: Assign Dedicated Virtual Account\n\nThis document outlines the process for assigning a dedicated virtual account to an API user using the `dedicated_account/assign` endpoint.\n\n## Endpoint\n\n`POST https://zenithpay.ng/api/dedicated_account/assign`\n\n## Description\n\nThis 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.\n\n## Authentication\n\nThis endpoint requires authentication using a Bearer Token.\n\n- **Header:** `Authorization: Bearer YOUR_AUTH_TOKEN`\n    \n- Replace `YOUR_AUTH_TOKEN` with your actual authentication token obtained from XpressVerify.\n    \n\n## Request\n\n### Method\n\n`POST`\n\n### Headers\n\n| Header | Value | Description |\n| --- | --- | --- |\n| `Content-Type` | `application/x-www-form-urlencoded` | The media type of the request body. (As per the provided `CURLOPT_POSTFIELDS` array) |\n| `Accept` | `application/json` | Specifies that the client can process JSON responses. |\n| `Accept-Encoding` | `gzip, deflate` | (Optional) Indicates acceptable content encodings. |\n| `Authorization` | `Bearer YOUR_AUTH_TOKEN` | Your unique authentication token. |\n\n### Body (Form Data)\n\nThe request body should be sent as `application/x-www-form-urlencoded` with the following parameters:\n\n| Parameter | Type | Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `bvn` | `string` | Yes | The Bank Verification Number (BVN) of the user. | `12345678910` |\n| `account_name` | `string` | Yes | The desired name for the virtual account. | `ZTS` |\n| `first_name` | `string` | Yes | The first name of the user. | `John` |\n| `last_name` | `string` | Yes | The last name of the user. | `Doe` |\n| `email` | `string` | Yes | The email address of the user. This will be used for notifications. | `JohnDoe@doe.ng` |\n\n## Example Request (PHP cURL)\n\nPHP\n\n``` php\n$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 ```\n\n**Note:** Replace `YOUR_AUTH_TOKEN` with your actual authentication token.\n\n## Response\n\nThe API will respond with a JSON object.\n\n### Success Response (Status Code: `200 OK`)\n\n``` json\n{\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 ```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13400303","team":8231246,"collectionId":"0d1b7d26-f09a-49fb-bcd4-0089651249f0","publishedId":"2sB2x9krVa","public":true,"publicUrl":"https://documenter-api.postman.tech/view/13400303/2sB2x9krVa","privateUrl":"https://go.postman.co/documentation/13400303-0d1b7d26-f09a-49fb-bcd4-0089651249f0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-06-19T12:47:19.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/801cc8881e5ccce901a613cc1155bd4ff2631c40316b91b872cd0afb222b5d9c","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sB2x9krVa"}