| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostRefunds
Description
Contains the different functions to run the operation postRefunds
Synopsis
- postRefunds :: forall m. MonadHTTP m => Maybe PostRefundsRequestBody -> StripeT m (Response PostRefundsResponse)
- data PostRefundsRequestBody = PostRefundsRequestBody {
- postRefundsRequestBodyAmount :: Maybe Int
- postRefundsRequestBodyCharge :: Maybe Text
- postRefundsRequestBodyExpand :: Maybe [Text]
- postRefundsRequestBodyMetadata :: Maybe PostRefundsRequestBodyMetadata'Variants
- postRefundsRequestBodyPaymentIntent :: Maybe Text
- postRefundsRequestBodyReason :: Maybe PostRefundsRequestBodyReason'
- postRefundsRequestBodyRefundApplicationFee :: Maybe Bool
- postRefundsRequestBodyReverseTransfer :: Maybe Bool
- mkPostRefundsRequestBody :: PostRefundsRequestBody
- data PostRefundsRequestBodyMetadata'Variants
- data PostRefundsRequestBodyReason'
- data PostRefundsResponse
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => Maybe PostRefundsRequestBody | The request body to send |
| -> StripeT m (Response PostRefundsResponse) | Monadic computation which returns the result of the operation |
POST /v1/refunds
<p>Create a refund.</p>
data PostRefundsRequestBody Source #
Defines the object schema located at paths./v1/refunds.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostRefundsRequestBody | |
Fields
| |
Instances
| Eq PostRefundsRequestBody Source # | |
Defined in StripeAPI.Operations.PostRefunds Methods (==) :: PostRefundsRequestBody -> PostRefundsRequestBody -> Bool # (/=) :: PostRefundsRequestBody -> PostRefundsRequestBody -> Bool # | |
| Show PostRefundsRequestBody Source # | |
Defined in StripeAPI.Operations.PostRefunds Methods showsPrec :: Int -> PostRefundsRequestBody -> ShowS # show :: PostRefundsRequestBody -> String # showList :: [PostRefundsRequestBody] -> ShowS # | |
| ToJSON PostRefundsRequestBody Source # | |
Defined in StripeAPI.Operations.PostRefunds Methods toJSON :: PostRefundsRequestBody -> Value # toEncoding :: PostRefundsRequestBody -> Encoding # toJSONList :: [PostRefundsRequestBody] -> Value # | |
| FromJSON PostRefundsRequestBody Source # | |
Defined in StripeAPI.Operations.PostRefunds Methods parseJSON :: Value -> Parser PostRefundsRequestBody # parseJSONList :: Value -> Parser [PostRefundsRequestBody] # | |
mkPostRefundsRequestBody :: PostRefundsRequestBody Source #
Create a new PostRefundsRequestBody with all required fields.
data PostRefundsRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/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
| PostRefundsRequestBodyMetadata'EmptyString | Represents the JSON value |
| PostRefundsRequestBodyMetadata'Object Object |
Instances
data PostRefundsRequestBodyReason' Source #
Defines the enum schema located at paths./v1/refunds.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.reason in the specification.
Constructors
| PostRefundsRequestBodyReason'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostRefundsRequestBodyReason'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostRefundsRequestBodyReason'EnumDuplicate | Represents the JSON value |
| PostRefundsRequestBodyReason'EnumFraudulent | Represents the JSON value |
| PostRefundsRequestBodyReason'EnumRequestedByCustomer | Represents the JSON value |
Instances
| Eq PostRefundsRequestBodyReason' Source # | |
Defined in StripeAPI.Operations.PostRefunds | |
| Show PostRefundsRequestBodyReason' Source # | |
Defined in StripeAPI.Operations.PostRefunds Methods showsPrec :: Int -> PostRefundsRequestBodyReason' -> ShowS # show :: PostRefundsRequestBodyReason' -> String # showList :: [PostRefundsRequestBodyReason'] -> ShowS # | |
| ToJSON PostRefundsRequestBodyReason' Source # | |
Defined in StripeAPI.Operations.PostRefunds Methods toJSON :: PostRefundsRequestBodyReason' -> Value # toEncoding :: PostRefundsRequestBodyReason' -> Encoding # toJSONList :: [PostRefundsRequestBodyReason'] -> Value # toEncodingList :: [PostRefundsRequestBodyReason'] -> Encoding # | |
| FromJSON PostRefundsRequestBodyReason' Source # | |
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 # | |
Defined in StripeAPI.Operations.PostRefunds Methods (==) :: PostRefundsResponse -> PostRefundsResponse -> Bool # (/=) :: PostRefundsResponse -> PostRefundsResponse -> Bool # | |
| Show PostRefundsResponse Source # | |
Defined in StripeAPI.Operations.PostRefunds Methods showsPrec :: Int -> PostRefundsResponse -> ShowS # show :: PostRefundsResponse -> String # showList :: [PostRefundsResponse] -> ShowS # | |