stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostCharges

Description

Contains the different functions to run the operation postCharges

Synopsis

Documentation

postCharges Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> PostChargesRequestBody

The request body to send

-> m (Either HttpException (Response PostChargesResponse))

Monad containing the result of the operation

POST /v1/charges

<p>To charge a credit card or other payment source, you create a <code>Charge</code> object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).</p>

postChargesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostChargesRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/charges

The same as postCharges but returns the raw ByteString

data PostChargesRequestBody Source #

Defines the data type for the schema postChargesRequestBody

Constructors

PostChargesRequestBody 

Fields

data PostChargesRequestBodyCard'OneOf2 Source #

Defines the data type for the schema postChargesRequestBodyCard'OneOf2

Constructors

PostChargesRequestBodyCard'OneOf2 

Fields

data PostChargesRequestBodyCard'OneOf2Metadata' Source #

Defines the data type for the schema postChargesRequestBodyCard'OneOf2Metadata'

data PostChargesRequestBodyCard'OneOf2Object' Source #

Defines the enum schema postChargesRequestBodyCard'OneOf2Object'

data PostChargesRequestBodyCard'Variants Source #

Define the one-of schema postChargesRequestBodyCard'

A token, like the ones returned by Stripe.js.

Instances
Eq PostChargesRequestBodyCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

Show PostChargesRequestBodyCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

Generic PostChargesRequestBodyCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

ToJSON PostChargesRequestBodyCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

FromJSON PostChargesRequestBodyCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

type Rep PostChargesRequestBodyCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

type Rep PostChargesRequestBodyCard'Variants = D1 (MetaData "PostChargesRequestBodyCard'Variants" "StripeAPI.Operations.PostCharges" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostChargesRequestBodyCard'String" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "PostChargesRequestBodyCard'PostChargesRequestBodyCard'OneOf2" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostChargesRequestBodyCard'OneOf2)))

data PostChargesRequestBodyDestination'OneOf2 Source #

Defines the data type for the schema postChargesRequestBodyDestination'OneOf2

data PostChargesRequestBodyDestination'Variants Source #

Define the one-of schema postChargesRequestBodyDestination'

Instances
Eq PostChargesRequestBodyDestination'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

Show PostChargesRequestBodyDestination'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

Generic PostChargesRequestBodyDestination'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

ToJSON PostChargesRequestBodyDestination'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

FromJSON PostChargesRequestBodyDestination'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

type Rep PostChargesRequestBodyDestination'Variants Source # 
Instance details

Defined in StripeAPI.Operations.PostCharges

type Rep PostChargesRequestBodyDestination'Variants = D1 (MetaData "PostChargesRequestBodyDestination'Variants" "StripeAPI.Operations.PostCharges" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "PostChargesRequestBodyDestination'String" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "PostChargesRequestBodyDestination'PostChargesRequestBodyDestination'OneOf2" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PostChargesRequestBodyDestination'OneOf2)))

data PostChargesRequestBodyMetadata' Source #

Defines the data type for the schema postChargesRequestBodyMetadata'

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

data PostChargesRequestBodyShipping' Source #

Defines the data type for the schema postChargesRequestBodyShipping'

Shipping information for the charge. Helps prevent fraud on charges for physical goods.

Constructors

PostChargesRequestBodyShipping' 

Fields

data PostChargesRequestBodyShipping'Address' Source #

Defines the data type for the schema postChargesRequestBodyShipping'Address'

Constructors

PostChargesRequestBodyShipping'Address' 

Fields

data PostChargesRequestBodyTransferData' Source #

Defines the data type for the schema postChargesRequestBodyTransfer_data'

An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.

data PostChargesResponse Source #

Represents a response of the operation postCharges.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostChargesResponseError is used.

Constructors

PostChargesResponseError String

Means either no matching case available or a parse error

PostChargesResponse200 Charge

Successful response.

PostChargesResponseDefault Error

Error response.