Base url: Not yet available
\n{\n \"message\": [relevant message],\n \"status\": [\"success\" or \"failed\"],\n \"data\": {\n [object containing relevant data]\n }\n}\n\nstatus code: 403
description: This error is returned when the user is not authorised. Could be missing or invalid access token
\n \"message\": \"Not allowed. Please supply a token\",,\n \"status\": \"failed\",\n \"data\": {\n }\n}\n\nSummary: Get wallet balance for a user
\nDescription: Use this endpoint to get the current wallet balance of the user. This should be a source of truth for the current account balance of the user
\n\n\nRequires authentication. A valid access token should be passed with the x-auth header
\n
URL parameters
\nNone
\nRequest body params
\nNone
\nstatus code: 200
description: Successfully got an account's balance
{\n \"message\": \"Balance\",\n \"status\": \"success\",\n \"data\": {\n \"balance\": 66500\n }\n}\n\nSummary: Make inter-wallet transfer
\nDescription: Use this endpoint to transfer from authenticated user's account to another user's account.
\n\n\nRequires authentication. A valid access token should be passed with the x-auth header
\n
URL Parameters
\nNone
\nRequest body
\nstatus code: 200
description: The transfer was successful
\n{\n \"message\": \"Transfer successful\",\n \"data\": {\n \"balance\": 65500\n }\n}\n\nstatus code: 400
description: A client error occurred. Refer to validation above to make sure everything is correct
\n{\n \"status\": \"error\",\n \"message\": \"amount must be greater than or equal to 50\",\n \"data\": {}\n}\n\nSummary: Authenticate the user
\nDescription: Use this endpoint to get an access token for a user. An access token is required to make requests going forward.
\nURL parameters
\nNone
\nRequest body
\nstatus code: 200
description: Successfully authenticated the user
{\n\"status\": \"success\",\n\"message\": \"User auth successful\",\n\"data\": {\n \"token\": \"[access-token]\",\n \"user\": {\n \"id\": [userId],\n \"firstName\": \"[firstName]\",\n \"lastName\": \"[lastName]\",\n \"email\": \"[email],\n \"phoneNumber\": \"[phoneNumber]\"\n }\n}\n}\n\nstatus code: 401
description: Could not authenticate the user. Usually as a result of an invalid password
{\n \"status\": \"failed\",\n \"message\": \"Invalid password\",\n \"data\": {}\n}\n\n```
\n","urlObject":{"path":["api","users","auth"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"41b8d1fe-e0f1-4d46-a9c0-71414d1a5ab3","name":"Auth user - Invalid password","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"samuel@gmail.com\",\n \"password\": \"wonderful?\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/users/auth"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"58"},{"key":"ETag","value":"W/\"3a-UVQ/qVFxTf+LrnFMBdlr2R29YbE\""},{"key":"Date","value":"Wed, 08 Jun 2022 14:38:01 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"failed\",\n \"message\": \"Invalid password\",\n \"data\": {}\n}"}],"_postman_id":"e581e5c5-f19f-4a90-8c02-089e0120ad38"},{"name":"Create user","id":"b05633a5-a743-439e-a7f3-253a8f92e25e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{url}}/api/users","description":"Summary: Create a new user
\nDescription: Use this endpoint to create a new user. This immediately creates a account/wallet for the user.
\nURL parameters
\nNone
\nRequest body
\nstatus code: 201
description: Successfully created a user
\n{\n \"status\": \"success\",\n \"message\": \"User created\",\n \"data\": {\n \"user\": {\n \"firstName\": \"[firstName]\",\n \"lastName\": \"[firstName]\",\n \"email\": \"[email]\",\n \"phoneNumber\": \"08025031902\",\n }\n}\n\nstatus code: 409
description: User with the email already exists
\n{\n \"status\": \"failed\",\n \"message\": \"User with this email already exists\",\n \"data\": {}\n}\n\nSummary: fund account/wallet
\nDescription: Use this endpoint to fund an account. This endpoint uses a number of payment methods for funding.
\n\n\nRequires authentication. A valid access token should be passed with the x-auth header
\n
URL query parameters
\nRequest body
\nstatus code: 200
description: Transfer method of funding account was successful
\n{\n \"message\": \"Transfer initiated. Make transfer to details\",\n \"status\": \"success\",\n \"data\": {\n \"bank_account\": \"1234567890\",\n \"bank_name\": \"TEST BANK\",\n \"amount\": \"50000.00\"\n }\n}\n\nstatus code: 400
describe: A client error. Please ensure all parameters and their validation is satisfied
\n{\n \"status\": \"error\",\n \"message\": \"\",\n \"data\": {}\n}\n\nSummary: Create a beneficiary
\nDescription: Use this endpoint to create a new beneficiary. A beneficiary is a bank account that a user will like to make withdrawals to.
\nURL parameters
\nNone
\nRequest body
\nstatus code: 201
description: Successfully created beneficiary
\n{\n \"status\": \"success\",\n \"message\": \"Beneficiaries\",\n \"data\": {\n \"beneficiaries\": [\n {\n \"id\": \"[beneficiary-id]\",\n \"userId\": 2,\n \"bank_account\": \"[bank-account-number]\",\n \"account_name\": \"[bank-account-name]\",\n \"bank_code\": \"[bank-code]\"\n }\n ]\n }\n}\n\n\nstatus code: 409
description: Beneficiary with account number already exists
\n{\n \"status\": \"failed\",\n \"message\": \"Beneficiary already exists\",\n \"data\": {}\n}\n\nSummary: Get a user's beneficiaries
\nDescription: This is mostly required when a withdrawal is about to be made by the user. This returns the list of all beneficiaries created by user
\n\n\nRequires authentication. A valid access token should be passed with the x-auth header
\n
URL parameters
\nNone
\nRequest body params
\nNone
\nstatus code: 200
description: Successfully got all beneficiaries
{\n \"status\": \"success\",\n \"message\": \"Beneficiaries\",\n \"data\": {\n \"beneficiaries\": [\n {\n \"id\": \"[beneficiary-id]\",\n \"userId\": 2,\n \"bank_account\": \"[bank-account-number]\",\n \"account_name\": \"[bank-account-name]\",\n \"bank_code\": \"[bank-code]\"\n }\n ]\n }\n}\n\n