Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostCharges

Description

Contains the different functions to run the operation postCharges

Synopsis

postCharges :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe PostChargesRequestBody -> m (Either HttpException (Response PostChargesResponse))
postChargesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe PostChargesRequestBody -> m (Either HttpException (Response ByteString))
postChargesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostChargesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesResponse))
postChargesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostChargesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostChargesRequestBody = PostChargesRequestBody {
}
data PostChargesRequestBodyCard'OneOf2 = PostChargesRequestBodyCard'OneOf2 {
}
data PostChargesRequestBodyCard'OneOf2Metadata' = PostChargesRequestBodyCard'OneOf2Metadata' {
}
data PostChargesRequestBodyCard'OneOf2Object'
data PostChargesRequestBodyCard'Variants
- = PostChargesRequestBodyCard'Text Text
- | PostChargesRequestBodyCard'PostChargesRequestBodyCard'OneOf2 PostChargesRequestBodyCard'OneOf2
data PostChargesRequestBodyDestination'OneOf2 = PostChargesRequestBodyDestination'OneOf2 {
- postChargesRequestBodyDestination'OneOf2Account :: Text
- postChargesRequestBodyDestination'OneOf2Amount :: Maybe Integer
}
data PostChargesRequestBodyDestination'Variants
- = PostChargesRequestBodyDestination'Text Text
- | PostChargesRequestBodyDestination'PostChargesRequestBodyDestination'OneOf2 PostChargesRequestBodyDestination'OneOf2
data PostChargesRequestBodyMetadata' = PostChargesRequestBodyMetadata' {
}
data PostChargesRequestBodyShipping' = PostChargesRequestBodyShipping' {
}
data PostChargesRequestBodyShipping'Address' = PostChargesRequestBodyShipping'Address' {
}
data PostChargesRequestBodyTransferData' = PostChargesRequestBodyTransferData' {
- postChargesRequestBodyTransferData'Amount :: Maybe Integer
- postChargesRequestBodyTransferData'Destination :: Text
}
data PostChargesResponse

Documentation

postCharges Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Maybe 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 -> Maybe PostChargesRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/charges

The same as postCharges but returns the raw ByteString

postChargesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostChargesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesResponse)) Source #

POST /v1/charges

Monadic version of postCharges (use with runWithConfiguration)

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

POST /v1/charges

Monadic version of postChargesRaw (use with runWithConfiguration)

data PostChargesRequestBody Source #

Defines the data type for the schema postChargesRequestBody

Constructors

PostChargesRequestBody

Fields

postChargesRequestBodyAmount :: Maybe Integer
amount: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
postChargesRequestBodyApplicationFee :: Maybe Integer
application_fee
postChargesRequestBodyApplicationFeeAmount :: Maybe Integer
application_fee_amount: A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees documentation.
postChargesRequestBodyCapture :: Maybe Bool
capture: Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire in _seven days_. For more information, see the authorizing charges and settling later documentation.
postChargesRequestBodyCard :: Maybe PostChargesRequestBodyCard'Variants
card: A token, like the ones returned by Stripe.js.
postChargesRequestBodyCurrency :: Maybe Text
currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
postChargesRequestBodyCustomer :: Maybe Text
customer: The ID of an existing customer that will be charged in this request.
Constraints:
- Maximum length of 500
postChargesRequestBodyDescription :: Maybe Text
description: An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
Constraints:
- Maximum length of 40000
postChargesRequestBodyDestination :: Maybe PostChargesRequestBodyDestination'Variants
destination
postChargesRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postChargesRequestBodyMetadata :: Maybe PostChargesRequestBodyMetadata'
metadata: 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`.
postChargesRequestBodyOnBehalfOf :: Maybe Text
on_behalf_of: The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see Creating Separate Charges and Transfers.
Constraints:
- Maximum length of 5000
postChargesRequestBodyReceiptEmail :: Maybe Text
receipt_email: The email address to which this charge's receipt will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a Customer, the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your email settings.
postChargesRequestBodyShipping :: Maybe PostChargesRequestBodyShipping'
shipping: Shipping information for the charge. Helps prevent fraud on charges for physical goods.
postChargesRequestBodySource :: Maybe Text
source: A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected account. For certain sources---namely, cards, bank accounts, and attached sources---you must also pass the ID of the associated customer.
Constraints:
- Maximum length of 5000
postChargesRequestBodyStatementDescriptor :: Maybe Text
statement_descriptor: For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
Constraints:
- Maximum length of 22
postChargesRequestBodyStatementDescriptorSuffix :: Maybe Text
statement_descriptor_suffix: Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
Constraints:
- Maximum length of 22
postChargesRequestBodyTransferData :: Maybe PostChargesRequestBodyTransferData'
transfer_data: An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.
postChargesRequestBodyTransferGroup :: Maybe Text
transfer_group: A string that identifies this transaction as part of a group. For details, see Grouping transactions.

Instances

Eq PostChargesRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBody -> PostChargesRequestBody -> Bool # (/=) :: PostChargesRequestBody -> PostChargesRequestBody -> Bool #
Show PostChargesRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBody -> ShowS # show :: PostChargesRequestBody -> String # showList :: [PostChargesRequestBody] -> ShowS #
ToJSON PostChargesRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBody -> Value # toEncoding :: PostChargesRequestBody -> Encoding # toJSONList :: [PostChargesRequestBody] -> Value # toEncodingList :: [PostChargesRequestBody] -> Encoding #
FromJSON PostChargesRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBody # parseJSONList :: Value -> Parser [PostChargesRequestBody] #

data PostChargesRequestBodyCard'OneOf2 Source #

Defines the data type for the schema postChargesRequestBodyCard'OneOf2

Constructors

PostChargesRequestBodyCard'OneOf2

Fields

postChargesRequestBodyCard'OneOf2AddressCity :: Maybe Text
address_city
Constraints:
- Maximum length of 5000
postChargesRequestBodyCard'OneOf2AddressCountry :: Maybe Text
address_country
Constraints:
- Maximum length of 5000
postChargesRequestBodyCard'OneOf2AddressLine1 :: Maybe Text
address_line1
Constraints:
- Maximum length of 5000
postChargesRequestBodyCard'OneOf2AddressLine2 :: Maybe Text
address_line2
Constraints:
- Maximum length of 5000
postChargesRequestBodyCard'OneOf2AddressState :: Maybe Text
address_state
Constraints:
- Maximum length of 5000
postChargesRequestBodyCard'OneOf2AddressZip :: Maybe Text
address_zip
Constraints:
- Maximum length of 5000
postChargesRequestBodyCard'OneOf2Cvc :: Maybe Text
cvc
Constraints:
- Maximum length of 5000
postChargesRequestBodyCard'OneOf2ExpMonth :: Integer
exp_month
postChargesRequestBodyCard'OneOf2ExpYear :: Integer
exp_year
postChargesRequestBodyCard'OneOf2Metadata :: Maybe PostChargesRequestBodyCard'OneOf2Metadata'
metadata
postChargesRequestBodyCard'OneOf2Name :: Maybe Text
name
Constraints:
- Maximum length of 5000
postChargesRequestBodyCard'OneOf2Number :: Text
number
Constraints:
- Maximum length of 5000
postChargesRequestBodyCard'OneOf2Object :: Maybe PostChargesRequestBodyCard'OneOf2Object'
object
Constraints:
- Maximum length of 5000

Instances

Eq PostChargesRequestBodyCard'OneOf2 Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBodyCard'OneOf2 -> PostChargesRequestBodyCard'OneOf2 -> Bool # (/=) :: PostChargesRequestBodyCard'OneOf2 -> PostChargesRequestBodyCard'OneOf2 -> Bool #
Show PostChargesRequestBodyCard'OneOf2 Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBodyCard'OneOf2 -> ShowS # show :: PostChargesRequestBodyCard'OneOf2 -> String # showList :: [PostChargesRequestBodyCard'OneOf2] -> ShowS #
ToJSON PostChargesRequestBodyCard'OneOf2 Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBodyCard'OneOf2 -> Value # toEncoding :: PostChargesRequestBodyCard'OneOf2 -> Encoding # toJSONList :: [PostChargesRequestBodyCard'OneOf2] -> Value # toEncodingList :: [PostChargesRequestBodyCard'OneOf2] -> Encoding #
FromJSON PostChargesRequestBodyCard'OneOf2 Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBodyCard'OneOf2 # parseJSONList :: Value -> Parser [PostChargesRequestBodyCard'OneOf2] #

data PostChargesRequestBodyCard'OneOf2Metadata' Source #

Defines the data type for the schema postChargesRequestBodyCard'OneOf2Metadata'

Constructors

PostChargesRequestBodyCard'OneOf2Metadata'

Instances

Eq PostChargesRequestBodyCard'OneOf2Metadata' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBodyCard'OneOf2Metadata' -> PostChargesRequestBodyCard'OneOf2Metadata' -> Bool # (/=) :: PostChargesRequestBodyCard'OneOf2Metadata' -> PostChargesRequestBodyCard'OneOf2Metadata' -> Bool #
Show PostChargesRequestBodyCard'OneOf2Metadata' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBodyCard'OneOf2Metadata' -> ShowS # show :: PostChargesRequestBodyCard'OneOf2Metadata' -> String # showList :: [PostChargesRequestBodyCard'OneOf2Metadata'] -> ShowS #
ToJSON PostChargesRequestBodyCard'OneOf2Metadata' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBodyCard'OneOf2Metadata' -> Value # toEncoding :: PostChargesRequestBodyCard'OneOf2Metadata' -> Encoding # toJSONList :: [PostChargesRequestBodyCard'OneOf2Metadata'] -> Value # toEncodingList :: [PostChargesRequestBodyCard'OneOf2Metadata'] -> Encoding #
FromJSON PostChargesRequestBodyCard'OneOf2Metadata' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBodyCard'OneOf2Metadata' # parseJSONList :: Value -> Parser [PostChargesRequestBodyCard'OneOf2Metadata'] #

data PostChargesRequestBodyCard'OneOf2Object' Source #

Defines the enum schema postChargesRequestBodyCard'OneOf2Object'

Constructors

PostChargesRequestBodyCard'OneOf2Object'EnumOther Value
PostChargesRequestBodyCard'OneOf2Object'EnumTyped Text
PostChargesRequestBodyCard'OneOf2Object'EnumStringCard

Instances

Eq PostChargesRequestBodyCard'OneOf2Object' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBodyCard'OneOf2Object' -> PostChargesRequestBodyCard'OneOf2Object' -> Bool # (/=) :: PostChargesRequestBodyCard'OneOf2Object' -> PostChargesRequestBodyCard'OneOf2Object' -> Bool #
Show PostChargesRequestBodyCard'OneOf2Object' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBodyCard'OneOf2Object' -> ShowS # show :: PostChargesRequestBodyCard'OneOf2Object' -> String # showList :: [PostChargesRequestBodyCard'OneOf2Object'] -> ShowS #
ToJSON PostChargesRequestBodyCard'OneOf2Object' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBodyCard'OneOf2Object' -> Value # toEncoding :: PostChargesRequestBodyCard'OneOf2Object' -> Encoding # toJSONList :: [PostChargesRequestBodyCard'OneOf2Object'] -> Value # toEncodingList :: [PostChargesRequestBodyCard'OneOf2Object'] -> Encoding #
FromJSON PostChargesRequestBodyCard'OneOf2Object' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBodyCard'OneOf2Object' # parseJSONList :: Value -> Parser [PostChargesRequestBodyCard'OneOf2Object'] #

data PostChargesRequestBodyCard'Variants Source #

Define the one-of schema postChargesRequestBodyCard'

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

Constructors

PostChargesRequestBodyCard'Text Text
PostChargesRequestBodyCard'PostChargesRequestBodyCard'OneOf2 PostChargesRequestBodyCard'OneOf2

Instances

Eq PostChargesRequestBodyCard'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBodyCard'Variants -> PostChargesRequestBodyCard'Variants -> Bool # (/=) :: PostChargesRequestBodyCard'Variants -> PostChargesRequestBodyCard'Variants -> Bool #
Show PostChargesRequestBodyCard'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBodyCard'Variants -> ShowS # show :: PostChargesRequestBodyCard'Variants -> String # showList :: [PostChargesRequestBodyCard'Variants] -> ShowS #
Generic PostChargesRequestBodyCard'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCharges Associated Types type Rep PostChargesRequestBodyCard'Variants :: Type -> Type # Methods from :: PostChargesRequestBodyCard'Variants -> Rep PostChargesRequestBodyCard'Variants x # to :: Rep PostChargesRequestBodyCard'Variants x -> PostChargesRequestBodyCard'Variants #
ToJSON PostChargesRequestBodyCard'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBodyCard'Variants -> Value # toEncoding :: PostChargesRequestBodyCard'Variants -> Encoding # toJSONList :: [PostChargesRequestBodyCard'Variants] -> Value # toEncodingList :: [PostChargesRequestBodyCard'Variants] -> Encoding #
FromJSON PostChargesRequestBodyCard'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBodyCard'Variants # parseJSONList :: Value -> Parser [PostChargesRequestBodyCard'Variants] #
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.2-D0ebvtj6l9B4TLqRwmHKaP" False) (C1 (MetaCons "PostChargesRequestBodyCard'Text" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: 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

Constructors

PostChargesRequestBodyDestination'OneOf2
Fields postChargesRequestBodyDestination'OneOf2Account :: Text account Constraints: Maximum length of 5000 postChargesRequestBodyDestination'OneOf2Amount :: Maybe Integer amount

Instances

Eq PostChargesRequestBodyDestination'OneOf2 Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBodyDestination'OneOf2 -> PostChargesRequestBodyDestination'OneOf2 -> Bool # (/=) :: PostChargesRequestBodyDestination'OneOf2 -> PostChargesRequestBodyDestination'OneOf2 -> Bool #
Show PostChargesRequestBodyDestination'OneOf2 Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBodyDestination'OneOf2 -> ShowS # show :: PostChargesRequestBodyDestination'OneOf2 -> String # showList :: [PostChargesRequestBodyDestination'OneOf2] -> ShowS #
ToJSON PostChargesRequestBodyDestination'OneOf2 Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBodyDestination'OneOf2 -> Value # toEncoding :: PostChargesRequestBodyDestination'OneOf2 -> Encoding # toJSONList :: [PostChargesRequestBodyDestination'OneOf2] -> Value # toEncodingList :: [PostChargesRequestBodyDestination'OneOf2] -> Encoding #
FromJSON PostChargesRequestBodyDestination'OneOf2 Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBodyDestination'OneOf2 # parseJSONList :: Value -> Parser [PostChargesRequestBodyDestination'OneOf2] #

data PostChargesRequestBodyDestination'Variants Source #

Define the one-of schema postChargesRequestBodyDestination'

Constructors

PostChargesRequestBodyDestination'Text Text
PostChargesRequestBodyDestination'PostChargesRequestBodyDestination'OneOf2 PostChargesRequestBodyDestination'OneOf2

Instances

Eq PostChargesRequestBodyDestination'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBodyDestination'Variants -> PostChargesRequestBodyDestination'Variants -> Bool # (/=) :: PostChargesRequestBodyDestination'Variants -> PostChargesRequestBodyDestination'Variants -> Bool #
Show PostChargesRequestBodyDestination'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBodyDestination'Variants -> ShowS # show :: PostChargesRequestBodyDestination'Variants -> String # showList :: [PostChargesRequestBodyDestination'Variants] -> ShowS #
Generic PostChargesRequestBodyDestination'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCharges Associated Types type Rep PostChargesRequestBodyDestination'Variants :: Type -> Type # Methods from :: PostChargesRequestBodyDestination'Variants -> Rep PostChargesRequestBodyDestination'Variants x # to :: Rep PostChargesRequestBodyDestination'Variants x -> PostChargesRequestBodyDestination'Variants #
ToJSON PostChargesRequestBodyDestination'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBodyDestination'Variants -> Value # toEncoding :: PostChargesRequestBodyDestination'Variants -> Encoding # toJSONList :: [PostChargesRequestBodyDestination'Variants] -> Value # toEncodingList :: [PostChargesRequestBodyDestination'Variants] -> Encoding #
FromJSON PostChargesRequestBodyDestination'Variants Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBodyDestination'Variants # parseJSONList :: Value -> Parser [PostChargesRequestBodyDestination'Variants] #
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.2-D0ebvtj6l9B4TLqRwmHKaP" False) (C1 (MetaCons "PostChargesRequestBodyDestination'Text" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)) :+: 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`.

Constructors

PostChargesRequestBodyMetadata'

Instances

Eq PostChargesRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBodyMetadata' -> PostChargesRequestBodyMetadata' -> Bool # (/=) :: PostChargesRequestBodyMetadata' -> PostChargesRequestBodyMetadata' -> Bool #
Show PostChargesRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBodyMetadata' -> ShowS # show :: PostChargesRequestBodyMetadata' -> String # showList :: [PostChargesRequestBodyMetadata'] -> ShowS #
ToJSON PostChargesRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBodyMetadata' -> Value # toEncoding :: PostChargesRequestBodyMetadata' -> Encoding # toJSONList :: [PostChargesRequestBodyMetadata'] -> Value # toEncodingList :: [PostChargesRequestBodyMetadata'] -> Encoding #
FromJSON PostChargesRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBodyMetadata' # parseJSONList :: Value -> Parser [PostChargesRequestBodyMetadata'] #

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

postChargesRequestBodyShipping'Address :: PostChargesRequestBodyShipping'Address'
address
postChargesRequestBodyShipping'Carrier :: Maybe Text
carrier
Constraints:
- Maximum length of 5000
postChargesRequestBodyShipping'Name :: Text
name
Constraints:
- Maximum length of 5000
postChargesRequestBodyShipping'Phone :: Maybe Text
phone
Constraints:
- Maximum length of 5000
postChargesRequestBodyShipping'TrackingNumber :: Maybe Text
tracking_number
Constraints:
- Maximum length of 5000

Instances

Eq PostChargesRequestBodyShipping' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBodyShipping' -> PostChargesRequestBodyShipping' -> Bool # (/=) :: PostChargesRequestBodyShipping' -> PostChargesRequestBodyShipping' -> Bool #
Show PostChargesRequestBodyShipping' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBodyShipping' -> ShowS # show :: PostChargesRequestBodyShipping' -> String # showList :: [PostChargesRequestBodyShipping'] -> ShowS #
ToJSON PostChargesRequestBodyShipping' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBodyShipping' -> Value # toEncoding :: PostChargesRequestBodyShipping' -> Encoding # toJSONList :: [PostChargesRequestBodyShipping'] -> Value # toEncodingList :: [PostChargesRequestBodyShipping'] -> Encoding #
FromJSON PostChargesRequestBodyShipping' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBodyShipping' # parseJSONList :: Value -> Parser [PostChargesRequestBodyShipping'] #

data PostChargesRequestBodyShipping'Address' Source #

Defines the data type for the schema postChargesRequestBodyShipping'Address'

Constructors

PostChargesRequestBodyShipping'Address'

Fields

postChargesRequestBodyShipping'Address'City :: Maybe Text
city
Constraints:
- Maximum length of 5000
postChargesRequestBodyShipping'Address'Country :: Maybe Text
country
Constraints:
- Maximum length of 5000
postChargesRequestBodyShipping'Address'Line1 :: Text
line1
Constraints:
- Maximum length of 5000
postChargesRequestBodyShipping'Address'Line2 :: Maybe Text
line2
Constraints:
- Maximum length of 5000
postChargesRequestBodyShipping'Address'PostalCode :: Maybe Text
postal_code
Constraints:
- Maximum length of 5000
postChargesRequestBodyShipping'Address'State :: Maybe Text
state
Constraints:
- Maximum length of 5000

Instances

Eq PostChargesRequestBodyShipping'Address' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBodyShipping'Address' -> PostChargesRequestBodyShipping'Address' -> Bool # (/=) :: PostChargesRequestBodyShipping'Address' -> PostChargesRequestBodyShipping'Address' -> Bool #
Show PostChargesRequestBodyShipping'Address' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBodyShipping'Address' -> ShowS # show :: PostChargesRequestBodyShipping'Address' -> String # showList :: [PostChargesRequestBodyShipping'Address'] -> ShowS #
ToJSON PostChargesRequestBodyShipping'Address' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBodyShipping'Address' -> Value # toEncoding :: PostChargesRequestBodyShipping'Address' -> Encoding # toJSONList :: [PostChargesRequestBodyShipping'Address'] -> Value # toEncodingList :: [PostChargesRequestBodyShipping'Address'] -> Encoding #
FromJSON PostChargesRequestBodyShipping'Address' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBodyShipping'Address' # parseJSONList :: Value -> Parser [PostChargesRequestBodyShipping'Address'] #

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.

Constructors

PostChargesRequestBodyTransferData'
Fields postChargesRequestBodyTransferData'Amount :: Maybe Integer amount postChargesRequestBodyTransferData'Destination :: Text destination Constraints: Maximum length of 5000

Instances

Eq PostChargesRequestBodyTransferData' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBodyTransferData' -> PostChargesRequestBodyTransferData' -> Bool # (/=) :: PostChargesRequestBodyTransferData' -> PostChargesRequestBodyTransferData' -> Bool #
Show PostChargesRequestBodyTransferData' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBodyTransferData' -> ShowS # show :: PostChargesRequestBodyTransferData' -> String # showList :: [PostChargesRequestBodyTransferData'] -> ShowS #
ToJSON PostChargesRequestBodyTransferData' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBodyTransferData' -> Value # toEncoding :: PostChargesRequestBodyTransferData' -> Encoding # toJSONList :: [PostChargesRequestBodyTransferData'] -> Value # toEncodingList :: [PostChargesRequestBodyTransferData'] -> Encoding #
FromJSON PostChargesRequestBodyTransferData' Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBodyTransferData' # parseJSONList :: Value -> Parser [PostChargesRequestBodyTransferData'] #

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.

Instances

Eq PostChargesResponse Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesResponse -> PostChargesResponse -> Bool # (/=) :: PostChargesResponse -> PostChargesResponse -> Bool #
Show PostChargesResponse Source #
Instance details Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesResponse -> ShowS # show :: PostChargesResponse -> String # showList :: [PostChargesResponse] -> ShowS #