Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up the README #4

Merged
merged 6 commits into from
Aug 17, 2012
Merged

Clean up the README #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f2a53c6
fix some typos
chadwhitacre Aug 17, 2012
841921c
wrap at 80 chars to make diffs more meaningful
chadwhitacre Aug 17, 2012
4c016dc
Prune unnecessary regret
chadwhitacre Aug 17, 2012
0add28b
Add .md extension so GitHub parses as Markdown
chadwhitacre Aug 17, 2012
8a7275c
Oops. Prune old README now that there's README.md
chadwhitacre Aug 17, 2012
43b0af9
Add links back to Balanced
chadwhitacre Aug 17, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions README
View file
Open in desktop

This file was deleted.

36 changes: 36 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Balanced API Spec
=================

Online marketplaces enable a new form of commerce at a scale that has never
existed before. The success of online marketplaces has the potential to
materially effect the global economy by creating new jobs and economic activity
that previously did not exist. Airbnb, Kickstarter, Etsy, and other
marketplaces have created new forms of income for businesses and individuals.
That's what gets the [Balanced](https://www.balancedpayments.com/) team excited
and what the [Balanced API](https://www.balancedpayments.com/docs/integration)
hopes to support.

Payments for marketplaces is unfortunately painful because of unique
requirements including paying sellers, payments aggregation policies, tax
ramifications, and fraud. Balanced lets you charge cards, escrow funds, and pay
sellers the next business day without the pain of building a payments system.

The primary goal of this repo is to create more openness behind the decisions
driving the designs and functionality of the Balanced API. We reached out to
existing and potential customers when designing the API, but that was a limited
set of people we already knew. We've received tremendous growth in the last few
months, and our new customers have great feedback or at least want to
understand the reasoning behind the original decisions.

We're going to automate validation of our API code against the specifications
in the repo. Any changes to the API can't be deployed unless they've been
merged into master first. Any merge to master will happen concurrently with
deploys of the API and the [docs](https://www.balancedpayments.com/docs). That
means the specs need to be auto generated (except for comments) instead of
handwritten to make sure the code and specs can never go out of sync.

We'll do our best to have even internal discussions online. All changes (even
by the Balanced team) to the specs must be submitted via pull request and can
only be merged in by @matin after giving the community a chance to comment on
the changes.