Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostRefunds

Description

Contains the different functions to run the operation postRefunds

Synopsis

postRefunds :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostRefundsRequestBody -> m (Either HttpException (Response PostRefundsResponse))
postRefundsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> PostRefundsRequestBody -> m (Either HttpException (Response ByteString))
postRefundsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostRefundsResponse))
postRefundsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostRefundsRequestBody = PostRefundsRequestBody {
}
data PostRefundsRequestBodyMetadata' = PostRefundsRequestBodyMetadata' {
}
data PostRefundsRequestBodyReason'
data PostRefundsResponse

Documentation

postRefunds Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> PostRefundsRequestBody	The request body to send
-> m (Either HttpException (Response PostRefundsResponse))	Monad containing the result of the operation

POST /v1/refunds

<p>Create a refund.</p>

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

POST /v1/refunds

The same as postRefunds but returns the raw ByteString

postRefundsM :: forall m s. (MonadHTTP m, SecurityScheme s) => PostRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostRefundsResponse)) Source #

POST /v1/refunds

Monadic version of postRefunds (use with runWithConfiguration)

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

POST /v1/refunds

Monadic version of postRefundsRaw (use with runWithConfiguration)

data PostRefundsRequestBody Source #

Defines the data type for the schema postRefundsRequestBody

Constructors

PostRefundsRequestBody

Fields

postRefundsRequestBodyAmount :: Maybe Integer
amount
postRefundsRequestBodyCharge :: Maybe String
charge
Constraints:
- Maximum length of 5000
postRefundsRequestBodyExpand :: Maybe ([] String)
expand: Specifies which fields in the response should be expanded.
postRefundsRequestBodyMetadata :: Maybe PostRefundsRequestBodyMetadata'
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`.
postRefundsRequestBodyPaymentIntent :: Maybe String
payment_intent
Constraints:
- Maximum length of 5000
postRefundsRequestBodyReason :: Maybe PostRefundsRequestBodyReason'
reason
Constraints:
- Maximum length of 5000
postRefundsRequestBodyRefundApplicationFee :: Maybe Bool
refund_application_fee
postRefundsRequestBodyReverseTransfer :: Maybe Bool
reverse_transfer

Instances

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

data PostRefundsRequestBodyMetadata' Source #

Defines the data type for the schema postRefundsRequestBodyMetadata'

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

PostRefundsRequestBodyMetadata'

Instances

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

data PostRefundsRequestBodyReason' Source #

Defines the enum schema postRefundsRequestBodyReason'

Constructors

PostRefundsRequestBodyReason'EnumOther Value
PostRefundsRequestBodyReason'EnumTyped String
PostRefundsRequestBodyReason'EnumStringDuplicate
PostRefundsRequestBodyReason'EnumStringFraudulent
PostRefundsRequestBodyReason'EnumStringRequestedByCustomer

Instances

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

data PostRefundsResponse Source #

Represents a response of the operation postRefunds.

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

Constructors

PostRefundsResponseError String	Means either no matching case available or a parse error
PostRefundsResponse200 Refund	Successful response.
PostRefundsResponseDefault Error	Error response.

Instances

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