{"id":15444128,"url":"https://github.com/struckchure/demo-credits","last_synced_at":"2026-02-27T03:34:25.961Z","repository":{"id":137607786,"uuid":"551604232","full_name":"struckchure/demo-credits","owner":"struckchure","description":"Demo Wallet API","archived":false,"fork":false,"pushed_at":"2023-01-11T04:44:26.000Z","size":288,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-13T19:40:05.213Z","etag":null,"topics":["api","docker","docker-compose","express","knexjs","mongodb","nginx","nodejs","rest-api"],"latest_commit_sha":null,"homepage":"https://demo-credits.struckchure.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/struckchure.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-14T18:15:44.000Z","updated_at":"2023-01-07T02:16:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"00e94e10-39c2-467b-9bfb-5d55e078576c","html_url":"https://github.com/struckchure/demo-credits","commit_stats":{"total_commits":49,"total_committers":1,"mean_commits":49.0,"dds":0.0,"last_synced_commit":"d1a4dcb58bc49fbcb620e498301553a387ef5351"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/struckchure/demo-credits","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/struckchure%2Fdemo-credits","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/struckchure%2Fdemo-credits/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/struckchure%2Fdemo-credits/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/struckchure%2Fdemo-credits/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/struckchure","download_url":"https://codeload.github.com/struckchure/demo-credits/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/struckchure%2Fdemo-credits/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29883792,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-26T23:51:21.483Z","status":"online","status_checked_at":"2026-02-27T02:00:06.759Z","response_time":57,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","docker","docker-compose","express","knexjs","mongodb","nginx","nodejs","rest-api"],"created_at":"2024-10-01T19:39:28.328Z","updated_at":"2026-02-27T03:34:25.943Z","avatar_url":"https://github.com/struckchure.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Demo Credit API\n\n[![AWS Deployment](https://github.com/struckchure/demo-credits/actions/workflows/aws-deploy.yml/badge.svg)](https://github.com/struckchure/demo-credits/actions/workflows/aws-deploy.yml)\n\nDemo Credit is a wallet service. This is needed as borrowers need a wallet to receive the loans they have been granted and also send the money for repayments.\n\n## ER Diagram\n\n![Model Diagram](./docs/images/er-diagram.png)\n\n## API Documentation\n\nBase URL: `https://mohammed-lendsqr-be-test.struckchure.com`\nDefault headers:\n\n```json\n{\n  \"Content-Type\": \"application/json\",\n  \"Accept\": \"application/json\"\n}\n```\n\n# user endpoints\n\n- `GET /api/v1/user/register` - Register a user\n\nSample Payload:\nAll fields are required for registering a user.\n\n```json\n{\n  \"username\": \"username\",\n  \"password\": \"password\"\n}\n```\n\nSample Response(201):\n\n```json\n{\n  \"data\": {\n    \"id\": \"\u003cuser_id\u003e\",\n    \"username\": \"username\",\n    \"password\": \"password\",\n    \"token\": \"\u003ctoken\u003e\",\n    \"created_at\": \"2020-05-01T00:00:00Z\",\n    \"updated_at\": \"2020-05-01T00:00:00Z\"\n  }\n}\n```\n\n- `POST /api/v1/user/login` - Login a user / obtain a token\n\nSample Payload:\nAll fields are required for logging in a user.\n\n```json\n{\n  \"username\": \"username\",\n  \"password\": \"password\"\n}\n```\n\nSample Response (200):\n\n```json\n{\n  \"data\": {\n    \"id\": \"\u003cuser_id\u003e\",\n    \"username\": \"username\",\n    \"token\": \"\u003ctoken\u003e\",\n    \"created_at\": \"2020-05-01T00:00:00Z\",\n    \"updated_at\": \"2020-05-01T00:00:00Z\"\n  }\n}\n```\n\n# wallet endpoints\n\nAuthentication is required for all wallet endpoints. Tokens are obtained from the user endpoints.\nDefault headers:\n\n```json\n{\n  \"Content-Type\": \"application/json\",\n  \"Accept\": \"application/json\",\n  \"Authorization\": \"Bearer \u003ctoken\u003e\"\n}\n```\n\n- `POST /api/v1/wallet` - Create a wallet\n\nSample Payload: No payload is required for creating a wallet.\n\nSample Response (201):\n\n```json\n{\n  \"data\": {\n    \"id\": \"\u003cwallet_id\u003e\",\n    \"user\": \"\u003cuser_id\u003e\",\n    \"balance\": 0,\n    \"created_at\": \"2020-05-01T00:00:00Z\",\n    \"updated_at\": \"2020-05-01T00:00:00Z\"\n  }\n}\n```\n\n- `GET /api/v1/wallet` - Get a user's wallet\n\nSample Response(200):\n\n```json\n{\n  \"data\": {\n    \"id\": \"\u003cwallet_id\u003e\",\n    \"user\": \"\u003cuser_id\u003e\",\n    \"balance\": 0,\n    \"created_at\": \"2020-05-01T00:00:00Z\",\n    \"updated_at\": \"2020-05-01T00:00:00Z\"\n  }\n}\n```\n\n- `POST /api/v1/wallet/fund` - Fund a wallet\n\nSample Payload:\nAll fields are required for funding a wallet.\n\n```json\n{\n  \"amount\": 100\n}\n```\n\nSample Response(200):\n\n```json\n{\n  \"data\": {\n    \"id\": \"\u003cwallet_id\u003e\",\n    \"user\": \"\u003cuser_id\u003e\",\n    \"balance\": 100,\n    \"created_at\": \"2020-05-01T00:00:00Z\",\n    \"updated_at\": \"2020-05-01T00:00:00Z\"\n  }\n}\n```\n\n- `POST /api/v1/wallet/withdraw` - Withdraw from a wallet\n\nSample Payload:\nAll fields are required for withdrawing from a wallet.\n\n```json\n{\n  \"amount\": 100\n}\n```\n\nSample Response(200):\n\n```json\n{\n  \"data\": {\n    \"id\": \"\u003cwallet_id\u003e\",\n    \"user\": \"\u003cuser_id\u003e\",\n    \"balance\": 0,\n    \"created_at\": \"2020-05-01T00:00:00Z\",\n    \"updated_at\": \"2020-05-01T00:00:00Z\"\n  }\n}\n```\n\n- `POST /api/v1/wallet/transfer` - Transfer money from one user to another\n\nSample Payload:\nAll fields are required for transferring money from one user to another.\n\n```json\n{\n  \"amount\": 100,\n  \"username\": \"\u003cusername\u003e\"\n}\n```\n\nSample Response(200):\n\n```json\n{\n  \"data\": {\n    \"id\": \"\u003cwallet_id\u003e\",\n    \"user\": \"\u003cuser_id\u003e\",\n    \"balance\": 0,\n    \"created_at\": \"2020-05-01T00:00:00Z\",\n    \"updated_at\": \"2020-05-01T00:00:00Z\"\n  }\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstruckchure%2Fdemo-credits","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstruckchure%2Fdemo-credits","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstruckchure%2Fdemo-credits/lists"}