Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Operations.Create_capture_purchase

Description

Contains the different functions to run the operation create_capture_purchase

Synopsis

create_capture_purchase :: forall m. MonadHTTP m => Text -> ClientT m (Response Create_capture_purchaseResponse)
data Create_capture_purchaseResponse
create_capture_purchaseWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> m (Response Create_capture_purchaseResponse)
create_capture_purchaseRaw :: forall m. MonadHTTP m => Text -> ClientT m (Response ByteString)
create_capture_purchaseWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> m (Response ByteString)

Documentation

create_capture_purchase Source #

Arguments

:: forall m. MonadHTTP m
=> Text	transaction_id: Transaction ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
-> ClientT m (Response Create_capture_purchaseResponse)	Monadic computation which returns the result of the operation

POST /purchases/{transaction_id}/capture

A purchase is a hybrid checkout containing at least one or more subscriptions or one-time charges (adjustments) and supports both coupon and gift card redemptions. All items purchased will be on one invoice and paid for with one transaction. A purchase is only a request data type and is not persistent in Recurly and an invoice collection will be the returned type.

Capture an open Authorization request

data Create_capture_purchaseResponse Source #

Represents a response of the operation create_capture_purchase.

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

Constructors

Create_capture_purchaseResponseError String	Means either no matching case available or a parse error
Create_capture_purchaseResponse200 InvoiceCollection	Returns the captured invoice
Create_capture_purchaseResponse400 Error	Bad request; perhaps missing or invalid parameters.
Create_capture_purchaseResponse422 Error	Capture purchase cannot be completed for the specified reason.
Create_capture_purchaseResponseDefault Error	Unexpected error.

Instances

Instances details

Show Create_capture_purchaseResponse Source #
Instance details Defined in RecurlyClient.Operations.Create_capture_purchase Methods showsPrec :: Int -> Create_capture_purchaseResponse -> ShowS # show :: Create_capture_purchaseResponse -> String # showList :: [Create_capture_purchaseResponse] -> ShowS #
Eq Create_capture_purchaseResponse Source #
Instance details Defined in RecurlyClient.Operations.Create_capture_purchase Methods (==) :: Create_capture_purchaseResponse -> Create_capture_purchaseResponse -> Bool # (/=) :: Create_capture_purchaseResponse -> Create_capture_purchaseResponse -> Bool #

create_capture_purchaseWithConfiguration Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Text	transaction_id: Transaction ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
-> m (Response Create_capture_purchaseResponse)	Monadic computation which returns the result of the operation

POST /purchases/{transaction_id}/capture

The same as create_capture_purchase but accepts an explicit configuration.

create_capture_purchaseRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Text	transaction_id: Transaction ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
-> ClientT m (Response ByteString)	Monadic computation which returns the result of the operation

POST /purchases/{transaction_id}/capture

The same as create_capture_purchase but returns the raw ByteString.

create_capture_purchaseWithConfigurationRaw Source #

Arguments

:: forall m. MonadHTTP m
=> Configuration	The configuration to use in the request
-> Text	transaction_id: Transaction ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
-> m (Response ByteString)	Monadic computation which returns the result of the operation

POST /purchases/{transaction_id}/capture

The same as create_capture_purchase but accepts an explicit configuration and returns the raw ByteString.