{"id":16497254,"url":"https://github.com/guillaumefalourd/poc-bank-api-java","last_synced_at":"2025-10-27T23:31:34.445Z","repository":{"id":43840909,"uuid":"317970736","full_name":"GuillaumeFalourd/poc-bank-api-java","owner":"GuillaumeFalourd","description":"POC of a bank api in JAVA ☕️","archived":false,"fork":false,"pushed_at":"2024-02-21T11:11:44.000Z","size":135,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-08T13:06:39.853Z","etag":null,"topics":["2017","api","java","poc","proof-of-concept"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GuillaumeFalourd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2020-12-02T19:34:33.000Z","updated_at":"2023-02-17T12:13:20.000Z","dependencies_parsed_at":"2025-02-13T00:31:21.589Z","dependency_job_id":"3f7f1c32-8ecb-4944-977d-e8555c3ed618","html_url":"https://github.com/GuillaumeFalourd/poc-bank-api-java","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GuillaumeFalourd/poc-bank-api-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuillaumeFalourd%2Fpoc-bank-api-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuillaumeFalourd%2Fpoc-bank-api-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuillaumeFalourd%2Fpoc-bank-api-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuillaumeFalourd%2Fpoc-bank-api-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GuillaumeFalourd","download_url":"https://codeload.github.com/GuillaumeFalourd/poc-bank-api-java/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuillaumeFalourd%2Fpoc-bank-api-java/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281361405,"owners_count":26487881,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-27T02:00:05.855Z","response_time":61,"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":["2017","api","java","poc","proof-of-concept"],"created_at":"2024-10-11T14:38:56.458Z","updated_at":"2025-10-27T23:31:34.035Z","avatar_url":"https://github.com/GuillaumeFalourd.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# poc-bank-api-java\n\n`Project creation date: 2017`\n\nApplication that simulates a bank api, allowing the registration of customers, and the operations of deposits, withdrawals, transfers, balance inquiries and account statements.\n\n## Business rules\n\n- The account balance can't be negative;\n- It is not possible to make a withdrawal or transfer when the account balance is insufficient;\n- Accounts involved in any operation must be valid;\n- The customer can only have one account (validate by CPF for example);\n- The account Id for future transactions must be included in the creation request response;\n- An extract should return all account movements (transfers, deposits and withdrawals);\n- It is not possible to make a transfer to yourself (the source account cannot be the same as the destination account);\n\n## Run the API locally\n\n### Premisses\n\n- Java JDK\n- Maven\n- Docker\n- Docker-Compose\n- PostgreSQL\n\nAfter installing the dependencies through the terminal in the project's root folder, execute the following command:\n\n```bash\nmvn clean install\n```\n\nThen type the instruction below to allocate the container with the database:\n\n```bash\ndocker-compose up\n```\n\nYou should now be able to start the application in the IDE. It will be possible to test the application at: ```localhost:8080/```\n\n## UML Diagram\n\n![UML](docs/UML-bank-api.png)\n\n### Services\n\n#### \"/client\"\n\nService | Http Method | Address | Parameters\n------------ | ------------  | ------------- | -------------\nNew Client Account | POST |localhost:8080/client/create | {\"name\": \"Guillaume Falourd\", \"cpf\": \"111.111.111-11\"}\nGet Client Account | GET |localhost:8080/client/{accountId} |\nUpdate Cliente Account | PUT | localhost:8080/client/update/{accountId} | {\"name\": \"Guillaume Falourd\", \"cpf\": \"111.111.111-11\"}\n\n#### \"/operation\"\n\nService | Http Method | Address | Parameters\n------------ | ------------ | ------------- | -------------\nBalance | GET | localhost:8080/operation/balance/{accountId} |\nDeposit | POST | localhost:8080/operation/deposit | {\"accountId\": 1,\"value\": 500}\nCashout | POST | localhost:8080/operation/cashout | {\"accountId\": 2,\"value\": 140}\nTransfer | POST | localhost:8080/operation/transfer | {\"depositAccountid\": 1, \"recipientAccountid\": 2, \"value\": 50.00}\nExtract | GET | localhost:8080/operation/accountStatement/{accountId} |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguillaumefalourd%2Fpoc-bank-api-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguillaumefalourd%2Fpoc-bank-api-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguillaumefalourd%2Fpoc-bank-api-java/lists"}