{"info":{"_postman_id":"7a125d6a-e27c-4964-b91e-5b25110d9a31","name":"FintechApi","description":"

A basic fintech API

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11724511","collectionId":"7a125d6a-e27c-4964-b91e-5b25110d9a31","publishedId":"UzR1JMuy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-07-20T23:20:40.000Z"},"item":[{"name":"users","item":[{"name":"create a new user account","id":"487552bc-8a50-4494-9f4a-6a73c90f9695","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\":\"John doe\", \r\n \"email\":\"johndoe@email.com\", \r\n \"password\":\"12345\"\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/api/v1/users","description":"

create account in FinTech app using valid credentials.

\n
\n

name * : string;

\n
\n
\n

email * :string

\n
\n
\n

password * :string

\n
\n

Error response

\n
\n

status : error

\n
\n
\n

message: string,

\n
\n
\n

code: number

\n
\n

Success response

\n
\n

status: success

\n
\n
\n

message: string

\n
\n
\n

data: object

\n
\n","urlObject":{"port":"8080","path":["api","v1","users"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"189be122-bcf2-4b57-a7f9-064971467946","name":"create a new user account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\":\"John doe\", \r\n \"email\":\"johndoe@email.com\", \r\n \"password\":\"12345\"\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/api/v1/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"124"},{"key":"ETag","value":"W/\"7c-utj/Nds2WU/JwnZLj+NiJ90vRyc\""},{"key":"Date","value":"Wed, 20 Jul 2022 23:13:57 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"User signed up successfully\",\n \"data\": {\n \"user\": {\n \"email\": \"johndoe@email.com\",\n \"name\": \"John doe\"\n }\n }\n}"}],"_postman_id":"487552bc-8a50-4494-9f4a-6a73c90f9695"},{"name":"see user profile","id":"c2c78058-bd93-4864-84b7-5ce6ccdbbffc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"localhost:8080/api/v1/users/profile","description":"

see your profile details

\n

Response 200

\n
\n

status: \"success\"

\n
\n
\n

data: object

\n
\n

Response 403

\n

status: string

\n

message: string

\n

code: number

\n","urlObject":{"port":"8080","path":["api","v1","users","profile"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"2323645e-cb97-4969-8c7d-7de6f17076e8","name":"see user profile","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"localhost:8080/api/v1/users/profile"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"165"},{"key":"ETag","value":"W/\"a5-W4mcsnHNehs+dL/DZnUCQZqQMrU\""},{"key":"Date","value":"Wed, 20 Jul 2022 23:08:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"user\": {\n \"id\": 3,\n \"name\": \"faith doe\",\n \"email\": \"john@email.com\",\n \"createdAt\": \"2022-07-20T22:20:00.960Z\",\n \"totalFunds\": 0,\n \"beneficiaries\": []\n }\n }\n}"}],"_postman_id":"c2c78058-bd93-4864-84b7-5ce6ccdbbffc"},{"name":"add a beneficiary to your account profile","id":"6ed68848-42c4-4b65-b9a7-4e86ee31a3f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\":\"aee young\",\r\n \"email\":\"johndoe@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/api/v1/users/beneficiary","description":"

Add a new beneficiary to your list of beneficiaries

\n

name: string;

\n

email: string;

\n

Note: beneficiary must be a registered user

\n

Response 200

\n
\n

status: string;

\n
\n
\n

message: string;

\n
\n
\n

data: object;

\n
\n

Error Response

\n
\n

status: string;

\n
\n
\n

code: number;

\n
\n
\n

error: boolean;

\n
\n
\n

message: string;

\n
\n","urlObject":{"port":"8080","path":["api","v1","users","beneficiary"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"655a218c-5971-4228-b514-ae796681e150","name":"add a beneficiary to your account profile","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\":\"aee young\",\r\n \"email\":\"johndoe@email.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/api/v1/users/beneficiary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"221"},{"key":"ETag","value":"W/\"dd-IPLzBNYKUzLJb14b5lmhShZyLko\""},{"key":"Date","value":"Wed, 20 Jul 2022 23:15:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"beneficiary successfully added\",\n \"data\": {\n \"user\": {\n \"beneficiaries\": [\n {\n \"beneficiaryId\": 1,\n \"name\": \"aee young\",\n \"email\": \"johndoe@email.com\",\n \"userId\": 3\n }\n ],\n \"email\": \"john@email.com\",\n \"name\": \"faith doe\"\n }\n }\n}"}],"_postman_id":"6ed68848-42c4-4b65-b9a7-4e86ee31a3f9"},{"name":"send money","id":"b500ccb7-f33d-43ea-8fd0-56f2369235e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"amount\": 4500\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/api/v1/users/transfer","description":"

Transfer money

\n

amount *: number;

\n

email: string

\n

Note: if email is passed, money will be transferred to user with email else money will be transferred to user

\n

Success Response

\n

status: string;

\n

message: string

\n

data: object

\n","urlObject":{"port":"8080","path":["api","v1","users","transfer"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"5f50f67d-68ba-4723-9b16-3da026658e25","name":"send money","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"amount\": 4500\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/api/v1/users/transfer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"260"},{"key":"ETag","value":"W/\"104-7O3X0cW/0+GpzjpAxLERAhTmJrw\""},{"key":"Date","value":"Wed, 20 Jul 2022 23:13:00 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Payment initialised successfully\",\n \"data\": {\n \"status\": true,\n \"message\": \"Authorization URL created\",\n \"data\": {\n \"authorization_url\": \"https://checkout.paystack.com/fw1vaeqmm1p39b0\",\n \"access_code\": \"fw1vaeqmm1p39b0\",\n \"reference\": \"zxjb2qf31i\"\n }\n }\n}"}],"_postman_id":"b500ccb7-f33d-43ea-8fd0-56f2369235e3"}],"id":"a3c08232-63ad-4c50-8c38-e17203154019","_postman_id":"a3c08232-63ad-4c50-8c38-e17203154019","description":""},{"name":"auth","item":[{"name":"login a user","id":"3d8416bb-27ac-4b07-a310-bbe5a2446a1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"john@email.com\", \r\n \"password\":\"12345\"\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/api/v1/users","description":"

log in user using valid credentials

\n

Error response

\n
\n

status: string;

\n
\n
\n

message: string;

\n
\n
\n

code: number;

\n
\n

Success response

\n
\n

status: string;

\n
\n
\n

message: string;

\n
\n
\n

token: string;

\n
\n","urlObject":{"port":"8080","path":["api","v1","users"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"5d530dac-bc24-4832-a3dc-ba5ecf5798a2","name":"login a user","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"john@email.com\", \r\n \"password\":\"12345\"\r\n}","options":{"raw":{"language":"json"}}},"url":"localhost:8080/api/v1/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';block-all-mixed-content;font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Cross-Origin-Embedder-Policy","value":"require-corp"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"Expect-CT","value":"max-age=0"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"X-XSS-Protection","value":"0"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"308"},{"key":"ETag","value":"W/\"134-NSk1bNK0lCroAaOW+vHgzRVmxaM\""},{"key":"Date","value":"Wed, 20 Jul 2022 23:07:29 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"user logged in successfully\",\n \"data\": {\n \"token\": \"\"\n }\n}"}],"_postman_id":"3d8416bb-27ac-4b07-a310-bbe5a2446a1b"}],"id":"784f46f4-fa67-4b37-afc1-e3c4f787a49b","description":"

Get user token

\n","_postman_id":"784f46f4-fa67-4b37-afc1-e3c4f787a49b"}]}