Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostChargesCharge

Description

Contains the different functions to run the operation postChargesCharge

Synopsis

postChargesCharge :: forall m. MonadHTTP m => Text -> Maybe PostChargesChargeRequestBody -> ClientT m (Response PostChargesChargeResponse)
data PostChargesChargeRequestBody = PostChargesChargeRequestBody {
}
mkPostChargesChargeRequestBody :: PostChargesChargeRequestBody
data PostChargesChargeRequestBodyFraudDetails' = PostChargesChargeRequestBodyFraudDetails' {
- postChargesChargeRequestBodyFraudDetails'UserReport :: PostChargesChargeRequestBodyFraudDetails'UserReport'
}
mkPostChargesChargeRequestBodyFraudDetails' :: PostChargesChargeRequestBodyFraudDetails'UserReport' -> PostChargesChargeRequestBodyFraudDetails'
data PostChargesChargeRequestBodyFraudDetails'UserReport'
data PostChargesChargeRequestBodyMetadata'Variants
- = PostChargesChargeRequestBodyMetadata'EmptyString
- | PostChargesChargeRequestBodyMetadata'Object Object
data PostChargesChargeRequestBodyShipping' = PostChargesChargeRequestBodyShipping' {
}
mkPostChargesChargeRequestBodyShipping' :: PostChargesChargeRequestBodyShipping'Address' -> Text -> PostChargesChargeRequestBodyShipping'
data PostChargesChargeRequestBodyShipping'Address' = PostChargesChargeRequestBodyShipping'Address' {
}
mkPostChargesChargeRequestBodyShipping'Address' :: Text -> PostChargesChargeRequestBodyShipping'Address'
data PostChargesChargeResponse

Documentation

postChargesCharge Source #

Arguments

:: forall m. MonadHTTP m
=> Text	charge \| Constraints: Maximum length of 5000
-> Maybe PostChargesChargeRequestBody	The request body to send
-> ClientT m (Response PostChargesChargeResponse)	Monadic computation which returns 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>

data PostChargesChargeRequestBody Source #

Defines the object schema located at paths./v1/charges/{charge}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostChargesChargeRequestBody

Fields

postChargesChargeRequestBodyCustomer :: Maybe Text
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 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
postChargesChargeRequestBodyExpand :: Maybe [Text]
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'Variants
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 Text
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 Text
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

Instances details

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

mkPostChargesChargeRequestBody :: PostChargesChargeRequestBody Source #

Create a new PostChargesChargeRequestBody with all required fields.

data PostChargesChargeRequestBodyFraudDetails' Source #

Defines the object schema located at paths./v1/charges/{charge}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.fraud_details in the specification.

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

Instances details

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'] #

mkPostChargesChargeRequestBodyFraudDetails' Source #

Arguments

:: PostChargesChargeRequestBodyFraudDetails'UserReport'	`postChargesChargeRequestBodyFraudDetails'UserReport`
-> PostChargesChargeRequestBodyFraudDetails'

Create a new PostChargesChargeRequestBodyFraudDetails' with all required fields.

data PostChargesChargeRequestBodyFraudDetails'UserReport' Source #

Defines the enum schema located at paths./v1/charges/{charge}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.fraud_details.properties.user_report in the specification.

Constructors

PostChargesChargeRequestBodyFraudDetails'UserReport'Other Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PostChargesChargeRequestBodyFraudDetails'UserReport'Typed Text	This constructor can be used to send values to the server which are not present in the specification yet.
PostChargesChargeRequestBodyFraudDetails'UserReport'EnumEmptyString	Represents the JSON value `""`
PostChargesChargeRequestBodyFraudDetails'UserReport'EnumFraudulent	Represents the JSON value `"fraudulent"`
PostChargesChargeRequestBodyFraudDetails'UserReport'EnumSafe	Represents the JSON value `"safe"`

Instances

Instances details

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'Variants Source #

Defines the oneOf schema located at paths./v1/charges/{charge}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.

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'EmptyString	Represents the JSON value `""`
PostChargesChargeRequestBodyMetadata'Object Object

Instances

Instances details

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

data PostChargesChargeRequestBodyShipping' Source #

Defines the object schema located at paths./v1/charges/{charge}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping in the specification.

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

Constructors

PostChargesChargeRequestBodyShipping'

Fields

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

Instances

Instances details

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'] #

mkPostChargesChargeRequestBodyShipping' Source #

Arguments

:: PostChargesChargeRequestBodyShipping'Address'	`postChargesChargeRequestBodyShipping'Address`
-> Text	`postChargesChargeRequestBodyShipping'Name`
-> PostChargesChargeRequestBodyShipping'

Create a new PostChargesChargeRequestBodyShipping' with all required fields.

data PostChargesChargeRequestBodyShipping'Address' Source #

Defines the object schema located at paths./v1/charges/{charge}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping.properties.address in the specification.

Constructors

PostChargesChargeRequestBodyShipping'Address'

Fields

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

Instances

Instances details

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'] #

mkPostChargesChargeRequestBodyShipping'Address' Source #

Arguments

:: Text	`postChargesChargeRequestBodyShipping'Address'Line1`
-> PostChargesChargeRequestBodyShipping'Address'

Create a new PostChargesChargeRequestBodyShipping'Address' with all required 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.

Instances

Instances details

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 #