You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
BinHong Lee fdce9f3b9f Forgotten change for deployment 7 years ago
.gitignore Basic functionality now works 7 years ago
README.md Added paymentNetwork, it also skips all users with +-0 7 years ago
_config.yml Set theme jekyll-theme-slate 7 years ago
index.js Forgotten change for deployment 7 years ago
package.json Added emailPaymentChain 7 years ago

README.md

Breakups

Creating a payment chain for bill splitting needs. Try it out now!

Dependency Status

api domain: https://breakups.herokuapp.com/

API Call Documentations

Type Call Request Response
GET / - redirects to documentation page
GET /help - redirects to github repository
GET /webapp - redirects to the webapp
POST /emailPaymentChain email ["Email sent to user1@domain.com", "Email sent to user2@domain.com"]
POST /total standard / email { "total": 200 }
POST /oweChart standardemail standardemail
POST /paymentChain standardemail chain
POST /perPerson standardemail { "perPerson": 30 }
POST /sortedOweChart standardemail standardemail

Expected Request / Response

standard

{
  "users": [
    {
      "name": "Person1",
      "amount": 100
    },
    {
      "name": "Person2",
      "amount": 50
    },
    {
      "name": "Person3",
      "amount": 30
    }
  ]
}

chain

[
  {
    "from": "Person2",
    "to": "Person3",
    "amount": 10
  },
  {
    "from": "Person3",
    "to": "Person1",
    "amount": 40
  }
]

email

{
  "users": [
    {
      "name": "Person1",
      "email": "person1@domain.com",
      "amount": 100
    },
    {
      "name": "Person2",
      "email": "person2@domain.com",
      "amount": 50
    },
    {
      "name": "Person3",
      "email": "person3@domain.com",
      "amount": 30
    }
  ],
  "mixmax-api": "your-mixmax-api-key"
}