Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postChargesChargeCapture
Synopsis
- postChargesChargeCapture :: forall m. MonadHTTP m => Text -> Maybe PostChargesChargeCaptureRequestBody -> ClientT m (Response PostChargesChargeCaptureResponse)
- data PostChargesChargeCaptureRequestBody = PostChargesChargeCaptureRequestBody {
- postChargesChargeCaptureRequestBodyAmount :: Maybe Int
- postChargesChargeCaptureRequestBodyApplicationFee :: Maybe Int
- postChargesChargeCaptureRequestBodyApplicationFeeAmount :: Maybe Int
- postChargesChargeCaptureRequestBodyExpand :: Maybe [Text]
- postChargesChargeCaptureRequestBodyReceiptEmail :: Maybe Text
- postChargesChargeCaptureRequestBodyStatementDescriptor :: Maybe Text
- postChargesChargeCaptureRequestBodyStatementDescriptorSuffix :: Maybe Text
- postChargesChargeCaptureRequestBodyTransferData :: Maybe PostChargesChargeCaptureRequestBodyTransferData'
- postChargesChargeCaptureRequestBodyTransferGroup :: Maybe Text
- mkPostChargesChargeCaptureRequestBody :: PostChargesChargeCaptureRequestBody
- data PostChargesChargeCaptureRequestBodyTransferData' = PostChargesChargeCaptureRequestBodyTransferData' {}
- mkPostChargesChargeCaptureRequestBodyTransferData' :: PostChargesChargeCaptureRequestBodyTransferData'
- data PostChargesChargeCaptureResponse
Documentation
postChargesChargeCapture Source #
:: forall m. MonadHTTP m | |
=> Text | charge | Constraints: Maximum length of 5000 |
-> Maybe PostChargesChargeCaptureRequestBody | The request body to send |
-> ClientT m (Response PostChargesChargeCaptureResponse) | Monadic computation which returns 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 object schema located at paths./v1/charges/{charge}/capture.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
PostChargesChargeCaptureRequestBody | |
|
mkPostChargesChargeCaptureRequestBody :: PostChargesChargeCaptureRequestBody Source #
Create a new PostChargesChargeCaptureRequestBody
with all required fields.
data PostChargesChargeCaptureRequestBodyTransferData' Source #
Defines the object schema located at paths./v1/charges/{charge}/capture.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.transfer_data
in the specification.
An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.
Instances
mkPostChargesChargeCaptureRequestBodyTransferData' :: PostChargesChargeCaptureRequestBodyTransferData' Source #
Create a new PostChargesChargeCaptureRequestBodyTransferData'
with all required fields.
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. |