| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostCharges
Description
Contains the different functions to run the operation postCharges
Synopsis
- postCharges :: forall m. MonadHTTP m => Maybe PostChargesRequestBody -> ClientT m (Response PostChargesResponse)
- data PostChargesRequestBody = PostChargesRequestBody {
- postChargesRequestBodyAmount :: Maybe Int
- postChargesRequestBodyApplicationFee :: Maybe Int
- postChargesRequestBodyApplicationFeeAmount :: Maybe Int
- postChargesRequestBodyCapture :: Maybe Bool
- postChargesRequestBodyCard :: Maybe PostChargesRequestBodyCard'Variants
- postChargesRequestBodyCurrency :: Maybe Text
- postChargesRequestBodyCustomer :: Maybe Text
- postChargesRequestBodyDescription :: Maybe Text
- postChargesRequestBodyDestination :: Maybe PostChargesRequestBodyDestination'Variants
- postChargesRequestBodyExpand :: Maybe [Text]
- postChargesRequestBodyMetadata :: Maybe PostChargesRequestBodyMetadata'Variants
- postChargesRequestBodyOnBehalfOf :: Maybe Text
- postChargesRequestBodyReceiptEmail :: Maybe Text
- postChargesRequestBodyShipping :: Maybe PostChargesRequestBodyShipping'
- postChargesRequestBodySource :: Maybe Text
- postChargesRequestBodyStatementDescriptor :: Maybe Text
- postChargesRequestBodyStatementDescriptorSuffix :: Maybe Text
- postChargesRequestBodyTransferData :: Maybe PostChargesRequestBodyTransferData'
- postChargesRequestBodyTransferGroup :: Maybe Text
- mkPostChargesRequestBody :: PostChargesRequestBody
- data PostChargesRequestBodyCard'OneOf1 = PostChargesRequestBodyCard'OneOf1 {
- postChargesRequestBodyCard'OneOf1AddressCity :: Maybe Text
- postChargesRequestBodyCard'OneOf1AddressCountry :: Maybe Text
- postChargesRequestBodyCard'OneOf1AddressLine1 :: Maybe Text
- postChargesRequestBodyCard'OneOf1AddressLine2 :: Maybe Text
- postChargesRequestBodyCard'OneOf1AddressState :: Maybe Text
- postChargesRequestBodyCard'OneOf1AddressZip :: Maybe Text
- postChargesRequestBodyCard'OneOf1Cvc :: Maybe Text
- postChargesRequestBodyCard'OneOf1ExpMonth :: Int
- postChargesRequestBodyCard'OneOf1ExpYear :: Int
- postChargesRequestBodyCard'OneOf1Metadata :: Maybe Object
- postChargesRequestBodyCard'OneOf1Name :: Maybe Text
- postChargesRequestBodyCard'OneOf1Number :: Text
- postChargesRequestBodyCard'OneOf1Object :: Maybe PostChargesRequestBodyCard'OneOf1Object'
- mkPostChargesRequestBodyCard'OneOf1 :: Int -> Int -> Text -> PostChargesRequestBodyCard'OneOf1
- data PostChargesRequestBodyCard'OneOf1Object'
- data PostChargesRequestBodyCard'Variants
- data PostChargesRequestBodyDestination'OneOf1 = PostChargesRequestBodyDestination'OneOf1 {}
- mkPostChargesRequestBodyDestination'OneOf1 :: Text -> PostChargesRequestBodyDestination'OneOf1
- data PostChargesRequestBodyDestination'Variants
- data PostChargesRequestBodyMetadata'Variants
- data PostChargesRequestBodyShipping' = PostChargesRequestBodyShipping' {}
- mkPostChargesRequestBodyShipping' :: PostChargesRequestBodyShipping'Address' -> Text -> PostChargesRequestBodyShipping'
- data PostChargesRequestBodyShipping'Address' = PostChargesRequestBodyShipping'Address' {
- postChargesRequestBodyShipping'Address'City :: Maybe Text
- postChargesRequestBodyShipping'Address'Country :: Maybe Text
- postChargesRequestBodyShipping'Address'Line1 :: Text
- postChargesRequestBodyShipping'Address'Line2 :: Maybe Text
- postChargesRequestBodyShipping'Address'PostalCode :: Maybe Text
- postChargesRequestBodyShipping'Address'State :: Maybe Text
- mkPostChargesRequestBodyShipping'Address' :: Text -> PostChargesRequestBodyShipping'Address'
- data PostChargesRequestBodyTransferData' = PostChargesRequestBodyTransferData' {}
- mkPostChargesRequestBodyTransferData' :: Text -> PostChargesRequestBodyTransferData'
- data PostChargesResponse
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => Maybe PostChargesRequestBody | The request body to send |
| -> ClientT m (Response PostChargesResponse) | Monadic computation which returns the result of the operation |
POST /v1/charges
<p>To charge a credit card or other payment source, you create a <code>Charge</code> object. If your API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged, although everything else will occur as if in live mode. (Stripe assumes that the charge would have completed successfully).</p>
data PostChargesRequestBody Source #
Defines the object schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostChargesRequestBody | |
Fields
| |
Instances
| Eq PostChargesRequestBody Source # | |
Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesRequestBody -> PostChargesRequestBody -> Bool # (/=) :: PostChargesRequestBody -> PostChargesRequestBody -> Bool # | |
| Show PostChargesRequestBody Source # | |
Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesRequestBody -> ShowS # show :: PostChargesRequestBody -> String # showList :: [PostChargesRequestBody] -> ShowS # | |
| ToJSON PostChargesRequestBody Source # | |
Defined in StripeAPI.Operations.PostCharges Methods toJSON :: PostChargesRequestBody -> Value # toEncoding :: PostChargesRequestBody -> Encoding # toJSONList :: [PostChargesRequestBody] -> Value # | |
| FromJSON PostChargesRequestBody Source # | |
Defined in StripeAPI.Operations.PostCharges Methods parseJSON :: Value -> Parser PostChargesRequestBody # parseJSONList :: Value -> Parser [PostChargesRequestBody] # | |
mkPostChargesRequestBody :: PostChargesRequestBody Source #
Create a new PostChargesRequestBody with all required fields.
data PostChargesRequestBodyCard'OneOf1 Source #
Defines the object schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.card.anyOf in the specification.
Constructors
Instances
mkPostChargesRequestBodyCard'OneOf1 Source #
Arguments
| :: Int | |
| -> Int | |
| -> Text | |
| -> PostChargesRequestBodyCard'OneOf1 |
Create a new PostChargesRequestBodyCard'OneOf1 with all required fields.
data PostChargesRequestBodyCard'OneOf1Object' Source #
Defines the enum schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.card.anyOf.properties.object in the specification.
Constructors
| PostChargesRequestBodyCard'OneOf1Object'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostChargesRequestBodyCard'OneOf1Object'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostChargesRequestBodyCard'OneOf1Object'EnumCard | Represents the JSON value |
Instances
data PostChargesRequestBodyCard'Variants Source #
Defines the oneOf schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.card.anyOf in the specification.
A token, like the ones returned by Stripe.js.
Constructors
| PostChargesRequestBodyCard'PostChargesRequestBodyCard'OneOf1 PostChargesRequestBodyCard'OneOf1 | |
| PostChargesRequestBodyCard'Text Text |
Instances
data PostChargesRequestBodyDestination'OneOf1 Source #
Defines the object schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.destination.anyOf in the specification.
Constructors
| PostChargesRequestBodyDestination'OneOf1 | |
Fields
| |
Instances
mkPostChargesRequestBodyDestination'OneOf1 Source #
Arguments
| :: Text | |
| -> PostChargesRequestBodyDestination'OneOf1 |
Create a new PostChargesRequestBodyDestination'OneOf1 with all required fields.
data PostChargesRequestBodyDestination'Variants Source #
Defines the oneOf schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.destination.anyOf in the specification.
Constructors
| PostChargesRequestBodyDestination'PostChargesRequestBodyDestination'OneOf1 PostChargesRequestBodyDestination'OneOf1 | |
| PostChargesRequestBodyDestination'Text Text |
Instances
data PostChargesRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
Constructors
| PostChargesRequestBodyMetadata'EmptyString | Represents the JSON value |
| PostChargesRequestBodyMetadata'Object Object |
Instances
data PostChargesRequestBodyShipping' Source #
Defines the object schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping in the specification.
Shipping information for the charge. Helps prevent fraud on charges for physical goods.
Constructors
| PostChargesRequestBodyShipping' | |
Fields
| |
Instances
mkPostChargesRequestBodyShipping' Source #
Create a new PostChargesRequestBodyShipping' with all required fields.
data PostChargesRequestBodyShipping'Address' Source #
Defines the object schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.shipping.properties.address in the specification.
Constructors
| PostChargesRequestBodyShipping'Address' | |
Fields
| |
Instances
mkPostChargesRequestBodyShipping'Address' Source #
Arguments
| :: Text | |
| -> PostChargesRequestBodyShipping'Address' |
Create a new PostChargesRequestBodyShipping'Address' with all required fields.
data PostChargesRequestBodyTransferData' Source #
Defines the object schema located at paths./v1/charges.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.
Constructors
| PostChargesRequestBodyTransferData' | |
Fields
| |
Instances
mkPostChargesRequestBodyTransferData' Source #
Arguments
| :: Text | |
| -> PostChargesRequestBodyTransferData' |
Create a new PostChargesRequestBodyTransferData' with all required fields.
data PostChargesResponse Source #
Represents a response of the operation postCharges.
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), PostChargesResponseError is used.
Constructors
| PostChargesResponseError String | Means either no matching case available or a parse error |
| PostChargesResponse200 Charge | Successful response. |
| PostChargesResponseDefault Error | Error response. |
Instances
| Eq PostChargesResponse Source # | |
Defined in StripeAPI.Operations.PostCharges Methods (==) :: PostChargesResponse -> PostChargesResponse -> Bool # (/=) :: PostChargesResponse -> PostChargesResponse -> Bool # | |
| Show PostChargesResponse Source # | |
Defined in StripeAPI.Operations.PostCharges Methods showsPrec :: Int -> PostChargesResponse -> ShowS # show :: PostChargesResponse -> String # showList :: [PostChargesResponse] -> ShowS # | |