Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostChargesChargeRefunds

Description

Contains the different functions to run the operation postChargesChargeRefunds

Synopsis

postChargesChargeRefunds :: forall m. MonadHTTP m => Text -> Maybe PostChargesChargeRefundsRequestBody -> ClientT m (Response PostChargesChargeRefundsResponse)
data PostChargesChargeRefundsRequestBody = PostChargesChargeRefundsRequestBody {
}
mkPostChargesChargeRefundsRequestBody :: PostChargesChargeRefundsRequestBody
data PostChargesChargeRefundsRequestBodyMetadata'Variants
- = PostChargesChargeRefundsRequestBodyMetadata'EmptyString
- | PostChargesChargeRefundsRequestBodyMetadata'Object Object
data PostChargesChargeRefundsRequestBodyReason'
data PostChargesChargeRefundsResponse

Documentation

postChargesChargeRefunds Source #

Arguments

:: forall m. MonadHTTP m
=> Text	charge \| Constraints: Maximum length of 5000
-> Maybe PostChargesChargeRefundsRequestBody	The request body to send
-> ClientT m (Response PostChargesChargeRefundsResponse)	Monadic computation which returns the result of the operation

POST /v1/charges/{charge}/refunds

<p>Create a refund.</p>

data PostChargesChargeRefundsRequestBody Source #

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

Constructors

PostChargesChargeRefundsRequestBody

Fields

postChargesChargeRefundsRequestBodyAmount :: Maybe Int
amount
postChargesChargeRefundsRequestBodyExpand :: Maybe [Text]
expand: Specifies which fields in the response should be expanded.
postChargesChargeRefundsRequestBodyMetadata :: Maybe PostChargesChargeRefundsRequestBodyMetadata'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`.
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

Instances details

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

mkPostChargesChargeRefundsRequestBody :: PostChargesChargeRefundsRequestBody Source #

Create a new PostChargesChargeRefundsRequestBody with all required fields.

data PostChargesChargeRefundsRequestBodyMetadata'Variants Source #

Defines the oneOf schema located at paths./v1/charges/{charge}/refunds.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

PostChargesChargeRefundsRequestBodyMetadata'EmptyString	Represents the JSON value `""`
PostChargesChargeRefundsRequestBodyMetadata'Object Object

Instances

Instances details

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

data PostChargesChargeRefundsRequestBodyReason' Source #

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

Constructors

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

Instances

Instances details

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

Instances details

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 #