Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dmjio/stripe

:moneybag: Stripe API
https://github.com/dmjio/stripe

cheddar haskell money servant stripe stripe-api stripe-payments

Last synced: about 16 hours ago
JSON representation

:moneybag: Stripe API

Host: GitHub
URL: https://github.com/dmjio/stripe
Owner: dmjio
Created: 2014-04-25T18:50:35.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-03-16T04:21:00.000Z (10 months ago)
Last Synced: 2024-04-15T14:22:51.082Z (9 months ago)
Topics: cheddar, haskell, money, servant, stripe, stripe-api, stripe-payments
Language: Haskell
Homepage: http://hackage.haskell.org/package/stripe-haskell
Size: 729 KB
Stars: 175
Watchers: 17
Forks: 75
Open Issues: 24
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        stripe

========

[![Hackage](https://img.shields.io/hackage/v/stripe-haskell.svg)](https://hackage.haskell.org/package/stripe-haskell)

[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](https://haskell.org)

[![MIT LICENSE](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/dmjio/stripe/blob/master/stripe-haskell/LICENSE)

[![Join the chat at https://gitter.im/dmjio/stripe](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dmjio/stripe?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://travis-ci.org/dmjio/stripe.svg?branch=master)](https://travis-ci.org/dmjio/stripe)

## Stripe API coverage for Haskell ([Stripe API](http://stripe.com/docs/api))

All Stripe commands are supported, including but not limited to:

  - Charges

  - Refunds

  - Customers

  - Cards

  - Subscriptions

  - Plans

  - Coupons

  - Discounts

  - Invoices

  - Invoice Items

  - Disputes

  - Transfers

  - Recipients ([Deprecated](https://stripe.com/docs/connect/migrating))

  - Bitcoin

  - Application Fees

  - Application Fee Refunds

  - Account

  - Balance

  - Events and Tokens

## Haddock Coverage

  All code written for this library is documented to completion with the haddock documentation tool

## [100+ Hspec Tests](https://github.com/dmjio/stripe-haskell/blob/master/COVERAGE.md)

 Thoroughly unit-tested with hspec.

    All API commands are unit-tested before inclusion into the API (see the tests directory).

    To run the tests, perform the following:

```bash

cabal clean

cabal configure --enable-tests

cabal build tests

dist/build/tests/tests # You will be prompted to enter your *TEST* key

```

## [Pagination](https://stripe.com/docs/api#pagination)

  Pagination is possible on all API calls that return a JSON array.

  Any API call that returns a `StripeList` is eligible for pagination.

  To use in practice do the following:

```haskell

import Web.Stripe

import Web.Stripe.Customer

main :: IO ()

main = do

  let config = StripeConfig (StripeKey "secret key") Nothing

  result <- stripe config $ getCustomers

				(Just 30 :: Maybe Limit) -- Defaults to 10 if Nothing, 100 is Max

				(StartingAfter $ CustomerId "customer_id0")

				(EndingBefore $ CustomerId "customer_id30")

  case result of

    Right stripelist -> print (list stripelist :: [Customer])

    Left stripeError -> print stripeError

```

## [Optional Parameters](https://alexeyzabelin.com/haskell-api-wrapper)

   Stripe API calls can take multiple optional parameters.

  `stripe-haskell` supports optional parameters through the use of type-families and typeclasses.

   In practice, the function to use is `(-&-)` to specify optional parameters on a request.

   For a deeper dive into how this works, please see this [blog post](https://alexeyzabelin.com/haskell-api-wrapper).

```haskell

chargeCardByToken :: TokenId -> Currency -> Amount -> IO (Either StripeError Charge)

chargeCardByToken tokenId currency amount =

  stripe config $ createCharge amount currency

     -&- tokenId

```

## [Versioning](https://stripe.com/docs/api#versioning)

  All versioning is hard-coded (for safety) to version `2014-10-07`.

  Stripe API versions specified in the HTTP headers of Stripe requests take precedence

  over the API version specified in your Stripe Dashboard. In an attempt to ensure

  API consistency and correct parsing of returned JSON, all Stripe versions are hard-coded, and are

  inaccessible to the end-users of this library. When a new Stripe API version is released

  this library will increment the hard-coded API version.

## [Expansion](https://stripe.com/docs/api#expansion)

  Object expansion is supported on Stripe objects eligible for expansion though the `ExpandParams` type.

  Object expansion allows normal Stripe API calls to return expanded objects inside of other objects.

  For example, a `Customer` object contains a Card ID hash on the default_card field.

  This default_card hash can be expanded into a full `Card` object inside a `Customer` object.

  As an example:

```haskell

import Web.Stripe

import Web.Stripe.Customer

main :: IO ()

main = do

  let config = StripeConfig (StripeKey "secret key") Nothing

  result <- stripe config $ getCustomerExpandable

				   (CustomerId "customerid")

				   (["default_card"] :: ExpandParams)

  case result of

    Right customer -> print (defaultCard customer) -- Will be an `ExpandedCard`

    Left stripeError -> print stripeError

```

## [MetaData](https://stripe.com/docs/api#metadata)

  Stripe objects allow the embedding of arbitrary metadata.

  Any Stripe object that supports the embedding of metadata is available via this API.

  As an example:

```haskell

import Web.Stripe

import Web.Stripe.Coupon

main :: IO ()

main = do

  let config = StripeConfig (StripeKey "secret key") Nothing

  result <- stripe config $ updateCoupon (CouponId "couponid") [("key1", "value2"), ("key2", "value2")]

  case result of

    Right coupon -> print $ couponMetaData coupon

    Left stripeError -> print stripeError

```

## [Issues](https://github.com/dmjio/stripe-haskell/issues)

  Any API recommendations or bugs can be reported on the GitHub issue tracker.

  Pull requests welcome!

## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].



### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/haskell-stripe/contribute)]

#### Individuals



#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/haskell-stripe/contribute)]