Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postChargesChargeCapture
Synopsis
- postChargesChargeCapture :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeCaptureRequestBody -> m (Either HttpException (Response PostChargesChargeCaptureResponse))
- postChargesChargeCaptureRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeCaptureRequestBody -> m (Either HttpException (Response ByteString))
- postChargesChargeCaptureM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeCaptureRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeCaptureResponse))
- postChargesChargeCaptureRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeCaptureRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostChargesChargeCaptureRequestBody = PostChargesChargeCaptureRequestBody {
- postChargesChargeCaptureRequestBodyAmount :: Maybe Integer
- postChargesChargeCaptureRequestBodyApplicationFee :: Maybe Integer
- postChargesChargeCaptureRequestBodyApplicationFeeAmount :: Maybe Integer
- postChargesChargeCaptureRequestBodyExpand :: Maybe ([] Text)
- postChargesChargeCaptureRequestBodyReceiptEmail :: Maybe Text
- postChargesChargeCaptureRequestBodyStatementDescriptor :: Maybe Text
- postChargesChargeCaptureRequestBodyStatementDescriptorSuffix :: Maybe Text
- postChargesChargeCaptureRequestBodyTransferData :: Maybe PostChargesChargeCaptureRequestBodyTransferData'
- postChargesChargeCaptureRequestBodyTransferGroup :: Maybe Text
- data PostChargesChargeCaptureRequestBodyTransferData' = PostChargesChargeCaptureRequestBodyTransferData' {}
- data PostChargesChargeCaptureResponse
Documentation
postChargesChargeCapture Source #
:: (MonadHTTP m, SecurityScheme s) | |
=> Configuration s | The configuration to use in the request |
-> Text | charge | Constraints: Maximum length of 5000 |
-> Maybe 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>
postChargesChargeCaptureRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeCaptureRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/charges/{charge}/capture
The same as postChargesChargeCapture
but returns the raw ByteString
postChargesChargeCaptureM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeCaptureRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeCaptureResponse)) Source #
POST /v1/charges/{charge}/capture
Monadic version of postChargesChargeCapture
(use with runWithConfiguration
)
postChargesChargeCaptureRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeCaptureRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/charges/{charge}/capture
Monadic version of postChargesChargeCaptureRaw
(use with runWithConfiguration
)
data PostChargesChargeCaptureRequestBody Source #
Defines the data type for the schema postChargesChargeCaptureRequestBody
PostChargesChargeCaptureRequestBody | |
|
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
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.
PostChargesChargeCaptureResponseError String | Means either no matching case available or a parse error |
PostChargesChargeCaptureResponse200 Charge | Successful response. |
PostChargesChargeCaptureResponseDefault Error | Error response. |