Web.Stripe.Refund

https://stripe.com/docs/api#refunds

import Web.Stripe         
import Web.Stripe.Customer
import Web.Stripe.Charge
import Web.Stripe.Refund

main :: IO ()
main = do
  let config = SecretKey "secret_key"
      credit = CardNumber "4242424242424242"
      em  = ExpMonth 12
      ey  = ExpYear 2015
      cvc = CVC "123"
  result <- stripe config $ do
    Customer { customerId = cid }  <- createCustomerByCard cn em ey cvc
    Charge   { chargeId   = chid } <- chargeCustomer cid USD 100 Nothing
    createRefund chid ([] :: MetaData)
  case result of
    Right refund     -> print refund
    Left stripeError -> print stripeError

API

createRefund

Arguments

:: ChargeId

ChargeId associated with the Charge to be refunded

-> MetaData

MetaData associated with a Refund

-> Stripe Refund

Refund a Charge

getRefund

Arguments

:: ChargeId

ChargeId associated with the Refund to be retrieved

-> RefundId

RefundId associated with the Refund to be retrieved

-> Stripe Refund

Retrieve a Refund by ChargeId and RefundId

getRefundExpandable

Arguments

:: ChargeId

ChargeId associated with the Charge to be retrieved

-> RefundId

RefundId associated with the Refund to be retrieved

-> ExpandParams

ExpandParams of object for expansion

-> Stripe Refund

Retrieve a Refund by ChargeId and RefundId with ExpandParams

getRefunds

Arguments

:: ChargeId

ChargeId associated with the Charge to be updated

-> Limit

Defaults to 10 if Nothing specified

-> StartingAfter RefundId

Paginate starting after the following RefundId

-> EndingBefore RefundId

Paginate ending before the following RefundId

-> Stripe (StripeList Refund)

Retrieve a lot of Refunds by ChargeId

getRefundsExpandable

Arguments

:: ChargeId

ChargeId associated with the Charge to be updated

-> Limit

Defaults to 10 if Nothing specified

-> StartingAfter RefundId

Paginate starting after the following RefundId

-> EndingBefore RefundId

Paginate ending before the following RefundId

-> ExpandParams

MetaData associated with a Refund

-> Stripe (StripeList Refund)

Retrieve a lot of Refunds by ChargeId with ExpandParams

updateRefund

Arguments

:: ChargeId

ChargeId associated with the Charge to be updated

-> RefundId

RefundId associated with the Refund to be retrieved

-> MetaData

MetaData associated with a Refund

-> Stripe Refund

Update a Refund by ChargeId and RefundId

Types

data Refund

Refund Object

Constructors

Refund

Fields

refundId :: RefundId

refundAmount :: Int

refundCurrency :: Currency

refundCreated :: UTCTime

refundObject :: Text

refundCharge :: ChargeId

refundBalanceTransaction :: TransactionId

refundMetaData :: MetaData

Instances

Eq Refund

Show Refund

FromJSON Refund

JSON Instance for Refund

newtype RefundId

RefundId for Refund

Constructors

RefundId Text

Instances

Eq RefundId

Show RefundId

data ChargeId

ChargeId associated with a Charge

Constructors

ChargeId Text

ExpandedCharge Charge

Instances

Eq ChargeId

Show ChargeId

FromJSON ChargeId

JSON Instance for ChargeId

data Charge

Charge object in Stripe API

Constructors

Charge

Fields

chargeId :: ChargeId

chargeObject :: Text

chargeCreated :: UTCTime

chargeLiveMode :: Bool

chargePaid :: Bool

chargeAmount :: Int

chargeCurrency :: Currency

chargeRefunded :: Bool

chargeCreditCard :: Card

chargeCaptured :: Bool

chargeRefunds :: StripeList Refund

chargeBalanceTransaction :: Maybe TransactionId

chargeFailureMessage :: Maybe Text

chargeFailureCode :: Maybe Text

chargeAmountRefunded :: Int

chargeCustomerId :: Maybe CustomerId

chargeInvoice :: Maybe InvoiceId

chargeDescription :: Maybe Description

chargeDispute :: Maybe Dispute

chargeMetaData :: MetaData

chargeStatementDescription :: Maybe Description

chargeReceiptEmail :: Maybe Text

chargeReceiptNumber :: Maybe Text

Instances

Eq Charge

Show Charge

FromJSON Charge

JSON Instance for Charge

data StripeList a

Generic handling of Stripe JSON arrays

Constructors

StripeList

Fields

list :: [a]

stripeUrl :: Text

object :: Text

totalCount :: Maybe Int

hasMore :: Bool

Instances

Eq a => Eq (StripeList a)

Show a => Show (StripeList a)

FromJSON a => FromJSON (StripeList a)

JSON Instance for StripeList