Permalink
Browse files

Added documentation for the error object.

  • Loading branch information...
1 parent 9f3c9b6 commit c6ebd90700f7f8e785e4a873e0db50c8eedbf1b4 @BusyRich BusyRich committed Mar 12, 2013
Showing with 11 additions and 0 deletions.
  1. +11 −0 README.md
View
@@ -71,6 +71,17 @@ called with a Javascript `Error` (if any) and then the response.
* `.retrieve(id)` - [retrieve an event](https://stripe.com/docs/api#retrieve_event)
* `.list()` - [list all events](https://stripe.com/docs/api#list_events)
+## Errors
+
+Errors returned take the following format. [Stripe Errors](https://stripe.com/docs/api#errors)
+
+ {
+ name: "Stripe error type",
+ code: "Stripe error code",
+ param: "Stripe error param",
+ message: "Stripe error message"
+ }
+
## TODO
See the [issue tracker](http://github.com/abh/node-stripe).

0 comments on commit c6ebd90

Please sign in to comment.