Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the types generated from the schema Charge
Synopsis
- data Charge = Charge {
- chargeAmount :: Int
- chargeAmountCaptured :: Int
- chargeAmountRefunded :: Int
- chargeApplication :: Maybe ChargeApplication'Variants
- chargeApplicationFee :: Maybe ChargeApplicationFee'Variants
- chargeApplicationFeeAmount :: Maybe Int
- chargeBalanceTransaction :: Maybe ChargeBalanceTransaction'Variants
- chargeBillingDetails :: BillingDetails
- chargeCalculatedStatementDescriptor :: Maybe Text
- chargeCaptured :: Bool
- chargeCreated :: Int
- chargeCurrency :: Text
- chargeCustomer :: Maybe ChargeCustomer'Variants
- chargeDescription :: Maybe Text
- chargeDisputed :: Bool
- chargeFailureCode :: Maybe Text
- chargeFailureMessage :: Maybe Text
- chargeFraudDetails :: Maybe ChargeFraudDetails'
- chargeId :: Text
- chargeInvoice :: Maybe ChargeInvoice'Variants
- chargeLivemode :: Bool
- chargeMetadata :: Object
- chargeOnBehalfOf :: Maybe ChargeOnBehalfOf'Variants
- chargeOrder :: Maybe ChargeOrder'Variants
- chargeOutcome :: Maybe ChargeOutcome'
- chargePaid :: Bool
- chargePaymentIntent :: Maybe ChargePaymentIntent'Variants
- chargePaymentMethod :: Maybe Text
- chargePaymentMethodDetails :: Maybe ChargePaymentMethodDetails'
- chargeReceiptEmail :: Maybe Text
- chargeReceiptNumber :: Maybe Text
- chargeReceiptUrl :: Maybe Text
- chargeRefunded :: Bool
- chargeRefunds :: ChargeRefunds'
- chargeReview :: Maybe ChargeReview'Variants
- chargeShipping :: Maybe ChargeShipping'
- chargeSourceTransfer :: Maybe ChargeSourceTransfer'Variants
- chargeStatementDescriptor :: Maybe Text
- chargeStatementDescriptorSuffix :: Maybe Text
- chargeStatus :: Text
- chargeTransfer :: Maybe ChargeTransfer'Variants
- chargeTransferData :: Maybe ChargeTransferData'
- chargeTransferGroup :: Maybe Text
- mkCharge :: Int -> Int -> Int -> BillingDetails -> Bool -> Int -> Text -> Bool -> Text -> Bool -> Object -> Bool -> Bool -> ChargeRefunds' -> Text -> Charge
- data ChargeApplication'Variants
- data ChargeApplicationFee'Variants
- data ChargeBalanceTransaction'Variants
- data ChargeCustomer'Variants
- data ChargeFraudDetails' = ChargeFraudDetails' {}
- mkChargeFraudDetails' :: ChargeFraudDetails'
- data ChargeInvoice'Variants
- data ChargeOnBehalfOf'Variants
- data ChargeOrder'Variants
- data ChargeOutcome' = ChargeOutcome' {}
- mkChargeOutcome' :: ChargeOutcome'
- data ChargeOutcome'Rule'Variants
- data ChargePaymentIntent'Variants
- data ChargePaymentMethodDetails' = ChargePaymentMethodDetails' {
- chargePaymentMethodDetails'AchCreditTransfer :: Maybe PaymentMethodDetailsAchCreditTransfer
- chargePaymentMethodDetails'AchDebit :: Maybe PaymentMethodDetailsAchDebit
- chargePaymentMethodDetails'AcssDebit :: Maybe PaymentMethodDetailsAcssDebit
- chargePaymentMethodDetails'AfterpayClearpay :: Maybe PaymentMethodDetailsAfterpayClearpay
- chargePaymentMethodDetails'Alipay :: Maybe PaymentFlowsPrivatePaymentMethodsAlipayDetails
- chargePaymentMethodDetails'AuBecsDebit :: Maybe PaymentMethodDetailsAuBecsDebit
- chargePaymentMethodDetails'BacsDebit :: Maybe PaymentMethodDetailsBacsDebit
- chargePaymentMethodDetails'Bancontact :: Maybe PaymentMethodDetailsBancontact
- chargePaymentMethodDetails'Boleto :: Maybe PaymentMethodDetailsBoleto
- chargePaymentMethodDetails'Card :: Maybe PaymentMethodDetailsCard
- chargePaymentMethodDetails'CardPresent :: Maybe PaymentMethodDetailsCardPresent
- chargePaymentMethodDetails'Eps :: Maybe PaymentMethodDetailsEps
- chargePaymentMethodDetails'Fpx :: Maybe PaymentMethodDetailsFpx
- chargePaymentMethodDetails'Giropay :: Maybe PaymentMethodDetailsGiropay
- chargePaymentMethodDetails'Grabpay :: Maybe PaymentMethodDetailsGrabpay
- chargePaymentMethodDetails'Ideal :: Maybe PaymentMethodDetailsIdeal
- chargePaymentMethodDetails'InteracPresent :: Maybe PaymentMethodDetailsInteracPresent
- chargePaymentMethodDetails'Klarna :: Maybe PaymentMethodDetailsKlarna
- chargePaymentMethodDetails'Multibanco :: Maybe PaymentMethodDetailsMultibanco
- chargePaymentMethodDetails'Oxxo :: Maybe PaymentMethodDetailsOxxo
- chargePaymentMethodDetails'P24 :: Maybe PaymentMethodDetailsP24
- chargePaymentMethodDetails'SepaDebit :: Maybe PaymentMethodDetailsSepaDebit
- chargePaymentMethodDetails'Sofort :: Maybe PaymentMethodDetailsSofort
- chargePaymentMethodDetails'StripeAccount :: Maybe PaymentMethodDetailsStripeAccount
- chargePaymentMethodDetails'Type :: Maybe Text
- chargePaymentMethodDetails'Wechat :: Maybe PaymentMethodDetailsWechat
- mkChargePaymentMethodDetails' :: ChargePaymentMethodDetails'
- data ChargeRefunds' = ChargeRefunds' {}
- mkChargeRefunds' :: [Refund] -> Bool -> Text -> ChargeRefunds'
- data ChargeReview'Variants
- data ChargeShipping' = ChargeShipping' {}
- mkChargeShipping' :: ChargeShipping'
- data ChargeSourceTransfer'Variants
- data ChargeTransfer'Variants
- data ChargeTransferData' = ChargeTransferData' {}
- mkChargeTransferData' :: ChargeTransferData'
- data ChargeTransferData'Destination'Variants
Documentation
Defines the object schema located at components.schemas.charge
in the specification.
To charge a credit or a debit card, you create a `Charge` object. You can retrieve and refund individual charges as well as list all charges. Charges are identified by a unique, random ID.
Related guide: Accept a payment with the Charges API.
Charge | |
|
:: Int | |
-> Int | |
-> Int | |
-> BillingDetails | |
-> Bool | |
-> Int | |
-> Text | |
-> Bool | |
-> Text | |
-> Bool | |
-> Object | |
-> Bool | |
-> Bool | |
-> ChargeRefunds' | |
-> Text | |
-> Charge |
Create a new Charge
with all required fields.
data ChargeApplication'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.application.anyOf
in the specification.
ID of the Connect application that created the charge.
Instances
Eq ChargeApplication'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
Show ChargeApplication'Variants Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeApplication'Variants -> ShowS # show :: ChargeApplication'Variants -> String # showList :: [ChargeApplication'Variants] -> ShowS # | |
ToJSON ChargeApplication'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
FromJSON ChargeApplication'Variants Source # | |
Defined in StripeAPI.Types.Charge |
data ChargeApplicationFee'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.application_fee.anyOf
in the specification.
The application fee (if any) for the charge. See the Connect documentation for details.
Instances
data ChargeBalanceTransaction'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.balance_transaction.anyOf
in the specification.
ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).
data ChargeCustomer'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.customer.anyOf
in the specification.
ID of the customer this charge is for if one exists.
ChargeCustomer'Text Text | |
ChargeCustomer'Customer Customer | |
ChargeCustomer'DeletedCustomer DeletedCustomer |
Instances
Eq ChargeCustomer'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
Show ChargeCustomer'Variants Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeCustomer'Variants -> ShowS # show :: ChargeCustomer'Variants -> String # showList :: [ChargeCustomer'Variants] -> ShowS # | |
ToJSON ChargeCustomer'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
FromJSON ChargeCustomer'Variants Source # | |
Defined in StripeAPI.Types.Charge |
data ChargeFraudDetails' Source #
Defines the object schema located at components.schemas.charge.properties.fraud_details.anyOf
in the specification.
Information on fraud assessments for the charge.
ChargeFraudDetails' | |
|
Instances
Eq ChargeFraudDetails' Source # | |
Defined in StripeAPI.Types.Charge (==) :: ChargeFraudDetails' -> ChargeFraudDetails' -> Bool # (/=) :: ChargeFraudDetails' -> ChargeFraudDetails' -> Bool # | |
Show ChargeFraudDetails' Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeFraudDetails' -> ShowS # show :: ChargeFraudDetails' -> String # showList :: [ChargeFraudDetails'] -> ShowS # | |
ToJSON ChargeFraudDetails' Source # | |
Defined in StripeAPI.Types.Charge toJSON :: ChargeFraudDetails' -> Value # toEncoding :: ChargeFraudDetails' -> Encoding # toJSONList :: [ChargeFraudDetails'] -> Value # toEncodingList :: [ChargeFraudDetails'] -> Encoding # | |
FromJSON ChargeFraudDetails' Source # | |
Defined in StripeAPI.Types.Charge parseJSON :: Value -> Parser ChargeFraudDetails' # parseJSONList :: Value -> Parser [ChargeFraudDetails'] # |
mkChargeFraudDetails' :: ChargeFraudDetails' Source #
Create a new ChargeFraudDetails'
with all required fields.
data ChargeInvoice'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.invoice.anyOf
in the specification.
ID of the invoice this charge is for if one exists.
Instances
Eq ChargeInvoice'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
Show ChargeInvoice'Variants Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeInvoice'Variants -> ShowS # show :: ChargeInvoice'Variants -> String # showList :: [ChargeInvoice'Variants] -> ShowS # | |
ToJSON ChargeInvoice'Variants Source # | |
Defined in StripeAPI.Types.Charge toJSON :: ChargeInvoice'Variants -> Value # toEncoding :: ChargeInvoice'Variants -> Encoding # toJSONList :: [ChargeInvoice'Variants] -> Value # | |
FromJSON ChargeInvoice'Variants Source # | |
Defined in StripeAPI.Types.Charge |
data ChargeOnBehalfOf'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.on_behalf_of.anyOf
in the specification.
The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.
Instances
Eq ChargeOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
Show ChargeOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeOnBehalfOf'Variants -> ShowS # show :: ChargeOnBehalfOf'Variants -> String # showList :: [ChargeOnBehalfOf'Variants] -> ShowS # | |
ToJSON ChargeOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
FromJSON ChargeOnBehalfOf'Variants Source # | |
Defined in StripeAPI.Types.Charge |
data ChargeOrder'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.order.anyOf
in the specification.
ID of the order this charge is for if one exists.
Instances
Eq ChargeOrder'Variants Source # | |
Defined in StripeAPI.Types.Charge (==) :: ChargeOrder'Variants -> ChargeOrder'Variants -> Bool # (/=) :: ChargeOrder'Variants -> ChargeOrder'Variants -> Bool # | |
Show ChargeOrder'Variants Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeOrder'Variants -> ShowS # show :: ChargeOrder'Variants -> String # showList :: [ChargeOrder'Variants] -> ShowS # | |
ToJSON ChargeOrder'Variants Source # | |
Defined in StripeAPI.Types.Charge toJSON :: ChargeOrder'Variants -> Value # toEncoding :: ChargeOrder'Variants -> Encoding # toJSONList :: [ChargeOrder'Variants] -> Value # toEncodingList :: [ChargeOrder'Variants] -> Encoding # | |
FromJSON ChargeOrder'Variants Source # | |
Defined in StripeAPI.Types.Charge parseJSON :: Value -> Parser ChargeOrder'Variants # parseJSONList :: Value -> Parser [ChargeOrder'Variants] # |
data ChargeOutcome' Source #
Defines the object schema located at components.schemas.charge.properties.outcome.anyOf
in the specification.
Details about whether the payment was accepted, and why. See understanding declines for details.
ChargeOutcome' | |
|
Instances
Eq ChargeOutcome' Source # | |
Defined in StripeAPI.Types.Charge (==) :: ChargeOutcome' -> ChargeOutcome' -> Bool # (/=) :: ChargeOutcome' -> ChargeOutcome' -> Bool # | |
Show ChargeOutcome' Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeOutcome' -> ShowS # show :: ChargeOutcome' -> String # showList :: [ChargeOutcome'] -> ShowS # | |
ToJSON ChargeOutcome' Source # | |
Defined in StripeAPI.Types.Charge toJSON :: ChargeOutcome' -> Value # toEncoding :: ChargeOutcome' -> Encoding # toJSONList :: [ChargeOutcome'] -> Value # toEncodingList :: [ChargeOutcome'] -> Encoding # | |
FromJSON ChargeOutcome' Source # | |
Defined in StripeAPI.Types.Charge parseJSON :: Value -> Parser ChargeOutcome' # parseJSONList :: Value -> Parser [ChargeOutcome'] # |
mkChargeOutcome' :: ChargeOutcome' Source #
Create a new ChargeOutcome'
with all required fields.
data ChargeOutcome'Rule'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.outcome.anyOf.properties.rule.anyOf
in the specification.
The ID of the Radar rule that matched the payment, if applicable.
Instances
Eq ChargeOutcome'Rule'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
Show ChargeOutcome'Rule'Variants Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeOutcome'Rule'Variants -> ShowS # show :: ChargeOutcome'Rule'Variants -> String # showList :: [ChargeOutcome'Rule'Variants] -> ShowS # | |
ToJSON ChargeOutcome'Rule'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
FromJSON ChargeOutcome'Rule'Variants Source # | |
Defined in StripeAPI.Types.Charge |
data ChargePaymentIntent'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.payment_intent.anyOf
in the specification.
ID of the PaymentIntent associated with this charge, if one exists.
Instances
Eq ChargePaymentIntent'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
Show ChargePaymentIntent'Variants Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargePaymentIntent'Variants -> ShowS # show :: ChargePaymentIntent'Variants -> String # showList :: [ChargePaymentIntent'Variants] -> ShowS # | |
ToJSON ChargePaymentIntent'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
FromJSON ChargePaymentIntent'Variants Source # | |
Defined in StripeAPI.Types.Charge |
data ChargePaymentMethodDetails' Source #
Defines the object schema located at components.schemas.charge.properties.payment_method_details.anyOf
in the specification.
Details about the payment method at the time of the transaction.
Instances
Eq ChargePaymentMethodDetails' Source # | |
Defined in StripeAPI.Types.Charge | |
Show ChargePaymentMethodDetails' Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargePaymentMethodDetails' -> ShowS # show :: ChargePaymentMethodDetails' -> String # showList :: [ChargePaymentMethodDetails'] -> ShowS # | |
ToJSON ChargePaymentMethodDetails' Source # | |
Defined in StripeAPI.Types.Charge | |
FromJSON ChargePaymentMethodDetails' Source # | |
Defined in StripeAPI.Types.Charge |
mkChargePaymentMethodDetails' :: ChargePaymentMethodDetails' Source #
Create a new ChargePaymentMethodDetails'
with all required fields.
data ChargeRefunds' Source #
Defines the object schema located at components.schemas.charge.properties.refunds
in the specification.
A list of refunds that have been applied to the charge.
ChargeRefunds' | |
|
Instances
Eq ChargeRefunds' Source # | |
Defined in StripeAPI.Types.Charge (==) :: ChargeRefunds' -> ChargeRefunds' -> Bool # (/=) :: ChargeRefunds' -> ChargeRefunds' -> Bool # | |
Show ChargeRefunds' Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeRefunds' -> ShowS # show :: ChargeRefunds' -> String # showList :: [ChargeRefunds'] -> ShowS # | |
ToJSON ChargeRefunds' Source # | |
Defined in StripeAPI.Types.Charge toJSON :: ChargeRefunds' -> Value # toEncoding :: ChargeRefunds' -> Encoding # toJSONList :: [ChargeRefunds'] -> Value # toEncodingList :: [ChargeRefunds'] -> Encoding # | |
FromJSON ChargeRefunds' Source # | |
Defined in StripeAPI.Types.Charge parseJSON :: Value -> Parser ChargeRefunds' # parseJSONList :: Value -> Parser [ChargeRefunds'] # |
Create a new ChargeRefunds'
with all required fields.
data ChargeReview'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.review.anyOf
in the specification.
ID of the review associated with this charge if one exists.
Instances
Eq ChargeReview'Variants Source # | |
Defined in StripeAPI.Types.Charge (==) :: ChargeReview'Variants -> ChargeReview'Variants -> Bool # (/=) :: ChargeReview'Variants -> ChargeReview'Variants -> Bool # | |
Show ChargeReview'Variants Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeReview'Variants -> ShowS # show :: ChargeReview'Variants -> String # showList :: [ChargeReview'Variants] -> ShowS # | |
ToJSON ChargeReview'Variants Source # | |
Defined in StripeAPI.Types.Charge toJSON :: ChargeReview'Variants -> Value # toEncoding :: ChargeReview'Variants -> Encoding # toJSONList :: [ChargeReview'Variants] -> Value # toEncodingList :: [ChargeReview'Variants] -> Encoding # | |
FromJSON ChargeReview'Variants Source # | |
Defined in StripeAPI.Types.Charge parseJSON :: Value -> Parser ChargeReview'Variants # parseJSONList :: Value -> Parser [ChargeReview'Variants] # |
data ChargeShipping' Source #
Defines the object schema located at components.schemas.charge.properties.shipping.anyOf
in the specification.
Shipping information for the charge.
ChargeShipping' | |
|
Instances
Eq ChargeShipping' Source # | |
Defined in StripeAPI.Types.Charge (==) :: ChargeShipping' -> ChargeShipping' -> Bool # (/=) :: ChargeShipping' -> ChargeShipping' -> Bool # | |
Show ChargeShipping' Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeShipping' -> ShowS # show :: ChargeShipping' -> String # showList :: [ChargeShipping'] -> ShowS # | |
ToJSON ChargeShipping' Source # | |
Defined in StripeAPI.Types.Charge toJSON :: ChargeShipping' -> Value # toEncoding :: ChargeShipping' -> Encoding # toJSONList :: [ChargeShipping'] -> Value # toEncodingList :: [ChargeShipping'] -> Encoding # | |
FromJSON ChargeShipping' Source # | |
Defined in StripeAPI.Types.Charge parseJSON :: Value -> Parser ChargeShipping' # parseJSONList :: Value -> Parser [ChargeShipping'] # |
mkChargeShipping' :: ChargeShipping' Source #
Create a new ChargeShipping'
with all required fields.
data ChargeSourceTransfer'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.source_transfer.anyOf
in the specification.
The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.
Instances
data ChargeTransfer'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.transfer.anyOf
in the specification.
ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).
Instances
Eq ChargeTransfer'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
Show ChargeTransfer'Variants Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeTransfer'Variants -> ShowS # show :: ChargeTransfer'Variants -> String # showList :: [ChargeTransfer'Variants] -> ShowS # | |
ToJSON ChargeTransfer'Variants Source # | |
Defined in StripeAPI.Types.Charge | |
FromJSON ChargeTransfer'Variants Source # | |
Defined in StripeAPI.Types.Charge |
data ChargeTransferData' Source #
Defines the object schema located at components.schemas.charge.properties.transfer_data.anyOf
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.
ChargeTransferData' | |
|
Instances
Eq ChargeTransferData' Source # | |
Defined in StripeAPI.Types.Charge (==) :: ChargeTransferData' -> ChargeTransferData' -> Bool # (/=) :: ChargeTransferData' -> ChargeTransferData' -> Bool # | |
Show ChargeTransferData' Source # | |
Defined in StripeAPI.Types.Charge showsPrec :: Int -> ChargeTransferData' -> ShowS # show :: ChargeTransferData' -> String # showList :: [ChargeTransferData'] -> ShowS # | |
ToJSON ChargeTransferData' Source # | |
Defined in StripeAPI.Types.Charge toJSON :: ChargeTransferData' -> Value # toEncoding :: ChargeTransferData' -> Encoding # toJSONList :: [ChargeTransferData'] -> Value # toEncodingList :: [ChargeTransferData'] -> Encoding # | |
FromJSON ChargeTransferData' Source # | |
Defined in StripeAPI.Types.Charge parseJSON :: Value -> Parser ChargeTransferData' # parseJSONList :: Value -> Parser [ChargeTransferData'] # |
mkChargeTransferData' :: ChargeTransferData' Source #
Create a new ChargeTransferData'
with all required fields.
data ChargeTransferData'Destination'Variants Source #
Defines the oneOf schema located at components.schemas.charge.properties.transfer_data.anyOf.properties.destination.anyOf
in the specification.
ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.