Web.Stripe.Transfer

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

import Web.Stripe         
import Web.Stripe.Transfer
import Web.Stripe.Recipient

main :: IO ()
main = do
  let config = SecretKey "secret_key"
  result <- stripe config $ do
    Recipient { recipientId = recipientid } <- getRecipient (RecipientId "recipient_id")
    createTransfer recipientid (100 :: Amount) USD ([] :: MetaData)
  case result of
    Right transfer    -> print transfer
    Left  stripeError -> print stripeError

API

createTransfer

Arguments

:: RecipientId

The RecipientId of the Recipient who will receive the Transfer

-> Amount

The Amount of money to transfer to the Recipient

-> Currency

The Currency in which to perform the Transfer

-> MetaData

The MetaData associated with the Transfer

-> Stripe Transfer

Create a Transfer

getTransfer

Arguments

:: TransferId

TransferId associated with the Transfer to retrieve

-> Stripe Transfer

Retrieve a Transfer

getTransferExpandable

Arguments

:: TransferId

TransferId associated with the Transfer to retrieve

-> ExpandParams

The ExpandParams of the object to be expanded

-> Stripe Transfer

Retrieve a Transfer with ExpandParams

getTransfers

Arguments

:: Limit

Defaults to 10 if Nothing specified

-> StartingAfter TransferId

Paginate starting after the following TransferId

-> EndingBefore TransferId

Paginate ending before the following TransferId

-> Stripe (StripeList Transfer)

Retrieve StripeList of Transfers

getTransfersExpandable

Arguments

:: Limit

Defaults to 10 if Nothing specified

-> StartingAfter TransferId

Paginate starting after the following TransferId

-> EndingBefore TransferId

Paginate ending before the following TransferId

-> ExpandParams

The ExpandParams of the object to be expanded

-> Stripe (StripeList Transfer)

Retrieve StripeList of Transfers with ExpandParams

updateTransfer

Arguments

:: TransferId

The TransferId of the Transfer to update

-> Maybe Description

The Description of the Transfer to update

-> MetaData

The MetaData of the Transfer to update

-> Stripe Transfer

Update a Transfer

cancelTransfer

Arguments

:: TransferId

The TransferId of the Transfer to cancel

-> Stripe Transfer

Cancel a Transfer

Types

data Transfer

Transfer Object

Constructors

Transfer

Fields

transferId :: TransferId

transferObject :: Text

transferCreated :: UTCTime

transferDate :: UTCTime

transferLiveMode :: Bool

transferAmount :: Int

transferCurrency :: Currency

transferStatus :: TransferStatus

transferType :: TransferType

transferBalanceTransaction :: TransactionId

transferDescription :: Maybe Description

transferBankAccount :: Maybe BankAccount

transferFailureMessage :: Maybe Text

transferFailureCode :: Maybe Text

transferStatementDescription :: Maybe Description

transferRecipient :: Maybe RecipientId

transferMetaData :: MetaData

Instances

Eq Transfer

Show Transfer

FromJSON Transfer

JSON Instance for Transfer

newtype TransferId

TransferId

Constructors

TransferId Text

Instances

Eq TransferId

Show TransferId

data TransferStatus

Status of a Transfer

Constructors

TransferPaid

TransferPending

TransferCanceled

TransferFailed

Instances

Eq TransferStatus

Show TransferStatus

FromJSON TransferStatus

JSON Instance for TransferStatus

data TransferType

Type of a Transfer

Constructors

CardTransfer

BankAccountTransfer

Instances

Eq TransferType

Show TransferType

FromJSON TransferType

JSON Instance for TransferType

data RecipientId

RecipientId for a Recipient

Constructors

RecipientId Text

ExpandedRecipient Recipient

Instances

Eq RecipientId

Show RecipientId

FromJSON RecipientId

JSON Instance for RecipientId

data Recipient

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 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

data Currency

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

Instances

Eq Currency

Show Currency

FromJSON Currency

Currency JSON instances

type Amount = Int

Amount representing a monetary value. Stripe represents pennies as whole numbers i.e. 100 = $1

type Limit = Maybe Int

Pagination Option for StripeList