{"info":{"_postman_id":"c907ec36-0598-450e-8204-c5f8eb04bab9","name":"Deeppaya - VTU","description":"<html><head></head><body><p>Here, you will find the endpoints to make Airtime and Data Purchase of all network</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"46373164","collectionId":"c907ec36-0598-450e-8204-c5f8eb04bab9","publishedId":"2sB34Zs5Le","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8059fa"},"publishDate":"2025-07-02T04:56:17.000Z"},"item":[{"name":"Airtime and Data Bundle","item":[{"name":"Buy Airtime","id":"95fea035-992d-43f3-9fd0-f2b68bb28b62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"phone_number\": \"08141314105\",\n    \"network\": \"mtn\",\n    \"amount\": \"100\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/vtu/airtime","description":"<h2 id=\"add-phone-number-for-payment\">Add Phone Number for Payment</h2>\n<p>This endpoint allows users to initiate a payment by providing their phone number, the network provider, and the amount to be processed. It is typically used in payment applications where users can make transactions via their mobile networks.</p>\n<h3 id=\"request-format\">Request Format</h3>\n<ul>\n<li><p><strong>Method</strong>: POST</p>\n</li>\n<li><p><strong>URL</strong>: <code>{{base_url}}/vtu/airtime</code></p>\n</li>\n</ul>\n<h3 id=\"request-body\">Request Body</h3>\n<p>The request body must be in JSON format and include the following parameters:</p>\n<ul>\n<li><p><strong>phone_number</strong> (string): The phone number of the user initiating the payment. It should be formatted as a string.</p>\n</li>\n<li><p><strong>network</strong> (string): The network provider for the phone number (e.g., \"mtn\", \"vodafone\").</p>\n</li>\n<li><p><strong>amount</strong> (string): The amount of money to be processed for the payment, represented as a string.</p>\n</li>\n</ul>\n<h4 id=\"example-request-body\">Example Request Body</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"phone_number\": \"08141314105\",\n  \"network\": \"mtn\",\n  \"amount\": \"100\"\n}\n\n</code></pre>\n<h3 id=\"response-structure\">Response Structure</h3>\n<p>Upon a successful request, the server will respond with a JSON object containing the result of the payment initiation. The exact structure of the response will depend on the implementation, but it typically includes:</p>\n<ul>\n<li><p><strong>status</strong> (string): Indicates the success or failure of the payment initiation.</p>\n</li>\n<li><p><strong>transaction_id</strong> (string): A unique identifier for the transaction if successful.</p>\n</li>\n<li><p><strong>message</strong> (string): A descriptive message regarding the outcome of the request.</p>\n</li>\n</ul>\n<h3 id=\"example-response\">Example Response</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"status\": \"success\",\n  \"transaction_id\": \"123456789\",\n  \"message\": \"Payment initiated successfully.\"\n}\n\n</code></pre>\n<p>Ensure to handle errors appropriately based on the response received from the server.</p>\n","urlObject":{"path":["vtu","airtime"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"95fea035-992d-43f3-9fd0-f2b68bb28b62"},{"name":"Buy Data","id":"2a4fdc8f-8491-403a-b90b-dc35b1800c23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n    \"phone_number\": \"08141314105\",\n    \"network\": \"mtn\",\n    \"plan_id\": \"11\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/vtu/data","description":"<h2 id=\"buy-data\">Buy Data</h2>\n<p>This endpoint allows users to initiate a data purchase by providing their phone number, the network provider, and the plan ID associated with the data plan. It is typically used in payment applications where users can make transactions via their mobile networks.</p>\n<h3 id=\"purpose\">Purpose</h3>\n<p>The primary purpose of this request is to facilitate mobile payments by capturing necessary user details such as the phone number and the network provider. This information is essential for processing payments through various mobile network operators.</p>\n<h3 id=\"request-format\">Request Format</h3>\n<ul>\n<li><p><strong>Method</strong>: POST</p>\n</li>\n<li><p><strong>URL</strong>: <code>{{base_url}}/vtu/data</code></p>\n</li>\n</ul>\n<h3 id=\"request-body\">Request Body</h3>\n<p>The request body must be in JSON format and include the following parameters:</p>\n<ul>\n<li><p><strong>phone_number</strong> (string): The phone number of the user initiating the payment. It should be formatted as a string.</p>\n</li>\n<li><p><strong>network</strong> (string): The network provider for the phone number (e.g., \"mtn\", \"vodafone\").</p>\n</li>\n<li><p><strong>plan_id</strong> (string): The identifier for the specific plan associated with the payment.</p>\n</li>\n</ul>\n<h4 id=\"example-request-body\">Example Request Body</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"phone_number\": \"08141314105\",\n  \"network\": \"mtn\",\n  \"plan_id\": \"11\"\n}\n\n</code></pre>\n<h3 id=\"response-structure\">Response Structure</h3>\n<p>Upon a successful request, the server will respond with a JSON object containing the result of the payment initiation. The exact structure of the response will depend on the implementation, but it typically includes:</p>\n<ul>\n<li><p><strong>status</strong> (string): Indicates the success or failure of the payment initiation.</p>\n</li>\n<li><p><strong>transaction_id</strong> (string): A unique identifier for the transaction if successful.</p>\n</li>\n<li><p><strong>message</strong> (string): A descriptive message regarding the outcome of the request.</p>\n</li>\n</ul>\n<h3 id=\"example-response\">Example Response</h3>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n  \"status\": \"success\",\n  \"transaction_id\": \"123456789\",\n  \"message\": \"Payment initiated successfully.\"\n}\n\n</code></pre>\n<p>Ensure to handle errors appropriately based on the response received from the server.</p>\n","urlObject":{"path":["vtu","data"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a4fdc8f-8491-403a-b90b-dc35b1800c23"}],"id":"c6d3803d-3bc7-44f9-bd2a-b8c035c93dfb","description":"<p>Here, you will find the endpoints to make Airtime and Data Purchase of all network</p>\n","_postman_id":"c6d3803d-3bc7-44f9-bd2a-b8c035c93dfb"},{"name":"User Account","item":[{"name":"Get User","id":"bdcbb0d5-afa8-4bdb-8dba-6b69dba3fb7b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"{{base_url}}/user","description":"<h2 id=\"get-user-information\">Get User Information</h2>\n<p>This endpoint retrieves information about a user. It is a simple HTTP GET request that returns user details based on the provided parameters.</p>\n<h3 id=\"request-parameters\">Request Parameters</h3>\n<ul>\n<li><strong>userId</strong> (optional): A unique identifier for the user. If provided, the response will return details for the specified user. If not provided, the response may return a list of users or a default user.</li>\n</ul>\n<h3 id=\"expected-response\">Expected Response</h3>\n<p>The response will include:</p>\n<ul>\n<li><p><strong>status</strong>: Indicates the success or failure of the request.</p>\n</li>\n<li><p><strong>data</strong>: Contains the user information, which may include fields such as <code>id</code>, <code>name</code>, <code>email</code>, and other relevant user details.</p>\n</li>\n<li><p><strong>message</strong>: A descriptive message related to the request status.</p>\n</li>\n</ul>\n<h3 id=\"notes\">Notes</h3>\n<ul>\n<li><p>Ensure that the <code>userId</code> parameter is correctly formatted to avoid errors.</p>\n</li>\n<li><p>The response structure may vary based on the presence of the <code>userId</code> parameter.</p>\n</li>\n<li><p>Authentication may be required to access this endpoint, depending on the API's security settings.</p>\n</li>\n</ul>\n","urlObject":{"path":["user"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bdcbb0d5-afa8-4bdb-8dba-6b69dba3fb7b"}],"id":"4864858d-482b-49aa-9a48-904f4e778d19","description":"<p>Here you will find how to get an account information such as account balance, account status etc.</p>\n","_postman_id":"4864858d-482b-49aa-9a48-904f4e778d19"}]}