Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostCharges

Contains the different functions to run the operation postCharges

12 types
8 values

Packagestripeapi-3.0.0.0
Exports20
LanguageHaskell2010
LicenceMIT
SourcePostCharges.hs

valuepostCharges

:: 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>

datadata PostChargesRequestBody

Defines the object schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostChargesRequestBody
- postChargesRequestBodyAmount :: Maybe Int
  amount: Amount intended to be collected by this payment. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
- postChargesRequestBodyApplicationFee :: Maybe Int
  application_fee
- postChargesRequestBodyApplicationFeeAmount :: Maybe Int
  application_fee_amount: A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees documentation.
- postChargesRequestBodyCapture :: Maybe Bool
  capture: Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be captured later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the authorizing charges and settling later documentation.
- postChargesRequestBodyCard :: Maybe PostChargesRequestBodyCard'Variants
  card: A token, like the ones returned by Stripe.js.
- postChargesRequestBodyCurrency :: Maybe Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- postChargesRequestBodyCustomer :: Maybe Text
  customer: The ID of an existing customer that will be charged in this request.
  Constraints:
  - Maximum length of 500
- postChargesRequestBodyDescription :: Maybe Text
  description: An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.
  Constraints:
  - Maximum length of 40000
- postChargesRequestBodyDestination :: Maybe PostChargesRequestBodyDestination'Variants
  destination
- postChargesRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postChargesRequestBodyMetadata :: Maybe PostChargesRequestBodyMetadata'Variants
  metadata: 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`.
- postChargesRequestBodyOnBehalfOf :: Maybe Text
  on_behalf_of: The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see Creating Separate Charges and Transfers.
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyRadarOptions :: Maybe PostChargesRequestBodyRadarOptions'
  radar_options: Options to configure Radar. See Radar Session for more information.
- postChargesRequestBodyReceiptEmail :: Maybe Text
  receipt_email: The email address to which this charge's receipt will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a Customer, the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your email settings.
- postChargesRequestBodyShipping :: Maybe PostChargesRequestBodyShipping'
  shipping: Shipping information for the charge. Helps prevent fraud on charges for physical goods.
- postChargesRequestBodySource :: Maybe Text
  source: A payment source to be charged. This can be the ID of a card (i.e., credit or debit card), a bank account, a source, a token, or a connected account. For certain sources---namely, cards, bank accounts, and attached sources---you must also pass the ID of the associated customer.
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyStatementDescriptor :: Maybe Text
  statement_descriptor: For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters.
  Constraints:
  - Maximum length of 22
- postChargesRequestBodyStatementDescriptorSuffix :: Maybe Text
  statement_descriptor_suffix: Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
  Constraints:
  - Maximum length of 22
- postChargesRequestBodyTransferData :: Maybe PostChargesRequestBodyTransferData'
  transfer_data: An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.
- postChargesRequestBodyTransferGroup :: Maybe Text
  transfer_group: A string that identifies this transaction as part of a group. For details, see Grouping transactions.

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

valuemkPostChargesRequestBody :: PostChargesRequestBody

Create a new PostChargesRequestBody with all required fields.

datadata PostChargesRequestBodyCard'OneOf1

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

PostChargesRequestBodyCard'OneOf1
- postChargesRequestBodyCard'OneOf1AddressCity :: Maybe Text
  address_city
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyCard'OneOf1AddressCountry :: Maybe Text
  address_country
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyCard'OneOf1AddressLine1 :: Maybe Text
  address_line1
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyCard'OneOf1AddressLine2 :: Maybe Text
  address_line2
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyCard'OneOf1AddressState :: Maybe Text
  address_state
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyCard'OneOf1AddressZip :: Maybe Text
  address_zip
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyCard'OneOf1Cvc :: Maybe Text
  cvc
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyCard'OneOf1ExpMonth :: Int
  exp_month
- postChargesRequestBodyCard'OneOf1ExpYear :: Int
  exp_year
- postChargesRequestBodyCard'OneOf1Metadata :: Maybe Object
  metadata
- postChargesRequestBodyCard'OneOf1Name :: Maybe Text
  name
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyCard'OneOf1Number :: Text
  number
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyCard'OneOf1Object :: Maybe PostChargesRequestBodyCard'OneOf1Object'
  object
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyCard'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyCard'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyCard'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyCard'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

valuemkPostChargesRequestBodyCard'OneOf1

:: Int
postChargesRequestBodyCard'OneOf1ExpMonth
-> Int
postChargesRequestBodyCard'OneOf1ExpYear
-> Text
postChargesRequestBodyCard'OneOf1Number
-> PostChargesRequestBodyCard'OneOf1

Create a new PostChargesRequestBodyCard'OneOf1 with all required fields.

datadata PostChargesRequestBodyCard'OneOf1Object'

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 "card"

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyCard'OneOf1Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyCard'OneOf1Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyCard'OneOf1Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyCard'OneOf1Object'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

datadata PostChargesRequestBodyCard'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyCard'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyCard'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyCard'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyCard'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

datadata PostChargesRequestBodyDestination'OneOf1

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
- postChargesRequestBodyDestination'OneOf1Account :: Text
  account
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyDestination'OneOf1Amount :: Maybe Int
  amount

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyDestination'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyDestination'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyDestination'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyDestination'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

valuemkPostChargesRequestBodyDestination'OneOf1

:: Text
postChargesRequestBodyDestination'OneOf1Account
-> PostChargesRequestBodyDestination'OneOf1

Create a new PostChargesRequestBodyDestination'OneOf1 with all required fields.

datadata PostChargesRequestBodyDestination'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

datadata PostChargesRequestBodyMetadata'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyMetadata'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

datadata PostChargesRequestBodyRadarOptions'

Defines the object schema located at paths./v1/charges.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.radar_options in the specification.

Options to configure Radar. See Radar Session for more information.

Constructors

PostChargesRequestBodyRadarOptions'
- postChargesRequestBodyRadarOptions'Session :: Maybe Text
  session
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyRadarOptions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyRadarOptions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyRadarOptions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyRadarOptions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

valuemkPostChargesRequestBodyRadarOptions' :: PostChargesRequestBodyRadarOptions'

Create a new PostChargesRequestBodyRadarOptions' with all required fields.

datadata PostChargesRequestBodyShipping'

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'
- postChargesRequestBodyShipping'Address :: PostChargesRequestBodyShipping'Address'
  address
- postChargesRequestBodyShipping'Carrier :: Maybe Text
  carrier
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyShipping'Name :: Text
  name
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyShipping'Phone :: Maybe Text
  phone
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyShipping'TrackingNumber :: Maybe Text
  tracking_number
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyShipping'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyShipping'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyShipping'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyShipping'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

valuemkPostChargesRequestBodyShipping'

:: PostChargesRequestBodyShipping'Address'
postChargesRequestBodyShipping'Address
-> Text
postChargesRequestBodyShipping'Name
-> PostChargesRequestBodyShipping'

Create a new PostChargesRequestBodyShipping' with all required fields.

datadata PostChargesRequestBodyShipping'Address'

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'
- postChargesRequestBodyShipping'Address'City :: Maybe Text
  city
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyShipping'Address'Country :: Maybe Text
  country
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyShipping'Address'Line1 :: Maybe Text
  line1
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyShipping'Address'Line2 :: Maybe Text
  line2
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyShipping'Address'PostalCode :: Maybe Text
  postal_code
  Constraints:
  - Maximum length of 5000
- postChargesRequestBodyShipping'Address'State :: Maybe Text
  state
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyShipping'Address'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyShipping'Address'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyShipping'Address'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyShipping'Address'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

valuemkPostChargesRequestBodyShipping'Address' :: PostChargesRequestBodyShipping'Address'

Create a new PostChargesRequestBodyShipping'Address' with all required fields.

datadata PostChargesRequestBodyTransferData'

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'
- postChargesRequestBodyTransferData'Amount :: Maybe Int
  amount
- postChargesRequestBodyTransferData'Destination :: Text
  destination
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostChargesRequestBodyTransferData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesRequestBodyTransferData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
FromJSON PostChargesRequestBodyTransferData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
ToJSON PostChargesRequestBodyTransferData'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges

valuemkPostChargesRequestBodyTransferData'

:: Text
postChargesRequestBodyTransferData'Destination
-> PostChargesRequestBodyTransferData'

Create a new PostChargesRequestBodyTransferData' with all required fields.

datadata PostChargesResponse

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.

Instances2Eq, Show

Eq PostChargesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges
Show PostChargesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostCharges