Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostRefunds

Contains the different functions to run the operation postRefunds

4 types
2 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourcePostRefunds.hs

valuepostRefunds

:: MonadHTTP m
=> Maybe PostRefundsRequestBody
The request body to send
-> ClientT m (Response PostRefundsResponse)
Monadic computation which returns the result of the operation

POST /v1/refunds

<p>Create a refund.</p>

datadata PostRefundsRequestBody

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

Constructors

PostRefundsRequestBody
- postRefundsRequestBodyAmount :: Maybe Int
  amount
- postRefundsRequestBodyCharge :: Maybe Text
  charge
  Constraints:
  - Maximum length of 5000
- postRefundsRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postRefundsRequestBodyInstructionsEmail :: Maybe Text
  instructions_email
- postRefundsRequestBodyMetadata :: Maybe PostRefundsRequestBodyMetadata'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`.
- postRefundsRequestBodyPaymentIntent :: Maybe Text
  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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostRefundsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds
Show PostRefundsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds
FromJSON PostRefundsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds
ToJSON PostRefundsRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds

valuemkPostRefundsRequestBody :: PostRefundsRequestBody

Create a new PostRefundsRequestBody with all required fields.

datadata PostRefundsRequestBodyMetadata'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostRefundsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds
Show PostRefundsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds
FromJSON PostRefundsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds
ToJSON PostRefundsRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds

datadata PostRefundsRequestBodyReason'

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 "duplicate"
PostRefundsRequestBodyReason'EnumFraudulent
Represents the JSON value "fraudulent"
PostRefundsRequestBodyReason'EnumRequestedByCustomer
Represents the JSON value "requested_by_customer"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostRefundsRequestBodyReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds
Show PostRefundsRequestBodyReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds
FromJSON PostRefundsRequestBodyReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds
ToJSON PostRefundsRequestBodyReason'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds

datadata PostRefundsResponse

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.

Instances2Eq, Show

Eq PostRefundsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds
Show PostRefundsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostRefunds