An open API service indexing awesome lists of open source software.

https://github.com/sammers21/money-transfer-api

Simple RESTful API for money transfers between users
https://github.com/sammers21/money-transfer-api

java money restful-api transfer vertx

Last synced: 24 days ago
JSON representation

Simple RESTful API for money transfers between users

Awesome Lists containing this project

README

        

# money-transfer-api

[![Build Status](https://travis-ci.org/Sammers21/money-transfer-api.svg?branch=master)](https://travis-ci.org/Sammers21/money-transfer-api)

## Design

This app has 4 endpoints:

1. `GET /user/` - get user information by nick
2. `GET /user//withdraw?sum=` - withdraw any sum of money
3. `GET /user//contribute?sum=` - contribute any sum of money
4. `GET/user//transfer?sum=&to=` - transfer money between users

It is also assumed that:
* there is no currencies, exchange rates, transactions, only abstract sums of money
* each user is an account itself

## Builing & Running

Building jar with all dependecies:
```bash
./gradlew jar
```

Standalone executable jar can be found at _build/libs/money-transfer-api.jar_.
So you can run this jar:
```
java -jar build/libs/money-transfer-api.jar
```

The app will be listening on port 8080.