| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
RecurlyClient.Operations.Record_external_transaction
Description
Contains the different functions to run the operation record_external_transaction
Synopsis
- record_external_transaction :: forall m. MonadHTTP m => Text -> ExternalTransaction -> ClientT m (Response Record_external_transactionResponse)
- data Record_external_transactionResponse
- record_external_transactionWithConfiguration :: forall m. MonadHTTP m => Configuration -> Text -> ExternalTransaction -> m (Response Record_external_transactionResponse)
- record_external_transactionRaw :: forall m. MonadHTTP m => Text -> ExternalTransaction -> ClientT m (Response ByteString)
- record_external_transactionWithConfigurationRaw :: forall m. MonadHTTP m => Configuration -> Text -> ExternalTransaction -> m (Response ByteString)
Documentation
record_external_transaction Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. |
| -> ExternalTransaction | The request body to send |
| -> ClientT m (Response Record_external_transactionResponse) | Monadic computation which returns the result of the operation |
POST /invoices/{invoice_id}/transactionsThis endpoint allows you to record an offline payment that was not captured through your gateway. It will throw an error for an auto-collecting invoice.
data Record_external_transactionResponse Source #
Represents a response of the operation record_external_transaction.
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), Record_external_transactionResponseError is used.
Constructors
| Record_external_transactionResponseError String | Means either no matching case available or a parse error |
| Record_external_transactionResponse200 Transaction | The recorded transaction. |
| Record_external_transactionResponse404 Error | Incorrect site or invoice ID. |
| Record_external_transactionResponse422 Error | Invoice did not meet the conditions for an offline transaction. |
| Record_external_transactionResponseDefault Error | Unexpected error. |
Instances
record_external_transactionWithConfiguration Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. |
| -> ExternalTransaction | The request body to send |
| -> m (Response Record_external_transactionResponse) | Monadic computation which returns the result of the operation |
POST /invoices/{invoice_id}/transactionsThe same as record_external_transaction but accepts an explicit configuration.
record_external_transactionRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. |
| -> ExternalTransaction | The request body to send |
| -> ClientT m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /invoices/{invoice_id}/transactionsThe same as record_external_transaction but returns the raw ByteString.
record_external_transactionWithConfigurationRaw Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Configuration | The configuration to use in the request |
| -> Text | invoice_id: Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. |
| -> ExternalTransaction | The request body to send |
| -> m (Response ByteString) | Monadic computation which returns the result of the operation |
POST /invoices/{invoice_id}/transactionsThe same as record_external_transaction but accepts an explicit configuration and returns the raw ByteString.