Breakups/README.md

Breakups

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

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	standard ／ email	standard ／ email
POST	/paymentChain	standard ／ email	chain
POST	/perPerson	standard ／ email	{ "perPerson": 30 }
POST	/sortedOweChart	standard ／ email	standard ／ email

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"
}