Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostChargesChargeRefunds

Description

Contains the different functions to run the operation postChargesChargeRefunds

Synopsis

postChargesChargeRefunds :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeRefundsRequestBody -> m (Either HttpException (Response PostChargesChargeRefundsResponse))
postChargesChargeRefundsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeRefundsRequestBody -> m (Either HttpException (Response ByteString))
postChargesChargeRefundsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeRefundsResponse))
postChargesChargeRefundsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostChargesChargeRefundsRequestBody = PostChargesChargeRefundsRequestBody {
}
data PostChargesChargeRefundsRequestBodyMetadata' = PostChargesChargeRefundsRequestBodyMetadata' {
}
data PostChargesChargeRefundsRequestBodyReason'
data PostChargesChargeRefundsResponse

Documentation

postChargesChargeRefunds Source #

Arguments

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

POST /v1/charges/{charge}/refunds

<p>Create a refund.</p>

postChargesChargeRefundsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeRefundsRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/charges/{charge}/refunds

The same as postChargesChargeRefunds but returns the raw ByteString

postChargesChargeRefundsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeRefundsResponse)) Source #

POST /v1/charges/{charge}/refunds

Monadic version of postChargesChargeRefunds (use with runWithConfiguration)

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

POST /v1/charges/{charge}/refunds

Monadic version of postChargesChargeRefundsRaw (use with runWithConfiguration)

data PostChargesChargeRefundsRequestBody Source #

Defines the data type for the schema postChargesChargeRefundsRequestBody

Constructors

PostChargesChargeRefundsRequestBody

Fields

postChargesChargeRefundsRequestBodyAmount :: Maybe Integer
amount
postChargesChargeRefundsRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postChargesChargeRefundsRequestBodyMetadata :: Maybe PostChargesChargeRefundsRequestBodyMetadata'
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`.
postChargesChargeRefundsRequestBodyPaymentIntent :: Maybe Text
payment_intent
Constraints:
- Maximum length of 5000
postChargesChargeRefundsRequestBodyReason :: Maybe PostChargesChargeRefundsRequestBodyReason'
reason
Constraints:
- Maximum length of 5000
postChargesChargeRefundsRequestBodyRefundApplicationFee :: Maybe Bool
refund_application_fee
postChargesChargeRefundsRequestBodyReverseTransfer :: Maybe Bool
reverse_transfer

Instances

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

data PostChargesChargeRefundsRequestBodyMetadata' Source #

Defines the data type for the schema postChargesChargeRefundsRequestBodyMetadata'

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

PostChargesChargeRefundsRequestBodyMetadata'

Instances

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

data PostChargesChargeRefundsRequestBodyReason' Source #

Defines the enum schema postChargesChargeRefundsRequestBodyReason'

Constructors

PostChargesChargeRefundsRequestBodyReason'EnumOther Value
PostChargesChargeRefundsRequestBodyReason'EnumTyped Text
PostChargesChargeRefundsRequestBodyReason'EnumStringDuplicate
PostChargesChargeRefundsRequestBodyReason'EnumStringFraudulent
PostChargesChargeRefundsRequestBodyReason'EnumStringRequestedByCustomer

Instances

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

data PostChargesChargeRefundsResponse Source #

Represents a response of the operation postChargesChargeRefunds.

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

Constructors

PostChargesChargeRefundsResponseError String	Means either no matching case available or a parse error
PostChargesChargeRefundsResponse200 Refund	Successful response.
PostChargesChargeRefundsResponseDefault Error	Error response.

Instances

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