stripeapi-1.0.0.0: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostRefunds

Description

Contains the different functions to run the operation postRefunds

Synopsis

Documentation

postRefunds Source #

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

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`.

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 "duplicate"

PostRefundsRequestBodyReason'EnumFraudulent

Represents the JSON value "fraudulent"

PostRefundsRequestBodyReason'EnumRequestedByCustomer

Represents the JSON value "requested_by_customer"

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.