StripeAPI.Types.Charge

Contains the types generated from the schema Charge

Documentation

data Charge

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.

Constructors

Charge

Fields

• chargeAmount :: 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).

• chargeAmountCaptured :: Int

  amount_captured: Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made).

• chargeAmountRefunded :: Int

  amount_refunded: Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued).

• chargeApplication :: Maybe ChargeApplication'Variants

  application: ID of the Connect application that created the charge.

• chargeApplicationFee :: Maybe ChargeApplicationFee'Variants

  application_fee: The application fee (if any) for the charge. See the Connect documentation for details.

• chargeApplicationFeeAmount :: Maybe Int

  application_fee_amount: The amount of the application fee (if any) requested for the charge. See the Connect documentation for details.

• chargeBalanceTransaction :: Maybe ChargeBalanceTransaction'Variants

  balance_transaction: ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).

• chargeBillingDetails :: BillingDetails

  billing_details:

• chargeCalculatedStatementDescriptor :: Maybe Text

  calculated_statement_descriptor: The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined.

  Constraints:

  • Maximum length of 5000
• chargeCaptured :: Bool

  captured: If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.

• chargeCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• chargeCurrency :: Text

  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

• chargeCustomer :: Maybe ChargeCustomer'Variants

  customer: ID of the customer this charge is for if one exists.

• chargeDescription :: Maybe Text

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 40000
• chargeDisputed :: Bool

  disputed: Whether the charge has been disputed.

• chargeFailureCode :: Maybe Text

  failure_code: Error code explaining reason for charge failure if available (see the errors section for a list of codes).

  Constraints:

  • Maximum length of 5000
• chargeFailureMessage :: Maybe Text

  failure_message: Message to user further explaining reason for charge failure if available.

  Constraints:

  • Maximum length of 5000
• chargeFraudDetails :: Maybe ChargeFraudDetails'

  fraud_details: Information on fraud assessments for the charge.

• chargeId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• chargeInvoice :: Maybe ChargeInvoice'Variants

  invoice: ID of the invoice this charge is for if one exists.

• chargeLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• chargeMetadata :: Object

  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.

• chargeOnBehalfOf :: Maybe ChargeOnBehalfOf'Variants

  on_behalf_of: The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the Connect documentation for details.

• chargeOrder :: Maybe ChargeOrder'Variants

  order: ID of the order this charge is for if one exists.

• chargeOutcome :: Maybe ChargeOutcome'

  outcome: Details about whether the payment was accepted, and why. See understanding declines for details.

• chargePaid :: Bool

  paid: `true` if the charge succeeded, or was successfully authorized for later capture.

• chargePaymentIntent :: Maybe ChargePaymentIntent'Variants

  payment_intent: ID of the PaymentIntent associated with this charge, if one exists.

• chargePaymentMethod :: Maybe Text

  payment_method: ID of the payment method used in this charge.

  Constraints:

  • Maximum length of 5000
• chargePaymentMethodDetails :: Maybe ChargePaymentMethodDetails'

  payment_method_details: Details about the payment method at the time of the transaction.

• chargeReceiptEmail :: Maybe Text

  receipt_email: This is the email address that the receipt for this charge was sent to.

  Constraints:

  • Maximum length of 5000
• chargeReceiptNumber :: Maybe Text

  receipt_number: This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent.

  Constraints:

  • Maximum length of 5000
• chargeReceiptUrl :: Maybe Text

  receipt_url: This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt.

  Constraints:

  • Maximum length of 5000
• chargeRefunded :: Bool

  refunded: Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.

• chargeRefunds :: ChargeRefunds'

  refunds: A list of refunds that have been applied to the charge.

• chargeReview :: Maybe ChargeReview'Variants

  review: ID of the review associated with this charge if one exists.

• chargeShipping :: Maybe ChargeShipping'

  shipping: Shipping information for the charge.

• chargeSourceTransfer :: Maybe ChargeSourceTransfer'Variants

  source_transfer: The transfer ID which created this charge. Only present if the charge came from another Stripe account. See the Connect documentation for details.

• chargeStatementDescriptor :: 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 5000
• chargeStatementDescriptorSuffix :: 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 5000
• chargeStatus :: Text

  status: The status of the payment is either `succeeded`, `pending`, or `failed`.

  Constraints:

  • Maximum length of 5000
• chargeTransfer :: Maybe ChargeTransfer'Variants

  transfer: ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter).

• chargeTransferData :: Maybe ChargeTransferData'

  transfer_data: An optional dictionary including the account to automatically transfer to as part of a destination charge. See the Connect documentation for details.

• chargeTransferGroup :: Maybe Text

  transfer_group: A string that identifies this transaction as part of a group. See the Connect documentation for details.

  Constraints:

  • Maximum length of 5000

Instances

Eq Charge

Defined in StripeAPI.Types.Charge

Methods

(==) :: Charge -> Charge -> Bool

(/=) :: Charge -> Charge -> Bool

Show Charge

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> Charge -> ShowS

show :: Charge -> String

showList :: [Charge] -> ShowS

ToJSON Charge

Defined in StripeAPI.Types.Charge

Methods

toJSON :: Charge -> Value

toEncoding :: Charge -> Encoding

toJSONList :: [Charge] -> Value

toEncodingList :: [Charge] -> Encoding

FromJSON Charge

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser Charge

parseJSONList :: Value -> Parser [Charge]

mkCharge

Arguments

:: Int

chargeAmount

-> Int

chargeAmountCaptured

-> Int

chargeAmountRefunded

-> BillingDetails

chargeBillingDetails

-> Bool

chargeCaptured

-> Int

chargeCreated

-> Text

chargeCurrency

-> Bool

chargeDisputed

-> Text

chargeId

-> Bool

chargeLivemode

-> Object

chargeMetadata

-> Bool

chargePaid

-> Bool

chargeRefunded

-> ChargeRefunds'

chargeRefunds

-> Text

chargeStatus

-> Charge

Create a new Charge with all required fields.

data ChargeApplication'Variants

Defines the oneOf schema located at components.schemas.charge.properties.application.anyOf in the specification.

ID of the Connect application that created the charge.

Constructors

ChargeApplication'Text Text

ChargeApplication'Application Application

Instances

Eq ChargeApplication'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeApplication'Variants -> ChargeApplication'Variants -> Bool

(/=) :: ChargeApplication'Variants -> ChargeApplication'Variants -> Bool

Show ChargeApplication'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeApplication'Variants -> ShowS

show :: ChargeApplication'Variants -> String

showList :: [ChargeApplication'Variants] -> ShowS

ToJSON ChargeApplication'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeApplication'Variants -> Value

toEncoding :: ChargeApplication'Variants -> Encoding

toJSONList :: [ChargeApplication'Variants] -> Value

toEncodingList :: [ChargeApplication'Variants] -> Encoding

FromJSON ChargeApplication'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeApplication'Variants

parseJSONList :: Value -> Parser [ChargeApplication'Variants]

data ChargeApplicationFee'Variants

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.

Constructors

ChargeApplicationFee'Text Text

ChargeApplicationFee'ApplicationFee ApplicationFee

Instances

Eq ChargeApplicationFee'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeApplicationFee'Variants -> ChargeApplicationFee'Variants -> Bool

(/=) :: ChargeApplicationFee'Variants -> ChargeApplicationFee'Variants -> Bool

Show ChargeApplicationFee'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeApplicationFee'Variants -> ShowS

show :: ChargeApplicationFee'Variants -> String

showList :: [ChargeApplicationFee'Variants] -> ShowS

ToJSON ChargeApplicationFee'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeApplicationFee'Variants -> Value

toEncoding :: ChargeApplicationFee'Variants -> Encoding

toJSONList :: [ChargeApplicationFee'Variants] -> Value

toEncodingList :: [ChargeApplicationFee'Variants] -> Encoding

FromJSON ChargeApplicationFee'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeApplicationFee'Variants

parseJSONList :: Value -> Parser [ChargeApplicationFee'Variants]

data ChargeBalanceTransaction'Variants

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).

Constructors

ChargeBalanceTransaction'Text Text

ChargeBalanceTransaction'BalanceTransaction BalanceTransaction

Instances

Eq ChargeBalanceTransaction'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeBalanceTransaction'Variants -> ChargeBalanceTransaction'Variants -> Bool

(/=) :: ChargeBalanceTransaction'Variants -> ChargeBalanceTransaction'Variants -> Bool

Show ChargeBalanceTransaction'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeBalanceTransaction'Variants -> ShowS

show :: ChargeBalanceTransaction'Variants -> String

showList :: [ChargeBalanceTransaction'Variants] -> ShowS

ToJSON ChargeBalanceTransaction'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeBalanceTransaction'Variants -> Value

toEncoding :: ChargeBalanceTransaction'Variants -> Encoding

toJSONList :: [ChargeBalanceTransaction'Variants] -> Value

toEncodingList :: [ChargeBalanceTransaction'Variants] -> Encoding

FromJSON ChargeBalanceTransaction'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeBalanceTransaction'Variants

parseJSONList :: Value -> Parser [ChargeBalanceTransaction'Variants]

data ChargeCustomer'Variants

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.

Constructors

ChargeCustomer'Text Text

ChargeCustomer'Customer Customer

ChargeCustomer'DeletedCustomer DeletedCustomer

Instances

Eq ChargeCustomer'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeCustomer'Variants -> ChargeCustomer'Variants -> Bool

(/=) :: ChargeCustomer'Variants -> ChargeCustomer'Variants -> Bool

Show ChargeCustomer'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeCustomer'Variants -> ShowS

show :: ChargeCustomer'Variants -> String

showList :: [ChargeCustomer'Variants] -> ShowS

ToJSON ChargeCustomer'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeCustomer'Variants -> Value

toEncoding :: ChargeCustomer'Variants -> Encoding

toJSONList :: [ChargeCustomer'Variants] -> Value

toEncodingList :: [ChargeCustomer'Variants] -> Encoding

FromJSON ChargeCustomer'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeCustomer'Variants

parseJSONList :: Value -> Parser [ChargeCustomer'Variants]

data ChargeFraudDetails'

Defines the object schema located at components.schemas.charge.properties.fraud_details.anyOf in the specification.

Information on fraud assessments for the charge.

Constructors

ChargeFraudDetails'

Fields

• chargeFraudDetails'StripeReport :: Maybe Text

  stripe_report: Assessments from Stripe. If set, the value is `fraudulent`.

  Constraints:

  • Maximum length of 5000
• chargeFraudDetails'UserReport :: Maybe Text

  user_report: Assessments reported by you. If set, possible values of are `safe` and `fraudulent`.

  Constraints:

  • Maximum length of 5000

Instances

Eq ChargeFraudDetails'

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeFraudDetails' -> ChargeFraudDetails' -> Bool

(/=) :: ChargeFraudDetails' -> ChargeFraudDetails' -> Bool

Show ChargeFraudDetails'

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeFraudDetails' -> ShowS

show :: ChargeFraudDetails' -> String

showList :: [ChargeFraudDetails'] -> ShowS

ToJSON ChargeFraudDetails'

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeFraudDetails' -> Value

toEncoding :: ChargeFraudDetails' -> Encoding

toJSONList :: [ChargeFraudDetails'] -> Value

toEncodingList :: [ChargeFraudDetails'] -> Encoding

FromJSON ChargeFraudDetails'

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeFraudDetails'

parseJSONList :: Value -> Parser [ChargeFraudDetails']

mkChargeFraudDetails' :: ChargeFraudDetails'

Create a new ChargeFraudDetails' with all required fields.

data ChargeInvoice'Variants

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.

Constructors

ChargeInvoice'Text Text

ChargeInvoice'Invoice Invoice

Instances

Eq ChargeInvoice'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeInvoice'Variants -> ChargeInvoice'Variants -> Bool

(/=) :: ChargeInvoice'Variants -> ChargeInvoice'Variants -> Bool

Show ChargeInvoice'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeInvoice'Variants -> ShowS

show :: ChargeInvoice'Variants -> String

showList :: [ChargeInvoice'Variants] -> ShowS

ToJSON ChargeInvoice'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeInvoice'Variants -> Value

toEncoding :: ChargeInvoice'Variants -> Encoding

toJSONList :: [ChargeInvoice'Variants] -> Value

toEncodingList :: [ChargeInvoice'Variants] -> Encoding

FromJSON ChargeInvoice'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeInvoice'Variants

parseJSONList :: Value -> Parser [ChargeInvoice'Variants]

data ChargeOnBehalfOf'Variants

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.

Constructors

ChargeOnBehalfOf'Text Text

ChargeOnBehalfOf'Account Account

Instances

Eq ChargeOnBehalfOf'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeOnBehalfOf'Variants -> ChargeOnBehalfOf'Variants -> Bool

(/=) :: ChargeOnBehalfOf'Variants -> ChargeOnBehalfOf'Variants -> Bool

Show ChargeOnBehalfOf'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeOnBehalfOf'Variants -> ShowS

show :: ChargeOnBehalfOf'Variants -> String

showList :: [ChargeOnBehalfOf'Variants] -> ShowS

ToJSON ChargeOnBehalfOf'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeOnBehalfOf'Variants -> Value

toEncoding :: ChargeOnBehalfOf'Variants -> Encoding

toJSONList :: [ChargeOnBehalfOf'Variants] -> Value

toEncodingList :: [ChargeOnBehalfOf'Variants] -> Encoding

FromJSON ChargeOnBehalfOf'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeOnBehalfOf'Variants

parseJSONList :: Value -> Parser [ChargeOnBehalfOf'Variants]

data ChargeOrder'Variants

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.

Constructors

ChargeOrder'Text Text

ChargeOrder'Order Order

Instances

Eq ChargeOrder'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeOrder'Variants -> ChargeOrder'Variants -> Bool

(/=) :: ChargeOrder'Variants -> ChargeOrder'Variants -> Bool

Show ChargeOrder'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeOrder'Variants -> ShowS

show :: ChargeOrder'Variants -> String

showList :: [ChargeOrder'Variants] -> ShowS

ToJSON ChargeOrder'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeOrder'Variants -> Value

toEncoding :: ChargeOrder'Variants -> Encoding

toJSONList :: [ChargeOrder'Variants] -> Value

toEncodingList :: [ChargeOrder'Variants] -> Encoding

FromJSON ChargeOrder'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeOrder'Variants

parseJSONList :: Value -> Parser [ChargeOrder'Variants]

data ChargeOutcome'

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.

Constructors

ChargeOutcome'

Fields

• chargeOutcome'NetworkStatus :: Maybe Text

  network_status: Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was blocked by Stripe after bank authorization, and may temporarily appear as "pending" on a cardholder's statement.

  Constraints:

  • Maximum length of 5000
• chargeOutcome'Reason :: Maybe Text

  reason: An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See understanding declines for more details.

  Constraints:

  • Maximum length of 5000
• chargeOutcome'RiskLevel :: Maybe Text

  risk_level: Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar.

  Constraints:

  • Maximum length of 5000
• chargeOutcome'RiskScore :: Maybe Int

  risk_score: Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams.

• chargeOutcome'Rule :: Maybe ChargeOutcome'Rule'Variants

  rule: The ID of the Radar rule that matched the payment, if applicable.

• chargeOutcome'SellerMessage :: Maybe Text

  seller_message: A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer.

  Constraints:

  • Maximum length of 5000
• chargeOutcome'Type :: Maybe Text

  type: Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See understanding declines and Radar reviews for details.

  Constraints:

  • Maximum length of 5000

Instances

Eq ChargeOutcome'

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeOutcome' -> ChargeOutcome' -> Bool

(/=) :: ChargeOutcome' -> ChargeOutcome' -> Bool

Show ChargeOutcome'

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeOutcome' -> ShowS

show :: ChargeOutcome' -> String

showList :: [ChargeOutcome'] -> ShowS

ToJSON ChargeOutcome'

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeOutcome' -> Value

toEncoding :: ChargeOutcome' -> Encoding

toJSONList :: [ChargeOutcome'] -> Value

toEncodingList :: [ChargeOutcome'] -> Encoding

FromJSON ChargeOutcome'

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeOutcome'

parseJSONList :: Value -> Parser [ChargeOutcome']

mkChargeOutcome' :: ChargeOutcome'

Create a new ChargeOutcome' with all required fields.

data ChargeOutcome'Rule'Variants

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.

Constructors

ChargeOutcome'Rule'Text Text

ChargeOutcome'Rule'Rule Rule

Instances

Eq ChargeOutcome'Rule'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeOutcome'Rule'Variants -> ChargeOutcome'Rule'Variants -> Bool

(/=) :: ChargeOutcome'Rule'Variants -> ChargeOutcome'Rule'Variants -> Bool

Show ChargeOutcome'Rule'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeOutcome'Rule'Variants -> ShowS

show :: ChargeOutcome'Rule'Variants -> String

showList :: [ChargeOutcome'Rule'Variants] -> ShowS

ToJSON ChargeOutcome'Rule'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeOutcome'Rule'Variants -> Value

toEncoding :: ChargeOutcome'Rule'Variants -> Encoding

toJSONList :: [ChargeOutcome'Rule'Variants] -> Value

toEncodingList :: [ChargeOutcome'Rule'Variants] -> Encoding

FromJSON ChargeOutcome'Rule'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeOutcome'Rule'Variants

parseJSONList :: Value -> Parser [ChargeOutcome'Rule'Variants]

data ChargePaymentIntent'Variants

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.

Constructors

ChargePaymentIntent'Text Text

ChargePaymentIntent'PaymentIntent PaymentIntent

Instances

Eq ChargePaymentIntent'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargePaymentIntent'Variants -> ChargePaymentIntent'Variants -> Bool

(/=) :: ChargePaymentIntent'Variants -> ChargePaymentIntent'Variants -> Bool

Show ChargePaymentIntent'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargePaymentIntent'Variants -> ShowS

show :: ChargePaymentIntent'Variants -> String

showList :: [ChargePaymentIntent'Variants] -> ShowS

ToJSON ChargePaymentIntent'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargePaymentIntent'Variants -> Value

toEncoding :: ChargePaymentIntent'Variants -> Encoding

toJSONList :: [ChargePaymentIntent'Variants] -> Value

toEncodingList :: [ChargePaymentIntent'Variants] -> Encoding

FromJSON ChargePaymentIntent'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargePaymentIntent'Variants

parseJSONList :: Value -> Parser [ChargePaymentIntent'Variants]

data ChargePaymentMethodDetails'

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.

Constructors

ChargePaymentMethodDetails'

Fields

• chargePaymentMethodDetails'AchCreditTransfer :: Maybe PaymentMethodDetailsAchCreditTransfer

  ach_credit_transfer:

• chargePaymentMethodDetails'AchDebit :: Maybe PaymentMethodDetailsAchDebit

  ach_debit:

• chargePaymentMethodDetails'AcssDebit :: Maybe PaymentMethodDetailsAcssDebit

  acss_debit:

• chargePaymentMethodDetails'AfterpayClearpay :: Maybe PaymentMethodDetailsAfterpayClearpay

  afterpay_clearpay:

• chargePaymentMethodDetails'Alipay :: Maybe PaymentFlowsPrivatePaymentMethodsAlipayDetails

  alipay:

• chargePaymentMethodDetails'AuBecsDebit :: Maybe PaymentMethodDetailsAuBecsDebit

  au_becs_debit:

• chargePaymentMethodDetails'BacsDebit :: Maybe PaymentMethodDetailsBacsDebit

  bacs_debit:

• chargePaymentMethodDetails'Bancontact :: Maybe PaymentMethodDetailsBancontact

  bancontact:

• chargePaymentMethodDetails'Boleto :: Maybe PaymentMethodDetailsBoleto

  boleto:

• chargePaymentMethodDetails'Card :: Maybe PaymentMethodDetailsCard

  card:

• chargePaymentMethodDetails'CardPresent :: Maybe PaymentMethodDetailsCardPresent

  card_present:

• chargePaymentMethodDetails'Eps :: Maybe PaymentMethodDetailsEps

  eps:

• chargePaymentMethodDetails'Fpx :: Maybe PaymentMethodDetailsFpx

  fpx:

• chargePaymentMethodDetails'Giropay :: Maybe PaymentMethodDetailsGiropay

  giropay:

• chargePaymentMethodDetails'Grabpay :: Maybe PaymentMethodDetailsGrabpay

  grabpay:

• chargePaymentMethodDetails'Ideal :: Maybe PaymentMethodDetailsIdeal

  ideal:

• chargePaymentMethodDetails'InteracPresent :: Maybe PaymentMethodDetailsInteracPresent

  interac_present:

• chargePaymentMethodDetails'Klarna :: Maybe PaymentMethodDetailsKlarna

  klarna:

• chargePaymentMethodDetails'Multibanco :: Maybe PaymentMethodDetailsMultibanco

  multibanco:

• chargePaymentMethodDetails'Oxxo :: Maybe PaymentMethodDetailsOxxo

  oxxo:

• chargePaymentMethodDetails'P24 :: Maybe PaymentMethodDetailsP24

  p24:

• chargePaymentMethodDetails'SepaDebit :: Maybe PaymentMethodDetailsSepaDebit

  sepa_debit:

• chargePaymentMethodDetails'Sofort :: Maybe PaymentMethodDetailsSofort

  sofort:

• chargePaymentMethodDetails'StripeAccount :: Maybe PaymentMethodDetailsStripeAccount

  stripe_account:

• chargePaymentMethodDetails'Type :: Maybe Text

  type: The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. An additional hash is included on `payment_method_details` with a name matching this value. It contains information specific to the payment method.

  Constraints:

  • Maximum length of 5000
• chargePaymentMethodDetails'Wechat :: Maybe PaymentMethodDetailsWechat

  wechat:

Instances

Eq ChargePaymentMethodDetails'

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargePaymentMethodDetails' -> ChargePaymentMethodDetails' -> Bool

(/=) :: ChargePaymentMethodDetails' -> ChargePaymentMethodDetails' -> Bool

Show ChargePaymentMethodDetails'

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargePaymentMethodDetails' -> ShowS

show :: ChargePaymentMethodDetails' -> String

showList :: [ChargePaymentMethodDetails'] -> ShowS

ToJSON ChargePaymentMethodDetails'

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargePaymentMethodDetails' -> Value

toEncoding :: ChargePaymentMethodDetails' -> Encoding

toJSONList :: [ChargePaymentMethodDetails'] -> Value

toEncodingList :: [ChargePaymentMethodDetails'] -> Encoding

FromJSON ChargePaymentMethodDetails'

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargePaymentMethodDetails'

parseJSONList :: Value -> Parser [ChargePaymentMethodDetails']

mkChargePaymentMethodDetails' :: ChargePaymentMethodDetails'

Create a new ChargePaymentMethodDetails' with all required fields.

data ChargeRefunds'

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.

Constructors

ChargeRefunds'

Fields

• chargeRefunds'Data :: [Refund]

  data: Details about each object.

• chargeRefunds'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• chargeRefunds'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq ChargeRefunds'

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeRefunds' -> ChargeRefunds' -> Bool

(/=) :: ChargeRefunds' -> ChargeRefunds' -> Bool

Show ChargeRefunds'

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeRefunds' -> ShowS

show :: ChargeRefunds' -> String

showList :: [ChargeRefunds'] -> ShowS

ToJSON ChargeRefunds'

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeRefunds' -> Value

toEncoding :: ChargeRefunds' -> Encoding

toJSONList :: [ChargeRefunds'] -> Value

toEncodingList :: [ChargeRefunds'] -> Encoding

FromJSON ChargeRefunds'

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeRefunds'

parseJSONList :: Value -> Parser [ChargeRefunds']

mkChargeRefunds'

Arguments

:: [Refund]

chargeRefunds'Data

-> Bool

chargeRefunds'HasMore

-> Text

chargeRefunds'Url

-> ChargeRefunds'

Create a new ChargeRefunds' with all required fields.

data ChargeReview'Variants

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.

Constructors

ChargeReview'Text Text

ChargeReview'Review Review

Instances

Eq ChargeReview'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeReview'Variants -> ChargeReview'Variants -> Bool

(/=) :: ChargeReview'Variants -> ChargeReview'Variants -> Bool

Show ChargeReview'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeReview'Variants -> ShowS

show :: ChargeReview'Variants -> String

showList :: [ChargeReview'Variants] -> ShowS

ToJSON ChargeReview'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeReview'Variants -> Value

toEncoding :: ChargeReview'Variants -> Encoding

toJSONList :: [ChargeReview'Variants] -> Value

toEncodingList :: [ChargeReview'Variants] -> Encoding

FromJSON ChargeReview'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeReview'Variants

parseJSONList :: Value -> Parser [ChargeReview'Variants]

data ChargeShipping'

Defines the object schema located at components.schemas.charge.properties.shipping.anyOf in the specification.

Shipping information for the charge.

Constructors

ChargeShipping'

Fields

• chargeShipping'Address :: Maybe Address

  address:

• chargeShipping'Carrier :: Maybe Text

  carrier: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

  Constraints:

  • Maximum length of 5000
• chargeShipping'Name :: Maybe Text

  name: Recipient name.

  Constraints:

  • Maximum length of 5000
• chargeShipping'Phone :: Maybe Text

  phone: Recipient phone (including extension).

  Constraints:

  • Maximum length of 5000
• chargeShipping'TrackingNumber :: Maybe Text

  tracking_number: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

  Constraints:

  • Maximum length of 5000

Instances

Eq ChargeShipping'

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeShipping' -> ChargeShipping' -> Bool

(/=) :: ChargeShipping' -> ChargeShipping' -> Bool

Show ChargeShipping'

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeShipping' -> ShowS

show :: ChargeShipping' -> String

showList :: [ChargeShipping'] -> ShowS

ToJSON ChargeShipping'

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeShipping' -> Value

toEncoding :: ChargeShipping' -> Encoding

toJSONList :: [ChargeShipping'] -> Value

toEncodingList :: [ChargeShipping'] -> Encoding

FromJSON ChargeShipping'

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeShipping'

parseJSONList :: Value -> Parser [ChargeShipping']

mkChargeShipping' :: ChargeShipping'

Create a new ChargeShipping' with all required fields.

data ChargeSourceTransfer'Variants

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.

Constructors

ChargeSourceTransfer'Text Text

ChargeSourceTransfer'Transfer Transfer

Instances

Eq ChargeSourceTransfer'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeSourceTransfer'Variants -> ChargeSourceTransfer'Variants -> Bool

(/=) :: ChargeSourceTransfer'Variants -> ChargeSourceTransfer'Variants -> Bool

Show ChargeSourceTransfer'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeSourceTransfer'Variants -> ShowS

show :: ChargeSourceTransfer'Variants -> String

showList :: [ChargeSourceTransfer'Variants] -> ShowS

ToJSON ChargeSourceTransfer'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeSourceTransfer'Variants -> Value

toEncoding :: ChargeSourceTransfer'Variants -> Encoding

toJSONList :: [ChargeSourceTransfer'Variants] -> Value

toEncodingList :: [ChargeSourceTransfer'Variants] -> Encoding

FromJSON ChargeSourceTransfer'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeSourceTransfer'Variants

parseJSONList :: Value -> Parser [ChargeSourceTransfer'Variants]

data ChargeTransfer'Variants

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).

Constructors

ChargeTransfer'Text Text

ChargeTransfer'Transfer Transfer

Instances

Eq ChargeTransfer'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeTransfer'Variants -> ChargeTransfer'Variants -> Bool

(/=) :: ChargeTransfer'Variants -> ChargeTransfer'Variants -> Bool

Show ChargeTransfer'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeTransfer'Variants -> ShowS

show :: ChargeTransfer'Variants -> String

showList :: [ChargeTransfer'Variants] -> ShowS

ToJSON ChargeTransfer'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeTransfer'Variants -> Value

toEncoding :: ChargeTransfer'Variants -> Encoding

toJSONList :: [ChargeTransfer'Variants] -> Value

toEncodingList :: [ChargeTransfer'Variants] -> Encoding

FromJSON ChargeTransfer'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeTransfer'Variants

parseJSONList :: Value -> Parser [ChargeTransfer'Variants]

data ChargeTransferData'

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.

Constructors

ChargeTransferData'

Fields

• chargeTransferData'Amount :: Maybe Int

  amount: The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account.

• chargeTransferData'Destination :: Maybe ChargeTransferData'Destination'Variants

  destination: ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.

Instances

Eq ChargeTransferData'

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeTransferData' -> ChargeTransferData' -> Bool

(/=) :: ChargeTransferData' -> ChargeTransferData' -> Bool

Show ChargeTransferData'

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeTransferData' -> ShowS

show :: ChargeTransferData' -> String

showList :: [ChargeTransferData'] -> ShowS

ToJSON ChargeTransferData'

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeTransferData' -> Value

toEncoding :: ChargeTransferData' -> Encoding

toJSONList :: [ChargeTransferData'] -> Value

toEncodingList :: [ChargeTransferData'] -> Encoding

FromJSON ChargeTransferData'

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeTransferData'

parseJSONList :: Value -> Parser [ChargeTransferData']

mkChargeTransferData' :: ChargeTransferData'

Create a new ChargeTransferData' with all required fields.

data ChargeTransferData'Destination'Variants

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.

Constructors

ChargeTransferData'Destination'Text Text

ChargeTransferData'Destination'Account Account

Instances

Eq ChargeTransferData'Destination'Variants

Defined in StripeAPI.Types.Charge

Methods

(==) :: ChargeTransferData'Destination'Variants -> ChargeTransferData'Destination'Variants -> Bool

(/=) :: ChargeTransferData'Destination'Variants -> ChargeTransferData'Destination'Variants -> Bool

Show ChargeTransferData'Destination'Variants

Defined in StripeAPI.Types.Charge

Methods

showsPrec :: Int -> ChargeTransferData'Destination'Variants -> ShowS

show :: ChargeTransferData'Destination'Variants -> String

showList :: [ChargeTransferData'Destination'Variants] -> ShowS

ToJSON ChargeTransferData'Destination'Variants

Defined in StripeAPI.Types.Charge

Methods

toJSON :: ChargeTransferData'Destination'Variants -> Value

toEncoding :: ChargeTransferData'Destination'Variants -> Encoding

toJSONList :: [ChargeTransferData'Destination'Variants] -> Value

toEncodingList :: [ChargeTransferData'Destination'Variants] -> Encoding

FromJSON ChargeTransferData'Destination'Variants

Defined in StripeAPI.Types.Charge

Methods

parseJSON :: Value -> Parser ChargeTransferData'Destination'Variants

parseJSONList :: Value -> Parser [ChargeTransferData'Destination'Variants]