| Copyright | (c) David Johnson, 2014 |
|---|---|
| Maintainer | djohnson.m@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
Web.Stripe.Charge
Description
https://stripe.com/docs/api#charges
{-# LANGUAGE OverloadedStrings #-}
import Web.Stripe
import Web.Stripe.Customer
import Web.Stripe.Charge
main :: IO ()
main = do
let config = StripeConfig (StripeKey "secret_key")
credit = CardNumber "4242424242424242"
em = ExpMonth 12
ey = ExpYear 2015
cvc = CVC "123"
cardinfo = (newCard credit em ey) { newCardCVC = Just cvc }
result <- stripe config createCustomer
-&- cardinfo
case result of
(Left stripeError) -> print stripeError
(Customer { customerId = cid }) ->
do result <- stripe config $ createCharge (Amount 100) USD
-&- cid
case result of
Left stripeError -> print stripeError
Right charge -> print charge
- data CreateCharge
- createCharge :: Amount -> Currency -> StripeRequest CreateCharge
- data GetCharge
- getCharge :: ChargeId -> StripeRequest GetCharge
- data GetCharges
- getCharges :: StripeRequest GetCharges
- data UpdateCharge
- updateCharge :: ChargeId -> StripeRequest UpdateCharge
- data CaptureCharge
- captureCharge :: ChargeId -> StripeRequest CaptureCharge
- newtype Amount = Amount {}
- newtype ApplicationFeeAmount = ApplicationFeeAmount Integer
- newtype CardNumber = CardNumber Text
- newtype Capture = Capture {
- getCapture :: Bool
- data Charge = Charge {
- 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 (Expandable TransactionId)
- chargeFailureMessage :: Maybe Text
- chargeFailureCode :: Maybe Text
- chargeAmountRefunded :: Int
- chargeCustomerId :: Maybe (Expandable CustomerId)
- chargeInvoice :: Maybe (Expandable InvoiceId)
- chargeDescription :: Maybe Description
- chargeDispute :: Maybe Dispute
- chargeMetaData :: MetaData
- chargeStatementDescription :: Maybe StatementDescription
- chargeReceiptEmail :: Maybe Text
- chargeReceiptNumber :: Maybe Text
- newtype ChargeId = ChargeId Text
- newtype Created = Created UTCTime
- data Currency
- = AED
- | AFN
- | ALL
- | AMD
- | ANG
- | AOA
- | ARS
- | AUD
- | AWG
- | AZN
- | BAM
- | BBD
- | BDT
- | BGN
- | BIF
- | BMD
- | BND
- | BOB
- | BRL
- | BSD
- | BWP
- | BZD
- | CAD
- | CDF
- | CHF
- | CLP
- | CNY
- | COP
- | CRC
- | CVE
- | CZK
- | DJF
- | DKK
- | DOP
- | DZD
- | EEK
- | EGP
- | ETB
- | EUR
- | FJD
- | FKP
- | GBP
- | GEL
- | GIP
- | GMD
- | GNF
- | GTQ
- | GYD
- | HKD
- | HNL
- | HRK
- | HTG
- | HUF
- | IDR
- | ILS
- | INR
- | ISK
- | JMD
- | JPY
- | KES
- | KGS
- | KHR
- | KMF
- | KRW
- | KYD
- | KZT
- | LAK
- | LBP
- | LKR
- | LRD
- | LSL
- | LTL
- | LVL
- | MAD
- | MDL
- | MGA
- | MKD
- | MNT
- | MOP
- | MRO
- | MUR
- | MVR
- | MWK
- | MXN
- | MYR
- | MZN
- | NAD
- | NGN
- | NIO
- | NOK
- | NPR
- | NZD
- | PAB
- | PEN
- | PGK
- | PHP
- | PKR
- | PLN
- | PYG
- | QAR
- | RON
- | RSD
- | RUB
- | RWF
- | SAR
- | SBD
- | SCR
- | SEK
- | SGD
- | SHP
- | SLL
- | SOS
- | SRD
- | STD
- | SVC
- | SZL
- | THB
- | TJS
- | TOP
- | TRY
- | TTD
- | TWD
- | TZS
- | UAH
- | UGX
- | USD
- | UYU
- | UZS
- | VND
- | VUV
- | WST
- | XAF
- | XCD
- | XOF
- | XPF
- | YER
- | ZAR
- | ZMW
- | UnknownCurrency
- newtype CustomerId = CustomerId Text
- data Customer
- = Customer {
- customerObject :: Text
- customerCreated :: UTCTime
- customerId :: CustomerId
- customerLiveMode :: Bool
- customerDescription :: Maybe Description
- customerEmail :: Maybe Email
- customerDelinquent :: Bool
- customerSubscriptions :: StripeList Subscription
- customerDiscount :: Maybe Discount
- customerAccountBalance :: Int
- customerCards :: StripeList Card
- customerCurrency :: Maybe Currency
- customerDefaultCard :: Maybe (Expandable CardId)
- customerMetaData :: MetaData
- | DeletedCustomer { }
- = Customer {
- newtype CVC = CVC Text
- newtype Description = Description Text
- newtype Email = Email Text
- newtype EndingBefore a = EndingBefore a
- newtype ExpandParams = ExpandParams {
- getExpandParams :: [Text]
- newtype ExpMonth = ExpMonth Int
- newtype ExpYear = ExpYear Int
- newtype Limit = Limit Int
- newtype MetaData = MetaData [(Text, Text)]
- data NewCard = NewCard {
- newCardCardNumber :: CardNumber
- newCardExpMonth :: ExpMonth
- newCardExpYear :: ExpYear
- newCardCVC :: Maybe CVC
- newCardName :: Maybe Name
- newCardAddressLine1 :: Maybe AddressLine1
- newCardAddressLine2 :: Maybe AddressLine2
- newCardAddressCity :: Maybe AddressCity
- newCardAddressZip :: Maybe AddressZip
- newCardAddressState :: Maybe AddressState
- newCardAddressCountry :: Maybe AddressCountry
- newtype ReceiptEmail = ReceiptEmail Text
- newtype StartingAfter a = StartingAfter a
- newtype StatementDescription = StatementDescription Text
- data StripeList a = StripeList {}
- newtype TokenId = TokenId Text
API
data CreateCharge Source
Instances
Arguments
| :: Amount |
|
| -> Currency |
|
| -> StripeRequest CreateCharge |
Create a Charge
Instances
Arguments
| :: ChargeId | The |
| -> StripeRequest GetCharge |
data GetCharges Source
Instances
getCharges :: StripeRequest GetCharges Source
Retrieve all Charges
data UpdateCharge Source
Arguments
| :: ChargeId | The |
| -> StripeRequest UpdateCharge |
A Charge to be updated
data CaptureCharge Source
Arguments
| :: ChargeId | |
| -> StripeRequest CaptureCharge |
a Charge to be captured
Types
Amount representing a monetary value. Stripe represents pennies as whole numbers i.e. 100 = $1
Instances
Capture for Charge
Constructors
| Capture | |
Fields
| |
Charge object in Stripe API
Constructors
Instances
Instances
Stripe supports 138 currencies
Constructors
| AED | United Arab Emirates Dirham |
| AFN | Afghan Afghani |
| ALL | Albanian Lek |
| AMD | Armenian Dram |
| ANG | Netherlands Antillean Gulden |
| AOA | Angolan Kwanza |
| ARS | Argentine Peso |
| AUD | Australian Dollar |
| AWG | Aruban Florin |
| AZN | Azerbaijani Manat |
| BAM | Bosnia & Herzegovina Convertible Mark |
| BBD | Barbadian Dollar |
| BDT | Bangladeshi Taka |
| BGN | Bulgarian Lev |
| BIF | Burundian Franc |
| BMD | Bermudian Dollar |
| BND | Brunei Dollar |
| BOB | Bolivian Boliviano |
| BRL | Brazilian Real |
| BSD | Bahamian Dollar |
| BWP | Botswana Pula |
| BZD | Belize Dollar |
| CAD | Canadian Dollar |
| CDF | Congolese Franc |
| CHF | Swiss Franc |
| CLP | Chilean Peso |
| CNY | Chinese Renminbi Yuan |
| COP | Colombian Peso |
| CRC | Costa Rican Colón |
| CVE | Cape Verdean Escudo |
| CZK | Czech Koruna |
| DJF | Djiboutian Franc |
| DKK | Danish Krone |
| DOP | Dominican Peso |
| DZD | Algerian Dinar |
| EEK | Estonian Kroon |
| EGP | Egyptian Pound |
| ETB | Ethiopian Birr |
| EUR | Euro |
| FJD | Fijian Dollar |
| FKP | Falkland Islands Pound |
| GBP | British Pound |
| GEL | Georgian Lari |
| GIP | Gibraltar Pound |
| GMD | Gambian Dalasi |
| GNF | Guinean Franc |
| GTQ | Guatemalan Quetzal |
| GYD | Guyanese Dollar |
| HKD | Hong Kong Dollar |
| HNL | Honduran Lempira |
| HRK | Croatian Kuna |
| HTG | Haitian Gourde |
| HUF | Hungarian Forint |
| IDR | Indonesian Rupiah |
| ILS | Israeli New Sheqel |
| INR | Indian Rupee |
| ISK | Icelandic Króna |
| JMD | Jamaican Dollar |
| JPY | Japanese Yen |
| KES | Kenyan Shilling |
| KGS | Kyrgyzstani Som |
| KHR | Cambodian Riel |
| KMF | Comorian Franc |
| KRW | South Korean Won |
| KYD | Cayman Islands Dollar |
| KZT | Kazakhstani Tenge |
| LAK | Lao Kip |
| LBP | Lebanese Pound |
| LKR | Sri Lankan Rupee |
| LRD | Liberian Dollar |
| LSL | Lesotho Loti |
| LTL | Lithuanian Litas |
| LVL | Latvian Lats |
| MAD | Moroccan Dirham |
| MDL | Moldovan Leu |
| MGA | Malagasy Ariary |
| MKD | Macedonian Denar |
| MNT | Mongolian Tögrög |
| MOP | Macanese Pataca |
| MRO | Mauritanian Ouguiya |
| MUR | Mauritian Rupee |
| MVR | Maldivian Rufiyaa |
| MWK | Malawian Kwacha |
| MXN | Mexican Peso |
| MYR | Malaysian Ringgit |
| MZN | Mozambican Metical |
| NAD | Namibian Dollar |
| NGN | Nigerian Naira |
| NIO | Nicaraguan Córdoba |
| NOK | Norwegian Krone |
| NPR | Nepalese Rupee |
| NZD | New Zealand Dollar |
| PAB | Panamanian Balboa |
| PEN | Peruvian Nuevo Sol |
| PGK | Papua New Guinean Kina |
| PHP | Philippine Peso |
| PKR | Pakistani Rupee |
| PLN | Polish Złoty |
| PYG | Paraguayan Guaraní |
| QAR | Qatari Riyal |
| RON | Romanian Leu |
| RSD | Serbian Dinar |
| RUB | Russian Ruble |
| RWF | Rwandan Franc |
| SAR | Saudi Riyal |
| SBD | Solomon Islands Dollar |
| SCR | Seychellois Rupee |
| SEK | Swedish Krona |
| SGD | Singapore Dollar |
| SHP | Saint Helenian Pound |
| SLL | Sierra Leonean Leone |
| SOS | Somali Shilling |
| SRD | Surinamese Dollar |
| STD | São Tomé and Príncipe Dobra |
| SVC | Salvadoran Colón |
| SZL | Swazi Lilangeni |
| THB | Thai Baht |
| TJS | Tajikistani Somoni |
| TOP | Tongan Paʻanga |
| TRY | Turkish Lira |
| TTD | Trinidad and Tobago Dollar |
| TWD | New Taiwan Dollar |
| TZS | Tanzanian Shilling |
| UAH | Ukrainian Hryvnia |
| UGX | Ugandan Shilling |
| USD | United States Dollar |
| UYU | Uruguayan Peso |
| UZS | Uzbekistani Som |
| VND | Vietnamese Đồng |
| VUV | Vanuatu Vatu |
| WST | Samoan Tala |
| XAF | Central African Cfa Franc |
| XCD | East Caribbean Dollar |
| XOF | West African Cfa Franc |
| XPF | Cfp Franc |
| YER | Yemeni Rial |
| ZAR | South African Rand |
| ZMW | Zambian Kwacha |
| UnknownCurrency | Unknown Currency |
newtype CustomerId Source
CustomerId for a Customer
Constructors
| CustomerId Text |
Instances
Customer object
Constructors
CVC for a Card
newtype Description Source
Generic Description for use in constructing API Calls
Constructors
| Description Text |
Instances
newtype EndingBefore a Source
Pagination Option for StripeList
Constructors
| EndingBefore a |
Instances
newtype ExpandParams Source
Type of Expansion Parameters for use on Stripe objects
Constructors
| ExpandParams | |
Fields
| |
Instances
Expiration Month for a Card
Expiration Year for a Card
Pagination Option for StripeList
Instances
Type of MetaData for use on Stripe objects
Instances
Constructors
Instances
newtype StartingAfter a Source
Pagination Option for StripeList
Constructors
| StartingAfter a |
Instances
newtype StatementDescription Source
StatementDescription to be added to a Charge
Constructors
| StatementDescription Text |
Instances
data StripeList a Source
Generic handling of Stripe JSON arrays
Constructors
| StripeList | |
Instances
| Eq a => Eq (StripeList a) Source | |
| Data a => Data (StripeList a) Source | |
| Ord a => Ord (StripeList a) Source | |
| Read a => Read (StripeList a) Source | |
| Show a => Show (StripeList a) Source | |
| FromJSON a => FromJSON (StripeList a) Source | JSON Instance for |
Instances