Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostChargesChargeRefunds

Contains the different functions to run the operation postChargesChargeRefunds

4 types
2 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourcePostChargesChargeRefunds.hs

valuepostChargesChargeRefunds

:: 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>

datadata PostChargesChargeRefundsRequestBody

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesChargeRefundsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds
Show PostChargesChargeRefundsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds
FromJSON PostChargesChargeRefundsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds
ToJSON PostChargesChargeRefundsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds

valuemkPostChargesChargeRefundsRequestBody :: PostChargesChargeRefundsRequestBody

Create a new PostChargesChargeRefundsRequestBody with all required fields.

datadata PostChargesChargeRefundsRequestBodyMetadata'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesChargeRefundsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds
Show PostChargesChargeRefundsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds
FromJSON PostChargesChargeRefundsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds
ToJSON PostChargesChargeRefundsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds

datadata PostChargesChargeRefundsRequestBodyReason'

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"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesChargeRefundsRequestBodyReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds
Show PostChargesChargeRefundsRequestBodyReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds
FromJSON PostChargesChargeRefundsRequestBodyReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds
ToJSON PostChargesChargeRefundsRequestBodyReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds

datadata PostChargesChargeRefundsResponse

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.

Instances2Eq, Show

Eq PostChargesChargeRefundsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds
Show PostChargesChargeRefundsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostChargesChargeRefunds