Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostChargesCharge

Description

Contains the different functions to run the operation postChargesCharge

Synopsis

postChargesCharge :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostChargesChargeRequestBody -> m (Either HttpException (Response PostChargesChargeResponse))
postChargesChargeRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> PostChargesChargeRequestBody -> m (Either HttpException (Response ByteString))
postChargesChargeM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostChargesChargeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeResponse))
postChargesChargeRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostChargesChargeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostChargesChargeRequestBody = PostChargesChargeRequestBody {
}
data PostChargesChargeRequestBodyFraudDetails' = PostChargesChargeRequestBodyFraudDetails' {
- postChargesChargeRequestBodyFraudDetails'UserReport :: PostChargesChargeRequestBodyFraudDetails'UserReport'
}
data PostChargesChargeRequestBodyFraudDetails'UserReport'
data PostChargesChargeRequestBodyMetadata' = PostChargesChargeRequestBodyMetadata' {
}
data PostChargesChargeRequestBodyShipping' = PostChargesChargeRequestBodyShipping' {
}
data PostChargesChargeRequestBodyShipping'Address' = PostChargesChargeRequestBodyShipping'Address' {
}
data PostChargesChargeResponse

Documentation

postChargesCharge Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> String	charge \| Constraints: Maximum length of 5000
-> PostChargesChargeRequestBody	The request body to send
-> m (Either HttpException (Response PostChargesChargeResponse))	Monad containing the result of the operation

POST /v1/charges/{charge}

<p>Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>

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

POST /v1/charges/{charge}

The same as postChargesCharge but returns the raw ByteString

postChargesChargeM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostChargesChargeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeResponse)) Source #

POST /v1/charges/{charge}

Monadic version of postChargesCharge (use with runWithConfiguration)

postChargesChargeRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> PostChargesChargeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/charges/{charge}

Monadic version of postChargesChargeRaw (use with runWithConfiguration)

data PostChargesChargeRequestBody Source #

Defines the data type for the schema postChargesChargeRequestBody

Constructors

PostChargesChargeRequestBody

Fields

postChargesChargeRequestBodyCustomer :: Maybe String
customer: The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.
Constraints:
- Maximum length of 5000
postChargesChargeRequestBodyDescription :: Maybe String
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
postChargesChargeRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postChargesChargeRequestBodyFraudDetails :: Maybe PostChargesChargeRequestBodyFraudDetails'
fraud_details: A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.
postChargesChargeRequestBodyMetadata :: Maybe PostChargesChargeRequestBodyMetadata'
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`.
postChargesChargeRequestBodyReceiptEmail :: Maybe String
receipt_email: This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.
Constraints:
- Maximum length of 5000
postChargesChargeRequestBodyShipping :: Maybe PostChargesChargeRequestBodyShipping'
shipping: Shipping information for the charge. Helps prevent fraud on charges for physical goods.
postChargesChargeRequestBodyTransferGroup :: Maybe String
transfer_group: A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the Connect documentation for details.

Instances

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

data PostChargesChargeRequestBodyFraudDetails' Source #

Defines the data type for the schema postChargesChargeRequestBodyFraud_details'

A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a `user_report` key with a value of `fraudulent`. If you believe a charge is safe, include a `user_report` key with a value of `safe`. Stripe will use the information you send to improve our fraud detection algorithms.

Constructors

PostChargesChargeRequestBodyFraudDetails'
Fields postChargesChargeRequestBodyFraudDetails'UserReport :: PostChargesChargeRequestBodyFraudDetails'UserReport' user_report Constraints: Maximum length of 5000

Instances

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

data PostChargesChargeRequestBodyFraudDetails'UserReport' Source #

Defines the enum schema postChargesChargeRequestBodyFraud_details'User_report'

Constructors

PostChargesChargeRequestBodyFraudDetails'UserReport'EnumOther Value
PostChargesChargeRequestBodyFraudDetails'UserReport'EnumTyped String
PostChargesChargeRequestBodyFraudDetails'UserReport'EnumString_
PostChargesChargeRequestBodyFraudDetails'UserReport'EnumStringFraudulent
PostChargesChargeRequestBodyFraudDetails'UserReport'EnumStringSafe

Instances

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

data PostChargesChargeRequestBodyMetadata' Source #

Defines the data type for the schema postChargesChargeRequestBodyMetadata'

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

PostChargesChargeRequestBodyMetadata'

Instances

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

data PostChargesChargeRequestBodyShipping' Source #

Defines the data type for the schema postChargesChargeRequestBodyShipping'

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

Constructors

PostChargesChargeRequestBodyShipping'

Fields

postChargesChargeRequestBodyShipping'Address :: PostChargesChargeRequestBodyShipping'Address'
address
postChargesChargeRequestBodyShipping'Carrier :: Maybe String
carrier
Constraints:
- Maximum length of 5000
postChargesChargeRequestBodyShipping'Name :: String
name
Constraints:
- Maximum length of 5000
postChargesChargeRequestBodyShipping'Phone :: Maybe String
phone
Constraints:
- Maximum length of 5000
postChargesChargeRequestBodyShipping'TrackingNumber :: Maybe String
tracking_number
Constraints:
- Maximum length of 5000

Instances

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

data PostChargesChargeRequestBodyShipping'Address' Source #

Defines the data type for the schema postChargesChargeRequestBodyShipping'Address'

Constructors

PostChargesChargeRequestBodyShipping'Address'

Fields

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

Instances

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

data PostChargesChargeResponse Source #

Represents a response of the operation postChargesCharge.

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), PostChargesChargeResponseError is used.

Constructors

PostChargesChargeResponseError String	Means either no matching case available or a parse error
PostChargesChargeResponse200 Charge	Successful response.
PostChargesChargeResponseDefault Error	Error response.

Instances

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