Web.Stripe.Charge

Synopsis

Documentation

Represents a charge in the Stripe system.

Constructors

Charge
Fields chargeId :: ChargeId chargeCreated :: UTCTime chargeDescription :: Maybe Description chargeCurrency :: Currency chargeAmount :: Amount chargeFee :: Int chargeLive :: Bool chargePaid :: Bool chargeRefunded :: Bool chargeCard :: Card

Instances

Show Charge
JSON Charge	Attempts to parse JSON into a `Charge`.

newtype ChargeId Source

Represents the identifier for a given Charge in the Stripe system.

Constructors

ChargeId
Fields unChargeId :: String

Instances

Show ChargeId

chargeToken :: MonadIO m => Token -> Amount -> Currency -> Maybe Description -> StripeT m Charge Source

Submit a Charge to the Stripe API using an already constructed Token.

chargeTokenById :: MonadIO m => TokenId -> Amount -> Currency -> Maybe Description -> StripeT m Charge Source

Submit a Charge to the Stripe API using a TokenId.

chargeCustomer :: MonadIO m => Customer -> Amount -> Currency -> Maybe Description -> StripeT m Charge Source

Submit a Charge to the Stripe for a specific Customer that already has payment details on file.

chargeCustomerById :: MonadIO m => CustomerId -> Amount -> Currency -> Maybe Description -> StripeT m Charge Source

Submit a Charge to the Stripe for a specific Customer, identified by its CustomerId, that already has payment details on file.

chargeRCard :: MonadIO m => RequestCard -> Amount -> Currency -> Maybe Description -> StripeT m Charge Source

Submit a Charge to the Stripe API using a RequestCard to describe payment details.

getCharge :: MonadIO m => ChargeId -> StripeT m Charge Source

Retrieve a Charge from the Stripe API, identified by ChargeId.

getCharges :: MonadIO m => Maybe CustomerId -> Maybe Count -> Maybe Offset -> StripeT m [Charge]Source

Retrieve a list of Charges from the Stripe API. The query can optionally be refined to a specific:

number of charges, via Count, * page of results, via Offset, and * Customer.

partialRefund :: MonadIO m => Charge -> Amount -> StripeT m Charge Source

Requests that Stripe issue a partial refund to a specific Charge for a particular Amount.

partialRefundById :: MonadIO m => ChargeId -> Amount -> StripeT m Charge Source

Requests that Stripe issue a partial refund to a specific Charge, identified by ChargeId, for a particular Amount.

fullRefund :: MonadIO m => Charge -> StripeT m Charge Source

Requests that Stripe issue a full refund to a specific Charge.

fullRefundById :: MonadIO m => ChargeId -> StripeT m Charge Source

Requests that Stripe issue a full refund to a specific Charge, identified by ChargeId.

newtype Amount Source

Represents an amount in cents in the Stripe system.

Constructors

Amount
Fields unAmount :: Int

Instances

Show Amount

newtype Count Source

A maximum number of objects that the Stripe API will return. This value should be between 1 and 100, inclusive.

Constructors

Count
Fields unCount :: Int

Instances

Show Count

newtype Currency Source

Represents a currency (e.g., usd) in the Stripe system. This is a 3-letter ISO code.

Constructors

Currency
Fields unCurrency :: String

Instances

Show Currency

newtype Description Source

Describes an object in the Stripe system.

Constructors

Description
Fields unDescription :: String

Instances

Show Description

newtype Offset Source

A positive integer that is an offset into the array of objects returned by the Stripe API.

Constructors

Offset
Fields unOffset :: Int

Instances

Show Offset

data UTCTime

This is the simplest representation of UTC. It consists of the day number, and a time offset from midnight. Note that if a day has a leap second added to it, it will have 86401 seconds.

Constructors

UTCTime
Fields utctDay :: Day the day utctDayTime :: DiffTime the time from midnight, 0 <= t < 86401s (because of leap-seconds)

Instances

Eq UTCTime
Data UTCTime
Ord UTCTime
Read UTCTime
Show UTCTime
Typeable UTCTime
FormatTime UTCTime
ParseTime UTCTime

data SConfig Source

Configuration for the StripeT monad transformer.

Constructors

SConfig
Fields key :: APIKey caFile :: FilePath

Instances

Show SConfig
Monad m => MonadState SConfig (StripeT m)

newtype StripeT m a Source

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

Constructors

StripeT (StateT SConfig (ErrorT SFailure m) a)

Instances

Monad m => MonadError SFailure (StripeT m)
Monad m => MonadState SConfig (StripeT m)
Monad m => Monad (StripeT m)
Functor m => Functor (StripeT m)
Monad m => MonadPlus (StripeT m)
MonadIO m => MonadIO (StripeT m)

runStripeT :: MonadIO m => SConfig -> StripeT m a -> m (Either SFailure a)Source

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.