Copyright	(c) David Johnson, 2014
Maintainer	djohnson.m@gmail.com
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Web.Stripe.Recipient

Contents

API
Types

Description

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

import Web.Stripe         
import Web.Stripe.Recipient

main :: IO ()
main = do
  let config = SecretKey "secret_key"
  result <- stripe config $ 
      createRecipient (FirstName "simon")
                      (LastName "marlow")
                      Nothing -- what is Simon Marlow's middle initial?
                      (Invidiual :: RecipientType)
  case result of
    Right recipient  -> print recipient
    Left stripeError -> print stripeError

Synopsis

API

createRecipient Source

Arguments

:: FirstName	First Name of `Recipient`
-> LastName	Last Name of `Recipient`
-> Maybe MiddleInitial	Middle Initial of `Recipient`
-> RecipientType	`Individual` or `Corporation`
-> Stripe Recipient

Create a Recipient

createRecipientByCard Source

Arguments

:: FirstName	First Name of `Recipient`
-> LastName	Last Name of `Recipient`
-> Maybe MiddleInitial	Middle Initial of `Recipient`
-> RecipientType	`Individual` or `Corporation`
-> CardNumber	`Card` Number
-> ExpMonth	Expiration Month
-> ExpYear	Expiration Year
-> CVC	`CVC` (i.e. 117)
-> Stripe Recipient

Create a Recipient by a Card

createRecipientByToken Source

Arguments

:: FirstName	First Name of `Recipient`
-> LastName	Last Name of `Recipient`
-> Maybe MiddleInitial	Middle Initial of `Recipient`
-> RecipientType	`Individual` or `Corporation`
-> TokenId	`TokenId` received from stripe.js or Token API
-> Stripe Recipient

Create a Recipient by specifying a TokenId

createRecipientByBank Source

Arguments

:: FirstName	First Name of `Recipient`
-> LastName	Last Name of `Recipient`
-> Maybe MiddleInitial	Middle Initial of `Recipient`
-> RecipientType	`Individual` or `Corporation`
-> Country	`Country` of BankAccount to attach to `Recipient`
-> RoutingNumber	`RoutingNumber` of BankAccount to attach to `Recipient`
-> AccountNumber	`AccountNumber` of BankAccount to attach to `Recipient`
-> Stripe Recipient

Create a Recipient with a BankAccount

createRecipientBase Source

Arguments

:: FirstName	First Name of `Recipient`
-> LastName	Last Name of `Recipient`
-> Maybe MiddleInitial	Middle Initial of `Recipient`
-> RecipientType	`Individual` or `Corporation`
-> Maybe TaxID	SSN for `Individual`, EIN for `Corporation`
-> Maybe Country	`Country` of BankAccount to attach to `Recipient`
-> Maybe RoutingNumber	`RoutingNumber` of BankAccount to attach to `Recipient`
-> Maybe AccountNumber	`AccountNumber` of BankAccount to attach to `Recipient`
-> Maybe TokenId	`TokenId` of `Card` or `BankAccount` to attach to a `Recipient`
-> Maybe CardNumber	`CardNumber` to attach to `Card` of `Recipient`
-> Maybe ExpMonth	Expiration Month of `Card`
-> Maybe ExpYear	Expiration Year of `Card`
-> Maybe CVC	CVC of Card
-> Maybe Email	Create `Email` with `Recipient`
-> Maybe Description	Create `Description` with `Recipient`
-> MetaData	The `MetaData` associated with the `Recipient`
-> Stripe Recipient

Base Request for issues create Recipient requests

getRecipient Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be retrieved
-> Stripe Recipient

Retrieve a Recipient

getRecipientExpandable Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be retrieved
-> ExpandParams	`ExpandParams` of the object to be expanded
-> Stripe Recipient

Retrieve a Recipient

getRecipients Source

Arguments

:: Limit	Defaults to 10 if `Nothing` specified
-> StartingAfter RecipientId	Paginate starting after the following `RecipientId`
-> EndingBefore RecipientId	Paginate ending before the following `RecipientId`
-> Stripe (StripeList Recipient)

Retrieve multiple Recipients

getRecipientsExpandable Source

Arguments

:: Limit	Defaults to 10 if `Nothing` specified
-> StartingAfter RecipientId	Paginate starting after the following `RecipientId`
-> EndingBefore RecipientId	Paginate ending before the following `RecipientId`
-> ExpandParams	`ExpandParams` of the object to be expanded
-> Stripe (StripeList Recipient)

Retrieve multiple Recipients with ExpandParams

updateRecipientName Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be updated
-> FirstName	First Name of `Recipient`
-> LastName	Last Name of `Recipient`
-> MiddleInitial	Middle Initial of `Recipient`
-> Stripe Recipient

Update a Recipient FirstName, LastName and/or MiddleInitial

updateRecipientTaxID Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be updated
-> TaxID	`TaxID` of `Recipient` to be updated
-> Stripe Recipient

Update a Recipient TaxID

runStripe config $ updateRecipientTaxID (RecipientId "rp_4lpjaLFB5ecSks") "SampleTaxID"

updateRecipientBankAccount Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be updated
-> Country	`Country` of BankAccount to attach to `Recipient`
-> RoutingNumber	`RoutingNumber` of BankAccount to attach to `Recipient`
-> AccountNumber	`AccountNumber` of BankAccount to attach to `Recipient`
-> Stripe Recipient

Update a Recipient BankAccount

runStripe config $ updateRecipient (RecipientId "rp_4lpjaLFB5ecSks") BankAccount {
    bankAccountCountry = Country "us"
  , bankAccountRoutingNumber = RoutingNumber "071000013"
  , bankAccountNumber = AccountNumber "293058719045"
 }

updateRecipientTokenID Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be updated
-> TokenId	`TaxID` of `Recipient` to be updated
-> Stripe Recipient

Update a Recipient Card by TokenId

runStripe config $ updateRecipientTokenId (RecipientId "rp_4lpjaLFB5ecSks") (TokenId "tok_aksdjfh9823")

updateRecipientDefaultCard Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be updated
-> CardId	`CardId` of `Card` to be made default
-> Stripe Recipient

Update a Recipient Card

runStripe config $ updateRecipientCard (RecipientId "rp_4lpjaLFB5ecSks") number month year cvc
  where
    number = CardNumber "4242424242424242"
    month  = ExpMonth 12
    year   = ExpYear 2018
    cvc    = 117

updateRecipientDefaultCard :: RecipientId -- ^ The RecipientId of the Recipient to be updated -> CardNumber -- ^ CardNumber to attach to Card of Recipient -> ExpMonth -- ^ Expiration Month of Card -> ExpYear -- ^ Expiration Year of Card -> CVC -- ^ CVC of Card -> Stripe Recipient updateRecipientCard recipientid cardNumber expMonth expYear cvc = updateRecipientBase recipientid Nothing Nothing Nothing Nothing Nothing Nothing Nothing Nothing (Just cardNumber) (Just expMonth) (Just expYear) (Just cvc) Nothing Nothing Nothing []

Update default Card of Recipient

runStripe config $ updateRecipientDefaultCard (RecipientId "rp_4lpjaLFB5ecSks") (CardId "card_4jQs35jE5wFOor")

updateRecipientEmail Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be updated
-> Email	`Email` of `Recipient` to be updated
-> Stripe Recipient

Update a Recipient Email Address

runStripe config $ updateRecipientEmail (RecipientId "rp_4lpjaLFB5ecSks") (Email "name@domain.com")

updateRecipientDescription Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be updated
-> Description	`Description` of `Recipient` to be updated
-> Stripe Recipient

Update a Recipient Description

runStripe config $ updateRecipientDescription (RecipientId "rp_4lpjaLFB5ecSks") (Email "name@domain.com")

updateRecipientMetaData Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be updated
-> MetaData	The `MetaData` associated with the `Recipient`
-> Stripe Recipient

Update a Recipient MetaData

runStripe config $ updateRecipientMetaData (RecipientId "rp_4lpjaLFB5ecSks") [("key", "value")]

updateRecipientBase Source

Arguments

:: RecipientId	The `RecipientId` of the `Recipient` to be updated
-> Maybe FirstName	First Name of `Recipient`
-> Maybe LastName	Last Name of `Recipient`
-> Maybe MiddleInitial	Middle Initial of `Recipient`
-> Maybe TaxID	SSN for `Individual`, EIN for `Corporation`
-> Maybe Country	`Country` of BankAccount to attach to `Recipient`
-> Maybe RoutingNumber	`RoutingNumber` of BankAccount to attach to `Recipient`
-> Maybe AccountNumber	`AccountNumber` of BankAccount to attach to `Recipient`
-> Maybe TokenId	`TokenId` of `Card` to attach to a `Recipient`
-> Maybe CardNumber	`CardNumber` to attach to `Card` of `Recipient`
-> Maybe ExpMonth	Expiration Month of `Card`
-> Maybe ExpYear	Expiration Year of `Card`
-> Maybe CVC	CVC of Card
-> Maybe CardId	The Default `Card` for this `Recipient` to use
-> Maybe Email	Create `Email` with `Recipient`
-> Maybe Description	Create `Description` with `Recipient`
-> MetaData	The `MetaData` associated with the `Recipient`
-> Stripe Recipient

Base Request for updating a Recipient, useful for creating custom Recipient update functions

deleteRecipient Source

Arguments

:: RecipientId	`RecipiendId` of `Recipient` to delete
-> Stripe StripeDeleteResult

Delete a Recipient

>>> runStripe config $ deleteRecipient (RecipientId "rp_4lpjaLFB5ecSks")

Types

data Recipient Source

Recipient Object

Constructors

Recipient
Fields recipientId :: RecipientId recipientObject :: Text recipientCreated :: UTCTime recipientLiveMode :: Bool recipientType :: RecipientType recipientDescription :: Maybe Description recipientEmail :: Maybe Email recipientName :: Name recipientVerified :: Bool recipientActiveAccount :: Maybe BankAccount recipientCards :: StripeList RecipientCard recipientDefaultCard :: Maybe RecipientCardId
DeletedRecipient
Fields deletedRecipient :: Maybe Bool deletedRecipientId :: RecipientId

Instances

Eq Recipient
Show Recipient
FromJSON Recipient	JSON Instance for `Recipient`

data RecipientId Source

RecipientId for a Recipient

Constructors

RecipientId Text
ExpandedRecipient Recipient

Instances

Eq RecipientId
Show RecipientId
FromJSON RecipientId	JSON Instance for `RecipientId`

newtype FirstName Source

Recipients

FirstName of a Recipient

Constructors

FirstName Text

Instances

Eq FirstName
Show FirstName

newtype LastName Source

LastName of a Recipient

Constructors

LastName Text

Instances

Eq LastName
Show LastName

type MiddleInitial = Char Source

Middle Initial of a Recipient

data RecipientType Source

Type of Recipient

Constructors

Individual
Corporation

Instances

Eq RecipientType
Show RecipientType	`Show` instance for `RecipientType`
FromJSON RecipientType	JSON Instance for `RecipientType`

type TaxID = Text Source

TaxID of Recipient

data BankAccount Source

BankAccount Object

Constructors

BankAccount
Fields bankAccountId :: BankAccountId bankAccountObject :: Text bankAccountLast4 :: Text bankAccountCountry :: Country bankAccountCurrency :: Currency bankAccountStatus :: Maybe BankAccountStatus bankAccountFingerprint :: Maybe Text bankAccountName :: Text

Instances

Eq BankAccount
Show BankAccount
FromJSON BankAccount	`BankAccount` JSON Instance

data TokenId Source

TokenId of a Token

Instances

Eq TokenId
Show TokenId

data CardNumber Source

Number associated with a Card

Instances

Eq CardNumber
Show CardNumber

data ExpMonth Source

Expiration Month for a Card

Instances

Eq ExpMonth
Show ExpMonth

newtype Email Source

Email associated with a Customer, Recipient or Charge

Constructors

Email Text

Instances

Eq Email
Show Email

data ExpYear Source

Expiration Year for a Card

Instances

Eq ExpYear
Show ExpYear

data CVC Source

CVC for a Card

Instances

Eq CVC
Show CVC

type Description = Text Source

Generic Description for use in constructing API Calls

type Limit = Maybe Int Source

Pagination Option for StripeList

data StripeDeleteResult Source

JSON returned from a Stripe deletion request

Constructors

StripeDeleteResult
Fields deleted :: Bool deletedId :: Maybe Text

Instances

Eq StripeDeleteResult
Show StripeDeleteResult
FromJSON StripeDeleteResult	JSON Instance for `StripeDeleteResult`

newtype RoutingNumber Source

Routing Number for Bank Account

Constructors

RoutingNumber Text

Instances

Eq RoutingNumber
Show RoutingNumber

newtype AccountNumber Source

Account Number of a Bank Account

Constructors

AccountNumber Text

Instances

Eq AccountNumber
Show AccountNumber

newtype Country Source

Country

Constructors

Country Text

Instances

Eq Country
Show Country

newtype AddressCity Source

City address for a Card

Constructors

AddressCity Text

Instances

Eq AddressCity
Show AddressCity

newtype AddressCountry Source

Country address for a Card

Constructors

AddressCountry Text

Instances

Eq AddressCountry
Show AddressCountry

newtype AddressLine1 Source

Address Line One for a Card

Constructors

AddressLine1 Text

Instances

Eq AddressLine1
Show AddressLine1

newtype AddressLine2 Source

Address Line Two for a Card

Constructors

AddressLine2 Text

Instances

Eq AddressLine2
Show AddressLine2

newtype AddressState Source

Address State for a Card

Constructors

AddressState Text

Instances

Eq AddressState
Show AddressState

newtype AddressZip Source

Address Zip Code for a Card

Constructors

AddressZip Text

Instances

Eq AddressZip
Show AddressZip

newtype BankAccountId Source

BankAccountId for BankAccount

Constructors

BankAccountId Text

Instances

Eq BankAccountId
Show BankAccountId

data BankAccountStatus Source

BankAccountStatus Object

Constructors

New
Validated
Verified
Errored

Instances

Eq BankAccountStatus
Show BankAccountStatus
FromJSON BankAccountStatus	`BankAccountStatus` JSON instance