Documentation

Configuration for the StripeT monad transformer.

A key used when authenticating to the Stripe API.

This represents the possible successes that a connection to the Stripe API can encounter. For specificity, a success can be represented by other error codes, and so the same is true in this data type.

Please consult the official Stripe REST API documentation on error codes at https://stripe.com/docs/api#errors for more information.

This represents the possible failures that a connection to the Stripe API can encounter.

Please consult the official Stripe REST API documentation on error codes at https://stripe.com/docs/api#errors for more information.

Describes a SFailure in more detail, categorizing the error and providing additional information about it. At minimum, this is a message, and for CardError, this is a message, even more precise code (SErrorCode), and potentially a paramter that helps suggest where an error message should be displayed.

In case the appropriate error could not be determined from the specified type, UnkownError will be returned with the supplied type and message.

Please consult the official Stripe REST API documentation on error codes at https://stripe.com/docs/api#errors for more information.

Attempts to describe a CardError in more detail, classifying in what specific way it failed.

Please consult the official Stripe REST API documentation on error codes at https://stripe.com/docs/api#errors for more information.

Represents a request to the Stripe API, providing the fields necessary to specify a Stripe resource. More generally, baseSReq will be desired as it provides sensible defaults that can be overriden as needed.

A convenience specialization of the StripeT monad transformer in which the underlying monad is IO.

Defines the monad transformer under which all Stripe REST API resource calls take place.

Provides a default SConfig. Essentially, this inserts the APIKey, but leaves other fields blank. This is especially relavent due to the current CA file check bug.

Runs the StripeT monad transformer with a given SConfig. This will handle all of the authorization dance steps necessary to utilize the Stripe API.

Its use is demonstrated in other functions, such as query.

The basic SRequest environment upon which all other Stripe API requests will be built. Standard usage involves overriding one or more of the fields. E.g., for a request to "https:api.stripe.comv1coupons", one would have:

 baseSReq { sDestinaton = ["charges"] }

Queries the Stripe API and attempts to parse the results into a data type that is an instance of JSON. This is primarily for internal use by other Stripe submodules, which supply the request values accordingly. However, it can also be used directly. E.g.,

 let conf = SConfig "key" "CA file"

 runStripeT conf $
    query baseSReq { sDestination = ["charges"] }

Acts just like query, but on success, throws away the response. Errors contacting the Stripe API will still be reported.

HTTP standard method (as defined by RFC 2616).