stripeapi-0.1.0.2: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostChargesCharge

Description

Contains the different functions to run the operation postChargesCharge

Synopsis

Documentation

postChargesCharge Source #

Arguments

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

The configuration to use in the request

-> Text

charge | Constraints: Maximum length of 5000

-> Maybe 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 -> Text -> Maybe PostChargesChargeRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/charges/{charge}

The same as postChargesCharge but returns the raw ByteString

data PostChargesChargeRequestBody Source #

Defines the data type for the schema postChargesChargeRequestBody

Constructors

PostChargesChargeRequestBody 

Fields

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.

data PostChargesChargeRequestBodyFraudDetails'UserReport' Source #

Defines the enum schema postChargesChargeRequestBodyFraud_details'User_report'

Instances
Eq PostChargesChargeRequestBodyFraudDetails'UserReport' Source # 
Instance details

Defined in StripeAPI.Operations.PostChargesCharge

Show PostChargesChargeRequestBodyFraudDetails'UserReport' Source # 
Instance details

Defined in StripeAPI.Operations.PostChargesCharge

ToJSON PostChargesChargeRequestBodyFraudDetails'UserReport' Source # 
Instance details

Defined in StripeAPI.Operations.PostChargesCharge

FromJSON PostChargesChargeRequestBodyFraudDetails'UserReport' Source # 
Instance details

Defined in StripeAPI.Operations.PostChargesCharge

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

data PostChargesChargeRequestBodyShipping' Source #

Defines the data type for the schema postChargesChargeRequestBodyShipping'

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

data PostChargesChargeRequestBodyShipping'Address' Source #

Defines the data type for the schema postChargesChargeRequestBodyShipping'Address'

Constructors

PostChargesChargeRequestBodyShipping'Address' 

Fields

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.