Documentation for the Hornest-wallet project
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11690328","collectionId":"bc6781dd-aa8b-4b82-85e1-172b354e8fa0","publishedId":"UVe9S9cc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-25T14:49:25.000Z"},"item":[{"name":"auth","item":[{"name":"user sign up","id":"7be5beaa-18b0-4697-8dd3-bffcd8908930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Peter\",\r\n \"lastName\":\"Brock\",\r\n \"email\":\"emmy@gmail.com\",\r\n \"password\":\"123456789\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hornest-api.herokuapp.com/api/v1/auth/register","description":"allows users to sign up on the platform
\n","urlObject":{"protocol":"https","path":["api","v1","auth","register"],"host":["hornest-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"d9878185-0b19-470a-960a-e40f7e2f4b0c","name":"user sign up","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Edmond\",\r\n \"lastName\":\"Kirsch\",\r\n \"email\":\"eddy@gmail.com\",\r\n \"password\":\"123456\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hornest-api.herokuapp.com/api/v1/auth/register"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"user created successfully\",\r\n \"savedUser\": {\r\n \"firstName\": \"Eddie\",\r\n \"lastName\": \"Brock\",\r\n \"email\": \"ewave100@gmail.com\",\r\n \"password\": \"$2a$10$Kby/xwgpNBxwyyZhXqUPx.CPM15nDt/AIuP5I5vV9Xxpy0W3gcj6K\",\r\n \"id\": 16,\r\n \"card\": \"\",\r\n \"cardExpiration\": \"\",\r\n \"cardCvv\": \"\",\r\n \"createdAt\": \"2022-01-08T14:19:09.896Z\",\r\n \"updatedAt\": \"2022-01-08T14:19:09.896Z\"\r\n }\r\n}"}],"_postman_id":"7be5beaa-18b0-4697-8dd3-bffcd8908930"},{"name":"Login","id":"44111779-598a-4ccf-9876-eb8593b1b321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Peter\",\r\n \"lastName\":\"Brock\",\r\n \"email\":\"emmy@gmail.com\",\r\n \"password\":\"123456789\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hornest-api.herokuapp.com/api/v1/auth/login","description":"allows users to sign in on the platform
\n","urlObject":{"protocol":"https","path":["api","v1","auth","login"],"host":["hornest-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"807ccac9-8ed2-4a34-a17c-f8a19c2fceba","name":"Login","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"firstName\":\"Edmond\",\r\n \"lastName\":\"Kirsch\",\r\n \"email\":\"eddy@gmail.com\",\r\n \"password\":\"123456\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hornest-api.herokuapp.com/api/v1/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE3LCJpYXQiOjE2NDE2ODY3MjEsImV4cCI6MTY0MTc3MzEyMX0.He0xsUbEEfPtPOSwjb1ojWUIP7N53uEhZde_DEHp4Ng\",\r\n \"message\": \"Login Successful\"\r\n}"}],"_postman_id":"44111779-598a-4ccf-9876-eb8593b1b321"},{"name":"Edit User Profile","id":"5185ac91-0fac-4a46-a703-a4d585b69609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"allows a user to update hois profile details
\n","urlObject":{"protocol":"https","path":["api","v1","user","update","1"],"host":["hornest-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"be93fec2-11df-46e7-95e3-33d3b4fab485","name":"Edit User","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"card\":\"5531886652142950\",\r\n \"accountNumber\":\"0690000037\",\r\n \"cardCvv\":\"564\",\r\n \"cardExpiration\":\"09/32\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hornest-api.herokuapp.com/api/v1/user/update/1"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"message\": \"user updated successfully\",\r\n \"updatedUser\": {\r\n \"id\": 3,\r\n \"card\": \"2319e9ec91ee271966f913948e27dfd46ac4e04794177732a5ee9c2932b1b268\",\r\n \"cardCvv\": \"64cff3f74f21a43b0b96bd51b64de787\",\r\n \"updatedAt\": \"2022-01-15T18:51:56.145Z\"\r\n }\r\n}"}],"_postman_id":"5185ac91-0fac-4a46-a703-a4d585b69609"},{"name":"Get user","id":"02002215-7497-4e05-9ff8-ddf8ea28045e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"get the data of a specific user
\n","urlObject":{"protocol":"https","path":["api","v1","user"],"host":["hornest-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"67b89635-88f8-481c-ab32-b14ba3241ba6","name":"Get user","originalRequest":{"method":"GET","header":[],"url":"https://hornest-api.herokuapp.com/api/v1/user/"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"firstName\": \"Peter\",\r\n \"lastName\": \"Brock\",\r\n \"email\": \"emmy@gmail.com\",\r\n \"password\": \"$2a$10$0.83PpQxpwN1Eb0YN8It1u3rIV8ep4auPpr1WfhvKSs/NCuV08s9W\",\r\n \"card\": \"03670fc63889670402144d9e23cebe60a3b39f0a6680342b3343cfcffa8685a7\",\r\n \"cardExpiration\": \"09/32\",\r\n \"cardCvv\": \"f6e6d69a974792312dc12905fe64e43d\",\r\n \"accountNumber\": \"0690000037\",\r\n \"createdAt\": \"2022-01-25T10:20:31.625Z\",\r\n \"updatedAt\": \"2022-01-25T14:30:46.511Z\"\r\n}"}],"_postman_id":"02002215-7497-4e05-9ff8-ddf8ea28045e"}],"id":"49bb0446-6a94-49bf-84ac-bfae48566b06","description":"the authentication and authorization module
\n","_postman_id":"49bb0446-6a94-49bf-84ac-bfae48566b06"},{"name":"Wallet","item":[{"name":"Get crypto prices","id":"58348d8d-9f51-4cb4-8aba-93df31bd8e93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://hornest-api.herokuapp.com/api/v1/wallets/price","description":"get up to data real time USD prices from our very own bitfast API
\n","urlObject":{"protocol":"https","path":["api","v1","wallets","price"],"host":["hornest-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"5091689f-ba04-4e3f-b241-035b5ba66131","name":"Get crypto prices","originalRequest":{"method":"GET","header":[],"url":"https://hornest-api.herokuapp.com/api/v1/wallets/price"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"exchange rates for popular coins\": {\n \"Bitcoin\": \"36713.48000000000320142\",\n \"Ethereum\": \"2439.82999999999992724\",\n \"Dogecoin\": \"0.14065\",\n \"Solana\": \"93.36499999999999488\",\n \"Shiba\": \"0.00002125\",\n \"Tether\": \"1.00045000000000006\"\n }\n}"}],"_postman_id":"58348d8d-9f51-4cb4-8aba-93df31bd8e93"},{"name":"Get wallet","id":"c656b168-1cec-4354-944d-1f985e65350e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Allows a user view his wallet information
\n","urlObject":{"protocol":"https","path":["api","v1","wallets","user","wallet"],"host":["hornest-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"2f43d982-1db0-4814-ab73-aef1916bd557","name":"Get wallet","originalRequest":{"method":"GET","header":[],"url":"https://hornest-api.herokuapp.com/api/v1/wallets/user/wallet"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"balance\": 28000,\r\n \"createdAt\": \"2022-01-17T04:01:24.189Z\",\r\n \"updatedAt\": \"2022-01-24T05:48:38.115Z\",\r\n \"user\": {\r\n \"id\": 1,\r\n \"firstName\": \"Peter\",\r\n \"lastName\": \"Brock\",\r\n \"email\": \"emmy@gmail.com\",\r\n \"password\": \"$2a$10$26GHb4aO3P3rhzolCX.CDuGcwNSM3SJ/4PWKTHaVOSrcYxZisSr9u\",\r\n \"card\": \"52fa95090111f7344f49bb5e0186ad3031ba481be4c42e8970a0d9979f614083\",\r\n \"cardExpiration\": \"09/32\",\r\n \"cardCvv\": \"0afbcf0d6075bd1b8862e00ccd9a5cfb\",\r\n \"accountNumber\": \"0690000037\",\r\n \"createdAt\": \"2022-01-17T04:01:23.839Z\",\r\n \"updatedAt\": \"2022-01-24T05:48:17.568Z\"\r\n }\r\n}"}],"_postman_id":"c656b168-1cec-4354-944d-1f985e65350e"},{"name":"fund wallet","id":"c13c5e3a-c925-4bbe-9e44-4718fb06791d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"allows users to fund their wallet via the provided cards in their profile using Flutterwave as a payment gateway
\n","urlObject":{"protocol":"https","path":["api","v1","wallets","user","fund-wallet"],"host":["hornest-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"673ad04c-5967-44d5-b14e-1c0cf0ee04a2","name":"Charge a card (fund wallet)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"pin\":3310,\r\n \"otp\":\"12345\",\r\n \"amount\":\"2000\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hornest-api.herokuapp.com/api/v1/wallets/user/fund-wallet"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"message\": \"transaction successful\",\r\n \"wallet\": {\r\n \"id\": 1,\r\n \"balance\": 28000,\r\n \"createdAt\": \"2022-01-17T04:01:24.189Z\",\r\n \"updatedAt\": \"2022-01-24T05:48:38.115Z\",\r\n \"user\": {\r\n \"id\": 1,\r\n \"firstName\": \"Peter\",\r\n \"lastName\": \"Brock\",\r\n \"email\": \"emmy@gmail.com\",\r\n \"password\": \"$2a$10$26GHb4aO3P3rhzolCX.CDuGcwNSM3SJ/4PWKTHaVOSrcYxZisSr9u\",\r\n \"card\": \"52fa95090111f7344f49bb5e0186ad3031ba481be4c42e8970a0d9979f614083\",\r\n \"cardExpiration\": \"09/32\",\r\n \"cardCvv\": \"0afbcf0d6075bd1b8862e00ccd9a5cfb\",\r\n \"accountNumber\": \"0690000037\",\r\n \"createdAt\": \"2022-01-17T04:01:23.839Z\",\r\n \"updatedAt\": \"2022-01-24T05:48:17.568Z\"\r\n }\r\n }\r\n}"}],"_postman_id":"c13c5e3a-c925-4bbe-9e44-4718fb06791d"},{"name":"Withdraw from Wallet","id":"08c190f8-e666-4faa-8bb5-1d1d2b1f1995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"allows users to withdraw from their wallet via the provided cards in their profile using Flutterwave as a payment gateway
\n","urlObject":{"protocol":"https","path":["api","v1","wallets","wallet","withdrawals"],"host":["hornest-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"e47e804b-fc4d-405f-b464-e613bc2f7014","name":"Withdraw from wallet","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"amount\":\"4000\",\r\n \"accountNumber\":\"0690000037\",\r\n \"account_bank\":\"Access Bank\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://hornest-api.herokuapp.com/api/v1/wallets/wallet/withdrawals"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"message\": \"transaction successful\",\r\n \"wallet\": {\r\n \"id\": 1,\r\n \"balance\": 24000,\r\n \"createdAt\": \"2022-01-17T04:01:24.189Z\",\r\n \"updatedAt\": \"2022-01-24T05:54:56.214Z\",\r\n \"user\": {\r\n \"id\": 1,\r\n \"firstName\": \"Peter\",\r\n \"lastName\": \"Brock\",\r\n \"email\": \"emmy@gmail.com\",\r\n \"password\": \"$2a$10$26GHb4aO3P3rhzolCX.CDuGcwNSM3SJ/4PWKTHaVOSrcYxZisSr9u\",\r\n \"card\": \"52fa95090111f7344f49bb5e0186ad3031ba481be4c42e8970a0d9979f614083\",\r\n \"cardExpiration\": \"09/32\",\r\n \"cardCvv\": \"0afbcf0d6075bd1b8862e00ccd9a5cfb\",\r\n \"accountNumber\": \"0690000037\",\r\n \"createdAt\": \"2022-01-17T04:01:23.839Z\",\r\n \"updatedAt\": \"2022-01-24T05:48:17.568Z\"\r\n }\r\n }\r\n}"}],"_postman_id":"08c190f8-e666-4faa-8bb5-1d1d2b1f1995"}],"id":"4229b4f2-6cf7-4d3f-b6ed-2a13752838d3","description":"The wallet module that allows users to manage funds on their wallets
\n","_postman_id":"4229b4f2-6cf7-4d3f-b6ed-2a13752838d3"},{"name":"Transactions","item":[{"name":"view user transactions","id":"1120d155-e48d-4db8-923b-94081ada0064","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Gets all the transactions history
\n","urlObject":{"protocol":"https","path":["api","v1","transactions","user"],"host":["hornest-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"baea1bf6-004c-4a9c-8cf7-5f2fa8d4ef92","name":"view user transactions","originalRequest":{"method":"GET","header":[],"url":"https://hornest-api.herokuapp.com/api/v1/transactions/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"id\": 9,\r\n \"amount\": 200,\r\n \"type\": \"CREDIT\",\r\n \"status\": \"SUCCESS\",\r\n \"reference\": \"funded-9018045-1\",\r\n \"createdAt\": \"2022-02-03T18:49:15.758Z\",\r\n \"updatedAt\": \"2022-02-03T18:49:15.758Z\",\r\n \"user\": {\r\n \"id\": 1,\r\n \"firstName\": \"Peter\",\r\n \"lastName\": \"Brock\",\r\n \"email\": \"emmy@gmail.com\",\r\n \"password\": \"$2a$10$0.83PpQxpwN1Eb0YN8It1u3rIV8ep4auPpr1WfhvKSs/NCuV08s9W\",\r\n \"card\": \"aa335591b459c97a273c03f4c681d8029dfe2a1d77c534897e313ad4a2df7993\",\r\n \"cardExpiration\": \"09/32\",\r\n \"cardCvv\": \"48ca6975f4e55f1fd871bdddaf5b6fb1\",\r\n \"accountNumber\": \"0690000037\",\r\n \"createdAt\": \"2022-01-25T10:20:31.625Z\",\r\n \"updatedAt\": \"2022-02-03T18:22:40.401Z\"\r\n }\r\n },\r\n {\r\n \"id\": 10,\r\n \"amount\": 1200,\r\n \"type\": \"CREDIT\",\r\n \"status\": \"SUCCESS\",\r\n \"reference\": \"funded-2491554-1\",\r\n \"createdAt\": \"2022-02-03T18:50:50.661Z\",\r\n \"updatedAt\": \"2022-02-03T18:50:50.661Z\",\r\n \"user\": {\r\n \"id\": 1,\r\n \"firstName\": \"Peter\",\r\n \"lastName\": \"Brock\",\r\n \"email\": \"emmy@gmail.com\",\r\n \"password\": \"$2a$10$0.83PpQxpwN1Eb0YN8It1u3rIV8ep4auPpr1WfhvKSs/NCuV08s9W\",\r\n \"card\": \"aa335591b459c97a273c03f4c681d8029dfe2a1d77c534897e313ad4a2df7993\",\r\n \"cardExpiration\": \"09/32\",\r\n \"cardCvv\": \"48ca6975f4e55f1fd871bdddaf5b6fb1\",\r\n \"accountNumber\": \"0690000037\",\r\n \"createdAt\": \"2022-01-25T10:20:31.625Z\",\r\n \"updatedAt\": \"2022-02-03T18:22:40.401Z\"\r\n }\r\n },\r\n {\r\n \"id\": 12,\r\n \"amount\": 400,\r\n \"type\": \"DEBIT\",\r\n \"status\": \"SUCCESS\",\r\n \"reference\": \"funded-5543280-1\",\r\n \"createdAt\": \"2022-02-03T18:54:47.627Z\",\r\n \"updatedAt\": \"2022-02-03T18:54:47.627Z\",\r\n \"user\": {\r\n \"id\": 1,\r\n \"firstName\": \"Peter\",\r\n \"lastName\": \"Brock\",\r\n \"email\": \"emmy@gmail.com\",\r\n \"password\": \"$2a$10$0.83PpQxpwN1Eb0YN8It1u3rIV8ep4auPpr1WfhvKSs/NCuV08s9W\",\r\n \"card\": \"aa335591b459c97a273c03f4c681d8029dfe2a1d77c534897e313ad4a2df7993\",\r\n \"cardExpiration\": \"09/32\",\r\n \"cardCvv\": \"48ca6975f4e55f1fd871bdddaf5b6fb1\",\r\n \"accountNumber\": \"0690000037\",\r\n \"createdAt\": \"2022-01-25T10:20:31.625Z\",\r\n \"updatedAt\": \"2022-02-03T18:22:40.401Z\"\r\n }\r\n }\r\n]"}],"_postman_id":"1120d155-e48d-4db8-923b-94081ada0064"},{"name":"Delete a Transaction","id":"8da65ec6-5c07-486d-b3d3-77d245aaa97a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"allows user to delete a transaction from the transaction history
\n","urlObject":{"protocol":"https","path":["api","v1","transactions","delete","18"],"host":["hornest-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"af2f2230-a72d-4762-afc3-33799efe2a6c","name":"Delete a Transaction","originalRequest":{"method":"DELETE","header":[],"url":"https://hornest-api.herokuapp.com/api/v1/transactions/delete/12"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"transaction deleted successfully"}],"_postman_id":"8da65ec6-5c07-486d-b3d3-77d245aaa97a"}],"id":"f8ed9beb-a926-441c-be24-26b763a91f01","description":"The transactions module for the hornest wallet API
\n","_postman_id":"f8ed9beb-a926-441c-be24-26b763a91f01"}],"variable":[{"key":"url","value":"https://hornest-api.herokuapp.com"}]}