stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.PostChargesChargeCapture

Description

Contains the different functions to run the operation postChargesChargeCapture

Synopsis

Documentation

postChargesChargeCapture Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> String

charge | Constraints: Maximum length of 5000

-> PostChargesChargeCaptureRequestBody

The request body to send

-> m (Either HttpException (Response PostChargesChargeCaptureResponse))

Monad containing the result of the operation

POST /v1/charges/{charge}/capture

<p>Capture the payment of an existing, uncaptured, charge. This is the second half of the two-step payment flow, where first you <a href="#create_charge">created a charge</a> with the capture option set to false.</p>

<p>Uncaptured payments expire exactly seven days after they are created. If they are not captured by that point in time, they will be marked as refunded and will no longer be capturable.</p>

data PostChargesChargeCaptureRequestBody Source #

Defines the data type for the schema postChargesChargeCaptureRequestBody

Constructors

PostChargesChargeCaptureRequestBody 

Fields

data PostChargesChargeCaptureRequestBodyTransferData' Source #

Defines the data type for the schema postChargesChargeCaptureRequestBodyTransfer_data'

An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.

Instances
Eq PostChargesChargeCaptureRequestBodyTransferData' Source # 
Instance details

Defined in StripeAPI.Operations.PostChargesChargeCapture

Show PostChargesChargeCaptureRequestBodyTransferData' Source # 
Instance details

Defined in StripeAPI.Operations.PostChargesChargeCapture

ToJSON PostChargesChargeCaptureRequestBodyTransferData' Source # 
Instance details

Defined in StripeAPI.Operations.PostChargesChargeCapture

FromJSON PostChargesChargeCaptureRequestBodyTransferData' Source # 
Instance details

Defined in StripeAPI.Operations.PostChargesChargeCapture

data PostChargesChargeCaptureResponse Source #

Represents a response of the operation postChargesChargeCapture.

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), PostChargesChargeCaptureResponseError is used.

Constructors

PostChargesChargeCaptureResponseError String

Means either no matching case available or a parse error

PostChargesChargeCaptureResponse200 Charge

Successful response.

PostChargesChargeCaptureResponseDefault Error

Error response.