MyTalu translates to something that would probably mean my funds. It aims at connecting a person in UK with their relatives in 3rd countries. It allows a UK citizen to transfer chosen amount of money to his family member, who can later spend it on many ways.
...
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authors","slug":"authors"},{"content":"Tech stack","slug":"tech-stack"}],"owner":"98950","collectionId":"4c1c89db-e351-4ef1-a497-26fa057b0945","publishedId":"TVYKYvZm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-02-04T10:56:36.000Z"},"item":[{"name":"Customers","item":[{"name":"Initialization","item":[{"name":"Create customer (wallet owner)","id":"c45f80a6-e554-476d-bad6-d35fb6b2c71d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"daria+150@desmart.com\",\n \"password\": \"123qwe!@#\",\n \"phone_number\": \"123\",\n \"securityQuestion\": \"what is your foobar?\",\n \"securityAnswer\": \"Bar Baz\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/customers","description":"Attempt to create new account for a customer as a wallet owner.
\nNew customer should receive email with verification pin code (and verification link attached to it).
\n200 OK422 Unprocessable EntityAttempt to verify customer.
\n200 OK404 Not Found422 Unprocessable EntityAttempt to resend verification email for a customer.
\nCustomer should receive an email with a verification pin code and a link to an app.
\n200 OK404 Not Foundid of a registered customer
\n","type":"text/plain"},"type":"string","value":"cd36fc7b-2738-449c-8e21-bbf242e50ff9","key":"id"}]}},"response":[{"id":"1c5d3a30-e57f-4bf8-ae8a-b612bad55f9b","name":"404 - Not Found","originalRequest":{"method":"POST","header":[{"key":"","type":"text","value":"","disabled":true}],"url":{"raw":"{{API_URL}}/customers/:id/resend-verification-email","host":["{{API_URL}}"],"path":["customers",":id","resend-verification-email"],"variable":[{"description":"id of a registered customer","key":"id","type":"string","value":"cd36fc7b-2738-449c-8e21-bbf242e50ff1"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"113"},{"key":"ETag","value":"W/\"71-zh/1AMezpkOuI/kQoIAL+vnjxxI\""},{"key":"Date","value":"Thu, 17 Dec 2020 15:40:46 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"entity.not-found\",\n \"message\": \"Customer not found\",\n \"statusCode\": 404\n }\n}"},{"id":"6e4e949a-5800-4f5d-8b99-c9adcaff716d","name":"200 - OK","originalRequest":{"method":"POST","header":[{"key":"","type":"text","value":"","disabled":true}],"url":{"raw":"{{API_URL}}/customers/:id/resend-verification-email","host":["{{API_URL}}"],"path":["customers",":id","resend-verification-email"],"variable":[{"description":"id of a registered customer","key":"id","type":"string","value":"cd36fc7b-2738-449c-8e21-bbf242e50ff9"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Date","value":"Thu, 17 Dec 2020 15:37:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"058851ee-907f-4dbe-9a1f-145597558614"}],"id":"1fb3afe0-6262-45a2-912a-530ed4cb1d72","description":"Initialization of a customer with a role of: wallet_owner.
Attempt to initiate password reset for existing customer.
\n200 OK403 Forbidden404 Not FoundAttempt to validate reset password pin (which is valid for 3h).
\n200 OK403 ForbiddenAttempt to finalize reset of a password.
\n200 OK403 Forbidden422 Unprocessable EntitySection is responsible for reseting a password if a customer forgot it and/or he has troubles logging in.
\nTo reset a password we start with Reset passsword init that sends an email to a customer, from where he has to get a pin code (confirming that he is who he says he is). An email contains reset password pin that can be validated with Reset password validate, the pin code is valid for 3h. To finalize the password change we use Reset password finish EP.
Attempt to change password for a currently logged in customer.
\n200 OK401 Unauthorized403 ForbiddenAttempt to update user profile picture of currently logged in customer.
\n200 OK401 Unauthorized403 ForbiddenAttempt to update user profile details of currently logged in customer.
\nImportant: API accept different sets of data based on the user's role.
\nwallet_ownerfamily_member200 OK401 Unauthorized403 ForbiddenFetches profile of currently logged in customer.
\nImportant: Returns different set of meta_data fields depending on the role of a customer.
wallet_owner
\n{\n \"street\": \"\",\n \"house_number\": \"\",\n \"flat_number\": \"\",\n \"city\": \"\",\n \"country_code\": \"\",\n \"postal_code\": \"\"\n}\nfamily_member
\n{\n \"address\": \"\",\n \"state\": \"\",\n \"voivodeship\": \"\",\n \"country_code\": \"\",\n \"owner\": {\n \"first_name\": \"\",\n \"last_name\": \"\"\n }\n}\n200 OK401 Unauthorized404 Not FoundFetches whole list of customers notifications with enabled pagination and advanced filtration system.
\nAdvanced filtering is accepting filter params that are build as follows: filter[name_of_key]\nAllowed keys for filtering with the types they are representing:
'seen_at' - date\n 'created_at' - date\n 'notification_type' - Enum('need_support', 'running_low')\nAs a value of filter param we can pass value with an operator, they look as follows:
\nno operator - simple value that has to be matched (e.g. `true`, `wallet_owner`)\n| - range operator, followerd by 2 numbers separated with a comma, deteremines from what range do we want to match the numbers (e.g. `|0,1` - means <0,1>)\n__ - invokes a custom filter, followed by the name of custom filter (e.g. `__all_active`)\n<> - comparision sign, folowed by a number value (e.g. `>30`, `<5`)\nThis endpoint has no custom filters
\n200 OK401 Unauthorizedwhich page should be fetched (default to 1)
\n","type":"text/plain"},"key":"limit[page]","value":"1"},{"disabled":true,"description":{"content":"how many records should be displayed per page (default to 10)
\n","type":"text/plain"},"key":"limit[take]","value":"10"},{"description":{"content":"(required*) by which property list should be orderd
\n","type":"text/plain"},"key":"order[by]","value":"created_at"},{"description":{"content":"(required*) takes either of following values: [ ASC ] , [ DESC ]
\n","type":"text/plain"},"key":"order[dir]","value":"desc"},{"disabled":true,"description":{"content":"filters the results by property notification_type and searches for the value of need_support
Section is responsible for managign customer's profile.\nKeep in mind that depending on a customer's role the fields may differ (described in following EP).
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b1ab6582-5351-45a5-84d7-accb5672be4c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f55b32f9-5911-4203-9547-7726bf0e93f5","type":"text/javascript","exec":[""]}}],"_postman_id":"7b5a5985-88f9-405a-97a5-633f8a4176b3"},{"name":"PIN managment","item":[{"name":"Set app PIN","id":"86b0d35f-0cf1-481f-91f5-4f31c57eecf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"appPin\": \"5337\",\n \"password\": \"123qwe!@#\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/customers/pin","description":"Attempt to set a pin code for a customer (can be set only once).\nIf you want to change the pin code then go to App PIN change EP.
200 OK401 Unauthorized403 Forbidden422 Unprocessable EntityVerify the app pin code for a customer. Returns either true or false, dependig if a PIN code is valid.
200 OK404 Not Found422 Unprocessable EntityAttempt to change current customers app pin code.
\n200 OK401 Unauthorized403 Forbidden422 Unprocessable EntitySection responsible for PIN managment. After creating an account a customer has to set a PIN code to their account, that action can happen only once. LAter on different transactions have to be verified with submitting PIN code in the app. At any point user can change their PIN using the App PIN change endpoint.
Attempt to freeze wallet of currently logged in customer.
\n200 OK401 Unauthorized403 ForbiddenAttempt to unfreeze wallet of currently logged in customer.
\n200 OK401 Unauthorized403 ForbiddenAttempt to fetch a wallet of currently logged in customer.
\nThe integration from which the wallet data is fetched depends on a customer role:
\nwallet_owner - Railsbankfamily_member - Wallets.Africa200 OK401 Unauthorized403 Forbidden404 Not FoundSection responsible for basic wallet managment. A customer has only access to their own wallet and can have only one wallet. The currency of a wallet is dependant on the role.\nwallet_owner - GBP\nfamily_member - NGN\nIn a case of an accident a customer can freeze/unfreeze their wallet.
Attempt to log in a customer to application.
\nEndpoint returns an access token with all basic information about the customer.
\n200 OK403 Forbidden404 Not Found422 Unprocessable EntityA subject whose wallet is a parent issuer for sub-wallets. Available functionality:\nverification through KYC, CRUD their own and sub-wallets, transfer money to sub-wallets,\nview transaction history of the own and family members’ wallets, CRUD notifications.
\nWallet owner has a UK address with all common fields (street, house number, flat number, city, country code and postal code).
\nSide note: can sign up to the application freely.
\nA subject who’s invited to the application by Customer.\nAvailable functionality: verification with KYC (by BVN), CRUD and view transaction of their own\nwallet, receive remittance, CRUD notifications.
\nFamily memeber has a Nigerian address will limited fields, because of the way how housing works there (address, state, voivodeship, country code).
\nSide note: has to be invited by wallet owner to the application.
\n","event":[{"listen":"prerequest","script":{"id":"629a14fb-6708-4574-82c6-d5523d4d5bf6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ce00fa1f-db1b-4616-8f57-1915793a0653","type":"text/javascript","exec":[""]}}],"_postman_id":"43a70fd4-ef0b-4e6b-b468-0dffbe509092"},{"name":"Customer Invites","item":[{"name":"Invite customer (family member) - init","id":"50d9ebab-f901-4916-a381-66b408e38a8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"invitees\": [\n \"daria+member1@desmart.com\",\n \"daria+member2@desmart.com\",\n \"daria+member3@desmart.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/customer-invites/init","description":"Creates invitation for new potential customer with a role of family member.
\nNew potential customer should receive email with invitation link.
\nThis is the initialization EP and can be run only once, for inviting other customers go to next EP one which validates PIN code
\nOnly token with wallet_owner role is accepted
200 OK401 Unauthorized403 Forbidden422 Unprocessable EntityCreates invitation for new potential customer with a role of family member.
\nNew potential customer should receive email with invitation link.
\nOnly token with wallet_owner role is accepted
200 OK401 Unauthorized403 Forbidden422 Unprocessable EntityAttempt to create new account for a family member. After creation, account still has to be verified with a PIN code from an email.
\n200 OK403 Forbidden404 Not Found422 Unprocessabel Entityid of a pending invitation
\n","type":"text/plain"},"type":"string","value":"7227b287-a777-486d-a53a-31f3dceb64b4","key":"id"}]}},"response":[{"id":"5f31f324-6cbe-4942-9f80-8362b2f228f2","name":"200 - OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"password\": \"123qwe!@#\",\n \"securityQuestion\": \"what is your foobar?\",\n \"securityAnswer\": \"Bar Baz\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{API_URL}}/customer-invites/:id/accept","host":["{{API_URL}}"],"path":["customer-invites",":id","accept"],"variable":[{"description":"id of a sent invitation","key":"id","type":"string","value":"2a7960ff-65b7-45de-92db-fb7218adf9ce"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"564"},{"key":"ETag","value":"W/\"234-WZtpEgwihXRLowVusl7yt44av0A\""},{"key":"Date","value":"Fri, 18 Dec 2020 15:27:44 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"email\": \"daria+member2@desmart.com\",\n \"password\": null,\n \"security_question\": null,\n \"security_answer\": null,\n \"is_email_verified\": false,\n \"role\": \"family_member\",\n \"is_active\": false,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"+1232112312\",\n \"nickname\": \"JoJo\",\n \"id\": \"fb8f1f03-1180-4b65-ac63-2be9715c0a56\",\n \"verification_pin\": null,\n \"kyc_status\": \"not_verified\",\n \"password_reset_pin\": null,\n \"password_reset_pin_created_at\": null,\n \"is_kyc_verified\": false,\n \"failed_kyc_attempts\": 0,\n \"date_of_birth\": null,\n \"app_pin\": null,\n \"is_wallet_active\": false,\n \"profile_photo_url\": null,\n \"deleted_at\": null\n}"},{"id":"80876281-7231-43d4-ba3d-e7365eb0d544","name":"403 - Forbidden","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"password\": \"12345678\",\n \"securityQuestion\": \"what is your foobar?\",\n \"securityAnswer\": \"Bar Baz\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{API_URL}}/customer-invites/:id/accept","host":["{{API_URL}}"],"path":["customer-invites",":id","accept"],"variable":[{"description":"id of a sent invitation","id":"7e8c89c1-edec-426e-98d5-e06d5f422219","key":"id","type":"string","value":"f651d6b2-98f8-4b76-aecd-a8bdd21e7a7d"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"134"},{"key":"ETag","value":"W/\"86-VUOdhnS5oLa1nJjBIgA2GLALodk\""},{"key":"Date","value":"Fri, 18 Dec 2020 15:25:42 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"user.password-reset.new-password-invalid\",\n \"message\": \"Unhandled Error\",\n \"statusCode\": 403\n }\n}"},{"id":"817e04a8-e52a-4b1f-88c3-b303bb77aff5","name":"404 - Not Found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"password\": \"1234qwert#\",\n \"securityQuestion\": \"what is your foobar?\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{API_URL}}/customer-invites/:id/accept","host":["{{API_URL}}"],"path":["customer-invites",":id","accept"],"variable":[{"description":"id of a sent invitation","id":"7e8c89c1-edec-426e-98d5-e06d5f422219","key":"id","type":"string","value":"f651d6b2-98f8-4b76-aecd-a8bdd21e7a7d"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"119"},{"key":"ETag","value":"W/\"77-clwQMr4vv6W/bBZOI2wFYX0zWnQ\""},{"key":"Date","value":"Fri, 18 Dec 2020 15:24:30 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"entity.not-found\",\n \"message\": \"CustomerInvite not found\",\n \"statusCode\": 404\n }\n}"},{"id":"eec66217-0f68-4a14-9d6d-e7a533f1a0f9","name":"422 - Unprocessable Entity","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"password\": \"1234qwert#\",\n \"securityQuestion\": \"what is your foobar?\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{API_URL}}/customer-invites/:id/accept","host":["{{API_URL}}"],"path":["customer-invites",":id","accept"],"variable":[{"description":"id of a sent invitation","id":"7e8c89c1-edec-426e-98d5-e06d5f422219","key":"id","type":"string","value":"f651d6b2-98f8-4b76-aecd-a8bdd21e7a7d"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"125"},{"key":"ETag","value":"W/\"7d-O5EiG+D+mxR1QAy8gVoQMwLq7Vo\""},{"key":"Date","value":"Fri, 18 Dec 2020 15:25:18 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"entity.invalid\",\n \"message\": [\n \"\\\"securityAnswer\\\" is required\"\n ],\n \"statusCode\": 422\n }\n}"}],"_postman_id":"94e191d5-fffc-469b-b3ed-09b00c26fa0e"},{"name":"Update profile data","id":"4360983e-1540-40c9-b26d-a5cc56182351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+1232112312\",\n \"nickname\": \"JoJo\",\n \"address\": \"WilliamStreet 8, Lala\",\n \"state\": \"State Name\",\n \"voivodeship\": \"Test\",\n \"countryCode\": \"NG\",\n \"dateOfBirth\": \"2000-01-01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/customer-invites/:id","description":"Attempt to update user profile details of a chosen invitation (from pending ones of currently logged in customer).
\nOnly token with wallet_owner role is accepted
200 OK401 Unauthorized404 Not Found422 Unprocessable Entityid of an existing invite (required *)
\n","type":"text/plain"},"type":"string","value":"2a7960ff-65b7-45de-92db-fb7218adf9ce","key":"id"}]}},"response":[{"id":"20ed068b-a6bc-4960-b86e-fdc080f4a5c3","name":"401 - Unauthorized","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+1232112312\",\n \"street\": \"James Street 12A\",\n \"houseNumber\": \"42\",\n \"flatNumber\": \"1/3C\",\n \"city\": \"London\",\n \"countryCode\": \"GB\",\n \"postalCode\": \"123-AC\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{API_URL}}/customer-invites/:id","host":["{{API_URL}}"],"path":["customer-invites",":id"],"variable":[{"id":"6b5a295e-18b8-4f49-83fd-3cc076aae73a","key":"id","type":"string","value":"02377cfd-a74d-4129-80f6-89ea1295eebd"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"122"},{"key":"ETag","value":"W/\"7a-MLXj+E1nU+pcbJ0dDJkagyy0Th8\""},{"key":"Date","value":"Fri, 18 Dec 2020 14:48:16 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"user.unauthenticated\",\n \"message\": \"Authentication required\",\n \"statusCode\": 401\n }\n}"},{"id":"5b4cb3f8-91ff-4aaf-aeae-0df2c6e0d859","name":"404 - Not Found","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+1232112312\",\n \"nickname\": \"JoJo\",\n \"address\": \"WilliamStreet 8, Lala\",\n \"state\": \"State Name\",\n \"voivodeship\": \"Test\",\n \"countryCode\": \"NG\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{API_URL}}/customer-invites/:id","host":["{{API_URL}}"],"path":["customer-invites",":id"],"variable":[{"id":"6b5a295e-18b8-4f49-83fd-3cc076aae73a","key":"id","type":"string","value":"02377cfd-a74d-4129-80f6-89ea1295eebd"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"119"},{"key":"ETag","value":"W/\"77-clwQMr4vv6W/bBZOI2wFYX0zWnQ\""},{"key":"Date","value":"Fri, 18 Dec 2020 15:01:30 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"entity.not-found\",\n \"message\": \"CustomerInvite not found\",\n \"statusCode\": 404\n }\n}"},{"id":"95be61b4-ec73-4ec2-b09c-7192c1e8f646","name":"200 - OK","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+1232112312\",\n \"nickname\": \"JoJo\",\n \"address\": \"WilliamStreet 8, Lala\",\n \"state\": \"State Name\",\n \"voivodeship\": \"Test\",\n \"countryCode\": \"NG\",\n \"dateOfBirth\": \"2000-01-01\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{API_URL}}/customer-invites/:id","host":["{{API_URL}}"],"path":["customer-invites",":id"],"variable":[{"key":"id","type":"string","value":"2a7960ff-65b7-45de-92db-fb7218adf9ce","description":"id of an existing invite (required *)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"450"},{"key":"ETag","value":"W/\"1c2-A89uTb+dzu2TSEs/CbmFwsC+IRk\""},{"key":"Date","value":"Fri, 18 Dec 2020 15:02:41 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"2a7960ff-65b7-45de-92db-fb7218adf9ce\",\n \"wallet_owner_id\": \"c6eb8f55-ed97-4c1a-addf-8403d78a4853\",\n \"email\": \"daria+member2@desmart.com\",\n \"invite_url\": \"https://app.mytalu.co.uk/member-invite/2a7960ff-65b7-45de-92db-fb7218adf9ce\",\n \"created_at\": \"2020-12-18T13:35:03.763Z\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"+1232112312\",\n \"country_code\": \"NG\",\n \"address\": \"WilliamStreet 8, Lala\",\n \"state\": \"State Name\",\n \"voivodeship\": \"Test\",\n \"nickname\": \"JoJo\",\n \"date_of_birth\": \"2000-01-01\"\n}"},{"id":"e58c9008-a010-4bf8-9043-c0b14d3c9960","name":"422 - Unprocessable Entity","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"phoneNumber\": \"+1232112312\",\n \"street\": \"James Street 12A\",\n \"houseNumber\": \"42\",\n \"flatNumber\": \"1/3C\",\n \"city\": \"London\",\n \"countryCode\": \"GB\",\n \"postalCode\": \"123-AC\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{API_URL}}/customer-invites/:id","host":["{{API_URL}}"],"path":["customer-invites",":id"],"variable":[{"id":"6b5a295e-18b8-4f49-83fd-3cc076aae73a","key":"id","type":"string","value":"02377cfd-a74d-4129-80f6-89ea1295eebd"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"323"},{"key":"ETag","value":"W/\"143-IrbBi2YXDO0bmd3dc0fHR032To8\""},{"key":"Date","value":"Fri, 18 Dec 2020 14:48:35 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"entity.invalid\",\n \"message\": [\n \"\\\"address\\\" is required\",\n \"\\\"state\\\" is required\",\n \"\\\"voivodeship\\\" is required\",\n \"\\\"street\\\" is not allowed\",\n \"\\\"houseNumber\\\" is not allowed\",\n \"\\\"flatNumber\\\" is not allowed\",\n \"\\\"city\\\" is not allowed\",\n \"\\\"postalCode\\\" is not allowed\"\n ],\n \"statusCode\": 422\n }\n}"}],"_postman_id":"4360983e-1540-40c9-b26d-a5cc56182351"},{"name":"Fetch details of an invite","id":"490e53bd-f1c0-4097-a3dc-6bd29543788d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}/customer-invites/:id","description":"Fetch details of a specific invite.
\nOnly token with wallet_owner role is accepted
200 OK401 Unauthorized404 Not Foundvalid id of an invite
\n","type":"text/plain"},"type":"string","value":"d185f2ef-cef1-48fe-b63b-8a9f4f80c661","key":"id"}]}},"response":[{"id":"03f89fd0-8a15-45c1-a976-fb66f7a16239","name":"404 - Not Found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/customer-invites/:id","host":["{{API_URL}}"],"path":["customer-invites",":id"],"variable":[{"id":"c0afa71a-8786-4b61-bc9a-9913e00c6e25","key":"id","value":"bd72e8d5-d3be-451c-8de4-975b41c6b387","type":"string","description":"valid id of an invite"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"119"},{"key":"ETag","value":"W/\"77-clwQMr4vv6W/bBZOI2wFYX0zWnQ\""},{"key":"Date","value":"Fri, 18 Dec 2020 14:06:31 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"entity.not-found\",\n \"message\": \"CustomerInvite not found\",\n \"statusCode\": 404\n }\n}"},{"id":"ceba3606-6cad-4a48-b5fe-ffd38d1be309","name":"401 - Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/customer-invites/:id","host":["{{API_URL}}"],"path":["customer-invites",":id"],"variable":[{"key":"id","value":"d185f2ef-cef1-48fe-b63b-8a9f4f80c661","type":"string","description":"valid id of an invite"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"122"},{"key":"ETag","value":"W/\"7a-MLXj+E1nU+pcbJ0dDJkagyy0Th8\""},{"key":"Date","value":"Fri, 18 Dec 2020 14:14:44 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"user.unauthenticated\",\n \"message\": \"Authentication required\",\n \"statusCode\": 401\n }\n}"},{"id":"f7afed42-6ac8-445c-ad6e-d321e824fd2b","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/customer-invites/:id","host":["{{API_URL}}"],"path":["customer-invites",":id"],"variable":[{"key":"id","value":"d185f2ef-cef1-48fe-b63b-8a9f4f80c661","type":"string","description":"valid id of an invite"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"391"},{"key":"ETag","value":"W/\"187-Kj1pNt28+RAYwxQpCa1cUVrr5MQ\""},{"key":"Date","value":"Fri, 18 Dec 2020 14:07:03 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"d185f2ef-cef1-48fe-b63b-8a9f4f80c661\",\n \"wallet_owner_id\": \"c6eb8f55-ed97-4c1a-addf-8403d78a4853\",\n \"email\": \"daria+member1@desmart.com\",\n \"invite_url\": \"https://app.mytalu.co.uk/member-invite/d185f2ef-cef1-48fe-b63b-8a9f4f80c661\",\n \"created_at\": \"2020-12-18T13:35:03.763Z\",\n \"first_name\": null,\n \"last_name\": null,\n \"phone_number\": null,\n \"country_code\": null,\n \"address\": null,\n \"state\": null,\n \"voivodeship\": null\n}"}],"_postman_id":"490e53bd-f1c0-4097-a3dc-6bd29543788d"},{"name":"Fetch details of all invites","id":"bc31db43-b87c-4bd9-b25d-5f9edad4aa61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}/customer-invites?limit[take]=11&limit[page]=1&order[by]=email&order[dir]=ASC","description":"Fetch all invates sent by current user.
\nOnly token with wallet_owner role is accepted
200 OK401 Unauthorizedhow many records should be displayed per page (default to 10)
\n","type":"text/plain"},"key":"limit[take]","value":"11"},{"description":{"content":"which page should be fetched (default to 1)
\n","type":"text/plain"},"key":"limit[page]","value":"1"},{"description":{"content":"by which property list should be orderd
\n","type":"text/plain"},"key":"order[by]","value":"email"},{"description":{"content":"takes either of following values: [ ASC ] , [ DESC ]
\n","type":"text/plain"},"key":"order[dir]","value":"ASC"}],"variable":[]}},"response":[{"id":"47891baf-ea6b-4abd-97c6-fad8399fb47d","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/customer-invites","host":["{{API_URL}}"],"path":["customer-invites"],"query":[{"key":"limit[take]","value":"11","description":"how many records should be displayed per page (default to 10)","disabled":true},{"key":"limit[page]","value":"1","description":"which page should be fetched (default to 1)","disabled":true},{"key":"order[by]","value":"email","description":"by which property list should be orderd","disabled":true},{"key":"order[dir]","value":"ASC","description":"takes either of following values: [ ASC ] , [ DESC ]","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1248"},{"key":"ETag","value":"W/\"4e0-n/RhBvNtx9jAC1C/TFsZbLFnHNI\""},{"key":"Date","value":"Fri, 18 Dec 2020 14:24:35 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"d185f2ef-cef1-48fe-b63b-8a9f4f80c661\",\n \"wallet_owner_id\": \"c6eb8f55-ed97-4c1a-addf-8403d78a4853\",\n \"email\": \"daria+member1@desmart.com\",\n \"invite_url\": \"https://app.mytalu.co.uk/member-invite/d185f2ef-cef1-48fe-b63b-8a9f4f80c661\",\n \"created_at\": \"2020-12-18T13:35:03.763Z\",\n \"first_name\": null,\n \"last_name\": null,\n \"phone_number\": null,\n \"country_code\": null,\n \"address\": null,\n \"state\": null,\n \"voivodeship\": null\n },\n {\n \"id\": \"2a7960ff-65b7-45de-92db-fb7218adf9ce\",\n \"wallet_owner_id\": \"c6eb8f55-ed97-4c1a-addf-8403d78a4853\",\n \"email\": \"daria+member2@desmart.com\",\n \"invite_url\": \"https://app.mytalu.co.uk/member-invite/2a7960ff-65b7-45de-92db-fb7218adf9ce\",\n \"created_at\": \"2020-12-18T13:35:03.763Z\",\n \"first_name\": null,\n \"last_name\": null,\n \"phone_number\": null,\n \"country_code\": null,\n \"address\": null,\n \"state\": null,\n \"voivodeship\": null\n },\n {\n \"id\": \"097ded44-f326-479a-9948-7865b2fa624d\",\n \"wallet_owner_id\": \"c6eb8f55-ed97-4c1a-addf-8403d78a4853\",\n \"email\": \"daria+member3@desmart.com\",\n \"invite_url\": \"https://app.mytalu.co.uk/member-invite/097ded44-f326-479a-9948-7865b2fa624d\",\n \"created_at\": \"2020-12-18T13:35:03.763Z\",\n \"first_name\": null,\n \"last_name\": null,\n \"phone_number\": null,\n \"country_code\": null,\n \"address\": null,\n \"state\": null,\n \"voivodeship\": null\n }\n ],\n \"meta\": {\n \"page\": 1,\n \"take\": 10,\n \"recordsTotal\": \"3\",\n \"pagesTotal\": 1\n }\n}"},{"id":"84958bb3-0cdd-4164-a74c-58f330400937","name":"401 - Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/customer-invites?limit[take]=11&limit[page]=1&order[by]=email&order[dir]=ASC","host":["{{API_URL}}"],"path":["customer-invites"],"query":[{"key":"limit[take]","value":"11","description":"how many records should be displayed per page"},{"key":"limit[page]","value":"1","description":"which page should be fetched"},{"key":"order[by]","value":"email","description":"by which property list should be orderd"},{"key":"order[dir]","value":"ASC","description":"ASC | DESC"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"122"},{"key":"ETag","value":"W/\"7a-MLXj+E1nU+pcbJ0dDJkagyy0Th8\""},{"key":"Date","value":"Fri, 18 Dec 2020 14:21:46 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"user.unauthenticated\",\n \"message\": \"Authentication required\",\n \"statusCode\": 401\n }\n}"}],"_postman_id":"bc31db43-b87c-4bd9-b25d-5f9edad4aa61"},{"name":"Delete invite","id":"916dc50b-501d-4c38-911a-3779e287ee93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{API_URL}}/customer-invites/:id","description":"Delete an invite that was already sent.
\nOnly token with wallet_owner role is accepted
200 OK401 Unauthorized 404 Not Foundid of an existing invite (required *)
\n","type":"text/plain"},"type":"string","value":"d185f2ef-cef1-48fe-b63b-8a9f4f80c661","key":"id"}]}},"response":[{"id":"1357aae8-a9fa-4c6b-a86d-78fcc968730c","name":"200 - OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{API_URL}}/customer-invites/:id","host":["{{API_URL}}"],"path":["customer-invites",":id"],"variable":[{"key":"id","value":"d185f2ef-cef1-48fe-b63b-8a9f4f80c661","type":"string","description":"id of an existing invite"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"11"},{"key":"ETag","value":"W/\"b-qA97yBec1rrOyf2eVsYdWwFPOso\""},{"key":"Date","value":"Fri, 18 Dec 2020 14:29:58 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1\n}"},{"id":"2024656e-879d-4d59-8fc7-89e1abbb18a0","name":"404 - Not Found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{API_URL}}/customer-invites/:id","host":["{{API_URL}}"],"path":["customer-invites",":id"],"variable":[{"id":"c36b294c-2e74-4845-8468-17b0749924da","key":"id","value":"bd72e8d5-d3be-451c-8de4-975b41c6b387","type":"string","description":"id of an existing invite"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"119"},{"key":"ETag","value":"W/\"77-clwQMr4vv6W/bBZOI2wFYX0zWnQ\""},{"key":"Date","value":"Fri, 18 Dec 2020 14:29:34 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"entity.not-found\",\n \"message\": \"CustomerInvite not found\",\n \"statusCode\": 404\n }\n}"},{"id":"4c1ca5c4-f175-461e-b31d-b349872d1b0c","name":"401 - Unauthorized","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{API_URL}}/customer-invites/:id","host":["{{API_URL}}"],"path":["customer-invites",":id"],"variable":[{"id":"c36b294c-2e74-4845-8468-17b0749924da","key":"id","value":"bd72e8d5-d3be-451c-8de4-975b41c6b387","type":"string","description":"id of an existing invite"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"122"},{"key":"ETag","value":"W/\"7a-MLXj+E1nU+pcbJ0dDJkagyy0Th8\""},{"key":"Date","value":"Fri, 18 Dec 2020 14:28:11 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"user.unauthenticated\",\n \"message\": \"Authentication required\",\n \"statusCode\": 401\n }\n}"}],"_postman_id":"916dc50b-501d-4c38-911a-3779e287ee93"}],"id":"edca3ecd-f0ab-4779-89da-c7345c4ee2f5","description":"An authorized customer can manage and send out (via email) invites for his family members to join with that role as a new customer (family members are Nigerian citizens).
\nA wallet owner can freely manage his invitations. Other roles do not have access to this section.\nOwner can invite first set of family members without PIN validation as an initialization. Later PIN code validation is required.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a61d4025-0179-453c-9483-5b4a51608317","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2671dbcb-6604-49b5-ac6c-5dfce4c5b853","type":"text/javascript","exec":[""]}}],"_postman_id":"edca3ecd-f0ab-4779-89da-c7345c4ee2f5"},{"name":"Customers (Admin panel)","item":[{"name":"Customer list","id":"431f4dd3-b51f-4946-9e99-a42286be09e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{SV_AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}/admin/customers?order[by]=email&order[dir]=desc","description":"Fetches whole list of customers with enabled pagination and advanced filtration system.
\nAdvanced filtering is accepting filter params that are build as follows: filter[name_of_key]\nAllowed keys for filtering with the types they are representing:
'first_name' - string\n 'last_name' - string\n 'email' - string;email\n 'is_kyc_verified' - boolean\n 'kyc_status' - Enum('accepted', 'pending', 'declined', 'not_verified')\n 'failed_kyc_attempts' - number <0,3>\n 'is_active' - boolean\n 'is_email_verified' - boolean\n 'is_wallet_active' - boolean\n 'role' - Enum('wallet_owner', 'family_member')\nAs a value of filter param we can pass value with an operator, they look as follows:
\nno operator - simple value that has to be matched (e.g. `true`, `wallet_owner`)\n| - range operator, followerd by 2 numbers separated with a comma, deteremines from what range do we want to match the numbers (e.g. `|0,1` - means <0,1>)\n__ - invokes a custom filter, followed by the name of custom filter (e.g. `__all_active`)\n<> - comparision sign, folowed by a number value (e.g. `>30`, `<5`)\nThis endpoint has no custom filters
\n200 OK401 Unauthorizedwhich page should be fetched (default to 1)
\n","type":"text/plain"},"key":"limit[page]","value":"2"},{"disabled":true,"description":{"content":"how many records should be displayed per page (default to 10)
\n","type":"text/plain"},"key":"limit[take]","value":"10"},{"description":{"content":"(required*) by which property list should be orderd
\n","type":"text/plain"},"key":"order[by]","value":"email"},{"description":{"content":"(required*) takes either of following values: [ ASC ] , [ DESC ]
\n","type":"text/plain"},"key":"order[dir]","value":"desc"},{"disabled":true,"description":{"content":"filters the results by property role and searches for the value of wallet_owner
filters the results by property failed_kyc_attempts and searches for the value in rage of 0 - 1
searches in the results for matching values
\n","type":"text/plain"},"key":"search","value":"fen"}],"variable":[]}},"response":[{"id":"3a894693-d410-4f85-91be-b29c4e9e4d89","name":"401 - Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/admin/customers?limit[page]=2&limit[take]=10&order[by]=email&order[dir]=desc","host":["{{API_URL}}"],"path":["admin","customers"],"query":[{"key":"limit[page]","value":"2"},{"key":"limit[take]","value":"10"},{"key":"order[by]","value":"email"},{"key":"order[dir]","value":"desc"},{"key":"filter[role]","value":"wallet_owner","disabled":true},{"key":"filter[failed_kyc_attempts]","value":"|0,1","disabled":true},{"key":"search","value":"fen","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"122"},{"key":"ETag","value":"W/\"7a-MLXj+E1nU+pcbJ0dDJkagyy0Th8\""},{"key":"Date","value":"Fri, 18 Dec 2020 16:36:39 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"user.unauthenticated\",\n \"message\": \"Authentication required\",\n \"statusCode\": 401\n }\n}"}],"_postman_id":"431f4dd3-b51f-4946-9e99-a42286be09e6"},{"name":"Customer","id":"d3388458-de56-4f0c-ad5f-a0ab5cf8c1ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{SV_AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}/admin/customers/:id","description":"Fetches customer details for a supervisor's viewing
\nFields differ depending on user's role
\nwallet_owner response includes:
\"ownerMeta\": {\n \"id\": \"f8723f5d-7ae8-4fa9-b655-e364d3d4725a\",\n \"customer_id\": \"fb8f1f03-1180-4b65-ac63-2be9715c0a56\",\n \"street\": \"WilliamStreet\",\n \"house_number\": \"8\",\n \"flat_number\": null,\n \"city\": \"London\",\n \"postal_code\": \"E1 6AN\",\n \"country_code\": \"GB\"\n }\nfamily_member response includes:
\"memberMeta\": {\n \"id\": \"f8723f5d-7ae8-4fa9-b655-e364d3d4725a\",\n \"customer_id\": \"fb8f1f03-1180-4b65-ac63-2be9715c0a56\",\n \"wallet_owner_id\": \"c6eb8f55-ed97-4c1a-addf-8403d78a4853\",\n \"address\": \"WilliamStreet 8, Lala\",\n \"state\": \"State Name\",\n \"voivodeship\": \"Test\",\n \"country_code\": \"NG\"\n }\n200 OK404 Not Foundid of an existing user
\n","type":"text/plain"},"type":"string","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","key":"id"}]}},"response":[{"id":"f9758cde-ef76-4bf1-b564-9d48d313fe27","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/admin/customers/:id","host":["{{API_URL}}"],"path":["admin","customers",":id"],"variable":[{"key":"id","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","type":"string","description":"id of an existing user"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"715"},{"key":"ETag","value":"W/\"2cb-GqTdgR9Q7X4twzbaVbt9L7AwPgU\""},{"key":"Date","value":"Sat, 19 Dec 2020 22:03:55 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"customer\": {\n \"id\": \"fb8f1f03-1180-4b65-ac63-2be9715c0a56\",\n \"email\": \"daria+member2@desmart.com\",\n \"is_email_verified\": true,\n \"is_active\": true,\n \"password_reset_pin_created_at\": null,\n \"is_kyc_verified\": true,\n \"failed_kyc_attempts\": 0,\n \"kyc_status\": \"verified\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": null,\n \"phone_number\": \"+1232112312\",\n \"nickname\": \"JoJo\",\n \"is_wallet_active\": false,\n \"profile_photo_url\": null,\n \"role\": \"family_member\",\n \"deleted_at\": null,\n \"memberMeta\": {\n \"id\": \"f8723f5d-7ae8-4fa9-b655-e364d3d4725a\",\n \"customer_id\": \"fb8f1f03-1180-4b65-ac63-2be9715c0a56\",\n \"wallet_owner_id\": \"c6eb8f55-ed97-4c1a-addf-8403d78a4853\",\n \"address\": \"WilliamStreet 8, Lala\",\n \"state\": \"State Name\",\n \"voivodeship\": \"Test\",\n \"country_code\": \"NG\"\n }\n },\n \"kyc\": []\n}"}],"_postman_id":"d3388458-de56-4f0c-ad5f-a0ab5cf8c1ca"},{"name":"Block customer","id":"f7c5ef81-6a6a-4681-ae78-1c9898a513d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{SV_AUTH_TOKEN}}"}]},"isInherited":false},"method":"PATCH","header":[],"url":"{{API_URL}}/admin/customers/:id/block","description":"Sets a customer account as inactive
\n200 OK404 Not Foundid of an existing user
\n","type":"text/plain"},"type":"string","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","key":"id"}]}},"response":[{"id":"f5270652-3f33-477b-b93e-64c0e416ade7","name":"200 - OK","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"{{API_URL}}/admin/customers/:id/block","host":["{{API_URL}}"],"path":["admin","customers",":id","block"],"variable":[{"key":"id","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","type":"string","description":"id of an existing user"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"429"},{"key":"ETag","value":"W/\"1ad-1Q3aSuIJiEGt97EW551pu4VTSrk\""},{"key":"Date","value":"Sat, 19 Dec 2020 22:13:02 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"is_active\": false,\n \"id\": \"fb8f1f03-1180-4b65-ac63-2be9715c0a56\",\n \"email\": \"daria+member2@desmart.com\",\n \"is_email_verified\": true,\n \"password_reset_pin_created_at\": null,\n \"is_kyc_verified\": true,\n \"failed_kyc_attempts\": 0,\n \"kyc_status\": \"verified\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": null,\n \"phone_number\": \"+1232112312\",\n \"nickname\": \"JoJo\",\n \"is_wallet_active\": false,\n \"profile_photo_url\": null,\n \"role\": \"family_member\",\n \"deleted_at\": null\n}"}],"_postman_id":"f7c5ef81-6a6a-4681-ae78-1c9898a513d5"},{"name":"Unblock customer","id":"2e9bc5d8-786b-41eb-8809-d46c8f9824c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{SV_AUTH_TOKEN}}"}]},"isInherited":false},"method":"PATCH","header":[],"url":"{{API_URL}}/admin/customers/:id/unblock","description":"Sets a customer account as active
\n200 OK404 Not Foundid of an existing user
\n","type":"text/plain"},"type":"string","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","key":"id"}]}},"response":[{"id":"5e6c157a-171d-449d-a626-2ac8eb00ad18","name":"200 - OK","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"{{API_URL}}/admin/customers/:id/unblock","host":["{{API_URL}}"],"path":["admin","customers",":id","unblock"],"variable":[{"key":"id","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"428"},{"key":"ETag","value":"W/\"1ac-RBa0J3l7qCQcXpsQFBLirsfa4Nc\""},{"key":"Date","value":"Sat, 19 Dec 2020 22:12:39 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"is_active\": true,\n \"id\": \"fb8f1f03-1180-4b65-ac63-2be9715c0a56\",\n \"email\": \"daria+member2@desmart.com\",\n \"is_email_verified\": true,\n \"password_reset_pin_created_at\": null,\n \"is_kyc_verified\": true,\n \"failed_kyc_attempts\": 0,\n \"kyc_status\": \"verified\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": null,\n \"phone_number\": \"+1232112312\",\n \"nickname\": \"JoJo\",\n \"is_wallet_active\": false,\n \"profile_photo_url\": null,\n \"role\": \"family_member\",\n \"deleted_at\": null\n}"}],"_postman_id":"2e9bc5d8-786b-41eb-8809-d46c8f9824c5"},{"name":"Verify KYC","id":"57c003c6-192d-40b6-93a7-3db8dd332477","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{SV_AUTH_TOKEN}}"}]},"isInherited":false},"method":"PATCH","header":[],"url":"{{API_URL}}/admin/customers/:id/verify-kyc","description":"Sets a customer account as verified by KYC.
\nOnly wallet_owner can be verified this way because with family_member we need a user to enter a valid BVN
200 OK403 Forbidden404 Not Foundid of an existing customer
\n","type":"text/plain"},"type":"string","value":"96bbbc97-2483-41db-904e-a5fcbbae7c95","key":"id"}]}},"response":[{"id":"38bb1972-d20b-46f8-a7fe-5532eb8b2412","name":"403 - Forbidden","originalRequest":{"method":"PATCH","header":[],"url":{"raw":"{{API_URL}}/admin/customers/:id/verify-kyc","host":["{{API_URL}}"],"path":["admin","customers",":id","verify-kyc"],"variable":[{"key":"id","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","type":"string","description":"id of an existing customer"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"125"},{"key":"ETag","value":"W/\"7d-3kedQQ/abo3VcKA+tGjfOndEaug\""},{"key":"Date","value":"Sat, 19 Dec 2020 22:25:38 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"users.not-wallet-owner\",\n \"message\": \"User is not wallet owner\",\n \"statusCode\": 403\n }\n}"},{"id":"75938d5c-e556-42d6-904e-5330529586a3","name":"200 - OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","type":"text","value":"{{SV_AUTH_TOKEN}}"}],"url":{"raw":"{{API_URL}}/admin/customers/:id/verify-kyc","host":["{{API_URL}}"],"path":["admin","customers",":id","verify-kyc"],"variable":[{"key":"id","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"429"},{"key":"ETag","value":"W/\"1ad-5tLDrQP/fsyKhdr/26QGu9PpWV4\""},{"key":"Date","value":"Sat, 19 Dec 2020 22:16:18 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"kyc_status\": \"approved\",\n \"failed_kyc_attempts\": 0,\n \"is_kyc_verified\": true,\n \"id\": \"fb8f1f03-1180-4b65-ac63-2be9715c0a56\",\n \"email\": \"daria+member2@desmart.com\",\n \"is_email_verified\": true,\n \"is_active\": false,\n \"password_reset_pin_created_at\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"date_of_birth\": null,\n \"phone_number\": \"+1232112312\",\n \"nickname\": \"JoJo\",\n \"is_wallet_active\": false,\n \"profile_photo_url\": null,\n \"role\": \"family_member\",\n \"deleted_at\": null\n}"}],"_postman_id":"57c003c6-192d-40b6-93a7-3db8dd332477"},{"name":"Delete customer","id":"bd959506-7547-4a3f-b7ba-971abf31cd92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{SV_AUTH_TOKEN}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{API_URL}}/admin/customers/:id","description":"Soft delete of a user.
\n200 OK404 Not Foundid of an existing user
\n","type":"text/plain"},"type":"string","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","key":"id"}]}},"response":[{"id":"75bfb0d3-817a-4744-8e43-315076bd21a5","name":"200 - OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{API_URL}}/admin/customers/:id","host":["{{API_URL}}"],"path":["admin","customers",":id"],"variable":[{"key":"id","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"41"},{"key":"ETag","value":"W/\"29-Zu7q3BcdQSt2y+Dq7dJ1MagnnZU\""},{"key":"Date","value":"Sat, 19 Dec 2020 22:46:02 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"deleted_at\": \"2020-12-19T22:46:02.565Z\"\n}"}],"_postman_id":"bd959506-7547-4a3f-b7ba-971abf31cd92"},{"name":"Login history","id":"b2227c4e-66e2-48da-9259-ce8939b3d84f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{SV_AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}/admin/customers/:id/login-history?limit[take]=10&limit[page]=1","description":"Fetches last 20 times when a chosen customer logged in. Response is paginated, default is set to 10 items per page.
\n200 OKwhich page should be fetched (default to 1)
\n","type":"text/plain"},"key":"limit[take]","value":"10"},{"description":{"content":"how many records should be displayed per page (default to 10)
\n","type":"text/plain"},"key":"limit[page]","value":"1"}],"variable":[{"description":{"content":"id of an existing user
\n","type":"text/plain"},"type":"string","value":"c6eb8f55-ed97-4c1a-addf-8403d78a4853","key":"id"}]}},"response":[{"id":"7fb08858-2356-4490-bb74-ad3a55203b72","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/admin/customers/:id/login-history","host":["{{API_URL}}"],"path":["admin","customers",":id","login-history"],"variable":[{"key":"id","value":"c6eb8f55-ed97-4c1a-addf-8403d78a4853","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"489"},{"key":"ETag","value":"W/\"1e9-dMGb9ewv5XVKvumq+Lau+hDbDEo\""},{"key":"Date","value":"Sat, 19 Dec 2020 22:31:52 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"d02c915d-d5f6-467a-8396-3c2ecd359919\",\n \"customer_id\": \"c6eb8f55-ed97-4c1a-addf-8403d78a4853\",\n \"created_at\": \"2020-12-19T13:28:14.639Z\"\n },\n {\n \"id\": \"76508c54-f0b6-4d41-8649-7b3151ac2b54\",\n \"customer_id\": \"c6eb8f55-ed97-4c1a-addf-8403d78a4853\",\n \"created_at\": \"2020-12-19T13:21:10.877Z\"\n },\n {\n \"id\": \"cef78330-c5e6-4d8a-925a-59031e06f432\",\n \"customer_id\": \"c6eb8f55-ed97-4c1a-addf-8403d78a4853\",\n \"created_at\": \"2020-12-17T18:20:28.449Z\"\n }\n ],\n \"meta\": {\n \"page\": 1,\n \"take\": 10,\n \"recordsTotal\": \"3\",\n \"pagesTotal\": 1\n }\n}"}],"_postman_id":"b2227c4e-66e2-48da-9259-ce8939b3d84f"}],"id":"99677c98-f957-4d06-9fa0-739cbefb6297","description":"Module is responsible for providing all the data and requests for monitoring/managing users for a supervisor.
\nSupervisor can:
\nInitialize email change for a customer.
\n200 OK422 Unprocessable EntityAttempt to verify current (old) email of a customer.
\n200 OK422 Unprocessable EntityAttempt to verify new email of a customer.
\n200 OK422 Unprocessable EntityThis section handles whenever a customer wants to change his email address. To make that possible he has to verify his 'old' email address that it belongs to him (protection for stealing the accounts). Later he has to verify his new email address to confirm he can receive messages.
\n","_postman_id":"eeab7215-8be3-4bea-9175-7f853d82262a"},{"name":"Files","item":[{"name":"Sign request","event":[{"listen":"test","script":{"id":"3810ade8-4185-4271-ac90-238ab628631c","exec":["const jsonData = JSON.parse(responseBody);","","if (jsonData) {"," postman.setEnvironmentVariable(\"AWS_S3_POLICY\", jsonData.policy);"," postman.setEnvironmentVariable(\"AWS_S3_SIGNATURE\", jsonData.signature);","}"],"type":"text/javascript"}}],"id":"ee03d73a-a86e-41d6-b17d-3a697dac7c61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{API_URL}}/files/sign-request","description":"Returns values that are needed to sign AWS S3 requests (e.g. for uploading files).
\nIn a response you get:
\n{\n \"policy\": \"POLICY\",\n \"signature\": \"SIGNATURE\"\n}\npng or jpg file that shows a person's face (required *)
\n","src":"/home/sherrywolf/Pictures/IMG_2655.png"},{"key":"document","type":"file","description":"png or jpg file of a ID document (required *)
\n","src":"/home/sherrywolf/Pictures/IMG_2655.png"},{"key":"address","type":"file","src":"/home/sherrywolf/Pictures/IMG_2655.png"}]},"url":"{{API_URL}}/kyc","description":"Initiates KYC verification with selfie and a document picture (the response comes back to the callback endpoint)
\nEP is open only for wallet_owner and service responsibe for verification is ShuftiPro
200 OK400 Bad Request401 Unauthorized403 ForbiddenAttempt to resolve BVN for a family_member. Endpoint returns a boolean depending on if all steps were completed successfully.
1. Verify BVN\n2. Update user Profile (from resolved BVN)\n3. Update users KYC status\n4. Create wallet in wallets.africa\n5. Verify created wallet with BVN\n6. Save wallet's data to local db\n200 OK401 Unauthorized403 Fobidden422 Unprocessable Entity(DEBUG) it replicates the response from ShuftiPro after calling for KYC verification.
\nBy changing the event property we can manipulate if request is verified or declined.
id of a kyc job in local db (required *)
\n","type":"text/plain"},"type":"string","value":"6693178d-2638-4488-971e-f45cb0d3346c","key":"id"}]}},"response":[],"_postman_id":"6c72f82b-a0e2-4397-a5ce-38991690d76f"},{"name":"Handle Smile Identity callback (detached)","id":"c730e03f-4948-4d68-9966-712f5f1e6245","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"ResultCode\": \"1220\",\n \"ResultText\": \"Authenticated\",\n \"ResultType\": \"DIVA\",\n \"SmileJobID\": \"0000000001\",\n \"JSONVersion\": \"1.0.0\",\n \"IsFinalResult\": \"true\",\n \"PartnerParams\": {\n \"job_id\": \"e7ca3e6c-e527-7165-b0b5-b90db1276378\",\n \"user_id\": \"07a0c120-98d7-4fdc-bc62-3c6bfd16c60e\",\n \"job_type\": 2\n },\n \"ConfidenceValue\": \"100.000000\",\n \"IsMachineResult\": \"true\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/kyc/smile-identity/cb","description":"(DEBUG) it replicates the response from SmileIdentity after calling for KYC verification.
\nBy changing the ResultCode property we can manipulate if request is verified or declined.
In MyTalu API 2 services are being used for KYC (Know Your Customer) verification based on from where the customer is. KYC check is the mandatory process of identifying and verifying the identity of the client when opening an account and periodically over time. In other words, banks must make sure that their clients are genuinely who they claim to be.
\nSmile Identity uses Computer vision and Machine learning to validate true identity.
\nAPI uses wallets.africa to fetch information assigned to BVN. Customer upon registration provides us with a number that is later on verified and fetched data is saved as customer's profile data.
\nOrder physical card for a family member.\nAdditionaly transfer to charge the card is created (if defined amount is > 0), user can assign categories to that transfer which will say on what he is planning to spend those money. Percentage of categories have to sum up to 100, namings are open (can by any string).
\nMember can have only one physical card.
\n200 OK401 Unauthorized403 Forbidden422 Unprocessable EntityFetch details about member's physical card.
\n200 OK401 Unauthorized403 ForbiddenFetch transactions from member's virtual card.
\n200 OK401 Unauthorized403 ForbiddenOrder virtual card for a family member. Additionaly transfer to charge the card is created, user can assign categories to that transfer which will say on what he is planning to spend those money. Percentage of categories have to sum up to 100, namings are open (can by any string).
\nMember can have only one virual card.
\n200 OK401 Unauthorized403 Forbidden422 Unprocessable EntityFetch details about member's virtual card.
\n200 OK401 Unauthorized403 ForbiddenFetch transactions from member's virtual card.
\n200 OK401 Unauthorized403 ForbiddenPurchase airtime for a chosen phone number. Member has to verify his app PIN code to confirm the purchase.
\n200 OK403 Forbidden422 Unprocessable EntityView the list of Nigerian states and their corresponding codes for further processing.
\n200401403View the list of Nigerian airtime providers and their corresponding codes for further processing.
\n200401403Fetches whole list of member's wallet transactions with assigned categories.
\nEP uses pagination
\nReturns following transaction types:
\n200 OK401 Unauthorized403 Forbiddenwhich page should be fetched (default to 1)
\n","type":"text/plain"},"key":"limit[page]","value":"1"},{"description":{"content":"how many records should be displayed per page (default to 10)
\n","type":"text/plain"},"key":"limit[take]","value":"10"}],"variable":[]}},"response":[{"id":"eed9c0f9-5e51-4f06-9c8f-bc3bec17b38c","name":"200 - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/member/transactions/wallet?limit[page]=1&limit[take]=10","host":["{{API_URL}}"],"path":["member","transactions","wallet"],"query":[{"key":"limit[page]","value":"1","description":"which page should be fetched (default to 1)"},{"key":"limit[take]","value":"10","description":"how many records should be displayed per page (default to 10)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"408"},{"key":"ETag","value":"W/\"198-z0L0eHjj9RP5bOFTov7tMnzoewo\""},{"key":"Date","value":"Thu, 14 Jan 2021 14:17:54 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"wallet_id\": \"a555f20a-104d-4100-820e-bb6d55afef22\",\n \"created_at\": \"2021-01-14T10:26:21.922Z\",\n \"type\": \"virtual_card_transfer\",\n \"currency\": \"NGN\",\n \"is_incoming\": false,\n \"description\": \"Charging virtual card\",\n \"amount\": 200,\n \"categories\": [\n {\n \"percentage\": 10,\n \"category\": \"baz\"\n },\n {\n \"percentage\": 60,\n \"category\": \"bar\"\n },\n {\n \"percentage\": 30,\n \"category\": \"foo\"\n }\n ]\n }\n ],\n \"meta\": {\n \"page\": \"1\",\n \"take\": \"10\",\n \"recordsTotal\": \"1\",\n \"pagesTotal\": 1\n }\n}"}],"_postman_id":"3855e2d7-8db2-4c2b-a24f-85eb2e5d4b9e"}],"id":"2f944526-6785-4649-99c1-ceabe03acedd","description":"Section dedicated for customer with a role - family_member
Returns the status of all current connections
\nendpoint is attached to the main url (without the versioning e.g. http://127.0.0.1:8080/healthcheck)
Returns 200 if API is \"healthy\" (running).
endpoint is attached to the main url (without the versioning e.g. http://127.0.0.1:8080)
Section is holding endpoints that return the status of the API
\n","_postman_id":"0b344f68-9f68-4bc3-bfcc-ea63b4d3ae3b"},{"name":"Notifications (debug) ","item":[{"name":"FCM test","id":"1d5ba195-4105-4d0b-ae6a-9e8340ee8964","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{API_URL}}/customers/fcm-test","description":"Sends test FCM notification
\nTitle: 'Message from API'\nMessage: 'Hey there!'\n200 OK401 UnauthorizedSends FCM notification to wallet owner that his family member is 'running low'
\n200 OK401 UnauthorizedSends FCM notification to wallet owner that his family member is 'running low'
\nThe notification is also saved to local db.
\n200 OK401 Unauthorizedid of an existing family member
\n","type":"text/plain"},"type":"string","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","key":"id"}]}},"response":[],"_postman_id":"9546416f-7634-4ce9-8bdc-576dcf907c8e"},{"name":"Need support","id":"0013c70b-665b-45f6-b214-a402308b0640","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"categories\": {\n \"foo\": 20,\n \"bar\": 80\n },\n \"amount\": 1234\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/notifications-debug/need-support/:id","description":"Sends FCM notification to wallet owner that his family member needs some support
\nThe notification is also saved to local db.
\ncategories object is presented as follows:
\n{\n \"foo\": 20, \n \"bar\": 80\n}\nName of the key is the name of a category while the value is the percentage ([amount of money from category]/[general amount needed] * 100)
\n200 OK401 Unauthorizedid of an existing family member
\n","type":"text/plain"},"type":"string","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56","key":"id"}]}},"response":[{"id":"c8ea0349-6f1c-46bb-9a33-961f6ace7f11","name":"200 - OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"categories\": {\n \"foo\": 20,\n \"bar\": 80\n },\n \"amount\": 1234\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{API_URL}}/notifications-debug/need-support/:id","host":["{{API_URL}}"],"path":["notifications-debug","need-support",":id"],"variable":[{"description":"id of an existing family member","key":"id","type":"string","value":"fb8f1f03-1180-4b65-ac63-2be9715c0a56"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Date","value":"Sat, 19 Dec 2020 20:07:28 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0013c70b-665b-45f6-b214-a402308b0640"}],"id":"be4c990a-1fbb-4887-9752-70821372b743","description":"Firebase Cloud Messaging (FCM) is a cross-platform messaging solution that lets you reliably send messages at no cost.
\nUsing FCM, you can notify a client app that new email or other data is available to sync. You can send notification messages to drive user re-engagement and retention. For use cases such as instant messaging, a message can transfer a payload of up to 4KB to a client app.
\n","event":[{"listen":"prerequest","script":{"id":"fbc4f396-0e10-4d5d-91e5-fa304307dd25","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f557fdf2-da81-4e34-9173-1eb6d71fd23a","type":"text/javascript","exec":[""]}}],"_postman_id":"be4c990a-1fbb-4887-9752-70821372b743"},{"name":"Owner","item":[{"name":"Init transfer","event":[{"listen":"test","script":{"id":"398b0a12-22c2-4849-b0e0-6d013b286fbd","exec":["const jsonData = JSON.parse(responseBody);","","if (jsonData) {"," postman.setEnvironmentVariable(\"CP_QUOTE_ID\", jsonData.quote_id);","}"],"type":"text/javascript"}}],"id":"a0c7063b-cf36-4123-b8fb-8b9fa592f8d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"memberId\": \"fc48f9fe-0ef4-442d-b7da-8c6c9f21bf4b\",\n \"amount\": 30.99,\n \"categories\": [\n {\n \"category\": \"foo\",\n \"percentage\": 30\n },\n {\n \"category\": \"bar\",\n \"percentage\": 60\n },\n {\n \"category\": \"baz\",\n \"percentage\": 10\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/owner/init-transfer","description":"Initiates the transfr to family member by checking and saving the spot rate.
\nThere are 10 seconds to confirm the spot rate and send the actual transfer with Book transfer
a category can be defined as follows:
\n{\n \"category\": \"foo\", // name of a category\n \"percentage\": 30 // how much of the main amount belongs to this category\n}\nthe percentages from the array have to sum up to 100
\n200 OK401 Unauthorized403 Forbidden404 Not Found422 Unprocessable EntityBooks the transfer to owner's family member in Nigeria.
\nWe have to have the spot rate id from Init transfer
What actualy happens is:
\na category can be defined as follows:
\n{\n \"category\": \"foo\", // name of a category\n \"percentage\": 30 // how much of the main amount belongs to this category\n}\nthe percentages from the array have to sum up to 100
\n200 OK401 Unauthorized403 Forbidden404 Not Found410 Goneid of a previously confirmed spot rate (required *)
\n","type":"text/plain"},"type":"string","value":"{{CP_QUOTE_ID}}","key":"id"}]}},"response":[],"_postman_id":"358af844-9c05-4195-9f66-94c06cd890e4"},{"name":"Fetch family members","id":"f68dbdec-6335-478d-8e1f-2b58dea719d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}/owner/members","description":"Returns basic data of all family members assigned to currently logged in customer.
\n200401Returns basic data of all family members assigned to currently logged in customer.
\n200401Returns basic data of made transactions to family_members. The status of a transaction can be:
- \"booked\" - deal made but not yet transfered from main ledger to other side (family_member received money from pre-paid model)
- \"finished\" - the money were transfered fully
- \"declined\" - when a transaction did not succeed due to internal regulations (amount transfered is higher than 4k GBP)
200401Section dedicated for customer with a role - wallet_owner
Fetches whole list of customers with enabled pagination and advanced filtration system.
\nAdvanced filtering is accepting filter params that are build as follows: filter[name_of_key]\nAllowed keys for filtering with the types they are representing:
'first_name' - string\n 'last_name' - string\n 'email' - string;email\n 'is_kyc_verified' - boolean\n 'kyc_status' - Enum('accepted', 'pending', 'declined', 'not_verified')\n 'failed_kyc_attempts' - number <0,3>\n 'is_active' - boolean\n 'is_email_verified' - boolean\n 'is_wallet_active' - boolean\n 'role' - Enum('wallet_owner', 'family_member')\nAs a value of filter param we can pass value with an operator, they look as follows:
\nno operator - simple value that has to be matched (e.g. `true`, `wallet_owner`)\n| - range operator, followerd by 2 numbers separated with a comma, deteremines from what range do we want to match the numbers (e.g. `|0,1` - means <0,1>)\n__ - invokes a custom filter, followed by the name of custom filter (e.g. `__all_active`)\n<> - comparision sign, folowed by a number value (e.g. `>30`, `<5`)\nThis endpoint has no custom filters
\n200 OK401 Unauthorizedwhich page should be fetched (default to 1)
\n","type":"text/plain"},"key":"limit[page]","value":"2"},{"disabled":true,"description":{"content":"how many records should be displayed per page (default to 10)
\n","type":"text/plain"},"key":"limit[take]","value":"10"},{"description":{"content":"(required*) by which property list should be orderd
\n","type":"text/plain"},"key":"order[by]","value":"percentage"},{"description":{"content":"(required*) takes either of following values: [ ASC ] , [ DESC ]
\n","type":"text/plain"},"key":"order[dir]","value":"desc"},{"disabled":true,"description":{"content":"filters the results by property role and searches for the value of wallet_owner
filters the results by property failed_kyc_attempts and searches for the value in rage of 0 - 1
searches in the results for matching values
\n","type":"text/plain"},"key":"search","value":"fen"}],"variable":[]}},"response":[{"id":"964a4c2e-ed82-4665-af9e-0ec84fec83d8","name":"401 - Unauthorized","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{API_URL}}/admin/customers?limit[page]=2&limit[take]=10&order[by]=email&order[dir]=desc","host":["{{API_URL}}"],"path":["admin","customers"],"query":[{"key":"limit[page]","value":"2"},{"key":"limit[take]","value":"10"},{"key":"order[by]","value":"email"},{"key":"order[dir]","value":"desc"},{"key":"filter[role]","value":"wallet_owner","disabled":true},{"key":"filter[failed_kyc_attempts]","value":"|0,1","disabled":true},{"key":"search","value":"fen","disabled":true}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"122"},{"key":"ETag","value":"W/\"7a-MLXj+E1nU+pcbJ0dDJkagyy0Th8\""},{"key":"Date","value":"Fri, 18 Dec 2020 16:36:39 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"name\": \"default-error\",\n \"errorCode\": \"user.unauthenticated\",\n \"message\": \"Authentication required\",\n \"statusCode\": 401\n }\n}"}],"_postman_id":"eff5fd25-4a0b-4a45-970b-4bd0265dcc31"}],"id":"7d34caeb-e2f6-4586-a457-e7f1ea992dd2","_postman_id":"7d34caeb-e2f6-4586-a457-e7f1ea992dd2","description":""},{"name":"Stats (Admin panel)","item":[{"name":"Get stats","id":"6d52b355-df91-439a-b1aa-c6fa3ad3413e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{SV_AUTH_TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{API_URL}}/admin/stats","description":"Fetches statistics that are meant to be displayed for every supervisor on admin panel.
\n200 OKAttempt to initiate password reset for existing supervisor.
\n200 OK403 Forbidden404 Not FoundAttempt to validate reset password token.
\n200 OK403 ForbiddenAttempt to finalize password change for given supervisor.
\n200 OK403 Forbidden422 Unprocessable EntitySection is responsible for reseting a password if a supervisor forgot it and/or he has troubles logging in.
\nTo reset a password we start with Reset passsword init that sends an email to a supervisor, where he has to click on a link with a token (confirming that he is who he says he is). Token can be validated with Reset password validate, it is valid for 24h. To finalize the password change we use Reset password finish EP.
Attempt to log in a supervisor to application.
\n200 OK401 Unauthorized403 Forbidden404 Not Found422 Unprocessable EntityAttempt to create base supervisor to application. Operation is only allowed when there are no supervisors in db.
\n200 OK403 ForbiddenAttempt to create new account for a supervisor.\nNew supervisor should receive email with verification link.
\n200 OK401 Unauthorized403 ForbiddenResends email with link to setting up a password for new supervisor.
\n200 OK401 Unauthorized404 Not Foundid of invited supervisor
\n","type":"text/plain"},"type":"string","value":"b4e9fcbc-1576-4f06-9e71-8972e1fa1cc7","key":"id"}]}},"response":[{"id":"1284f1e3-46d4-467a-a674-5ba70134abc6","name":"200 - OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"{{AUTH_TOKEN}}"}],"url":{"raw":"{{API_URL}}/supervisors/:id/resend-verification-email","host":["{{API_URL}}"],"path":["supervisors",":id","resend-verification-email"],"variable":[{"description":"id of invited supervisor ","key":"id","type":"string","value":"b4e9fcbc-1576-4f06-9e71-8972e1fa1cc7"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Date","value":"Mon, 19 Oct 2020 18:43:20 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7ed301a4-4bf8-43bd-835c-5ec3139ed538"},{"name":"Change password","id":"ff1be4ce-c0ee-4535-aa88-13ff4d47a1ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{SV_AUTH_TOKEN}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"currentPassword\": \"123qwe#\",\n \"newPassword\": \"1234qwer#\"\n}","options":{"raw":{"language":"json"}}},"url":"{{API_URL}}/supervisors/change-password","description":"Attempts to change password of currently logged in supervisor.
\n200 OK401 Unauthorized403 ForbiddenA subject who can manage customers and customers’ family members, their\naccess to the application, track general analytics.
\n","event":[{"listen":"prerequest","script":{"id":"c1cf5711-5dcd-484a-acdd-e0ec924fa2ca","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6f6febb4-fd83-4c11-a988-b454732cbd15","type":"text/javascript","exec":[""]}}],"_postman_id":"5638a7af-dd59-4b6a-a575-ad20a322460f"},{"name":"Transfers","item":[{"name":"Instruct deals [DEBUG]","id":"7834d26c-d1b0-47e8-9191-3bba04eeafc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{SV_AUTH_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{API_URL}}/transfers/instruct-deals","description":"Initiates the transfr to family member by checking and saving the spot rate.
\nThere are 10 seconds to confirm the spot rate and send the actual transfer with Book transfer
a category can be defined as follows:
\n{\n \"category\": \"foo\", // name of a category\n \"percentage\": 30 // how much of the main amount belongs to this category\n}\nthe percentages from the array have to sum up to 100
\n200 OK401 Unauthorized403 Forbidden404 Not Found422 Unprocessable Entity