StripeAPI.Types.PaymentIntent

Contains the types generated from the schema PaymentIntent

Documentation

data PaymentIntent

Defines the object schema located at components.schemas.payment_intent in the specification.

A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

Related guide: Payment Intents API.

Constructors

PaymentIntent

Fields

• paymentIntentAmount :: Int

  amount: Amount intended to be collected by this PaymentIntent. 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).

• paymentIntentAmountCapturable :: Maybe Int

  amount_capturable: Amount that can be captured from this PaymentIntent.

• paymentIntentAmountReceived :: Maybe Int

  amount_received: Amount that was collected by this PaymentIntent.

• paymentIntentApplication :: Maybe PaymentIntentApplication'Variants

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

• paymentIntentApplicationFeeAmount :: Maybe Int

  application_fee_amount: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents use case for connected accounts.

• paymentIntentCanceledAt :: Maybe Int

  canceled_at: Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.

• paymentIntentCancellationReason :: Maybe PaymentIntentCancellationReason'

  cancellation_reason: Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).

• paymentIntentCaptureMethod :: PaymentIntentCaptureMethod'

  capture_method: Controls when the funds will be captured from the customer's account.

• paymentIntentCharges :: Maybe PaymentIntentCharges'

  charges: Charges that were created by this PaymentIntent, if any.

• paymentIntentClientSecret :: Maybe Text

  client_secret: The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.

  The client secret can be used to complete a payment from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

  Refer to our docs to accept a payment and learn about how `client_secret` should be handled.

  Constraints:

  • Maximum length of 5000
• paymentIntentConfirmationMethod :: PaymentIntentConfirmationMethod'

  confirmation_method

• paymentIntentCreated :: Int

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

• paymentIntentCurrency :: Text

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

• paymentIntentCustomer :: Maybe PaymentIntentCustomer'Variants

  customer: ID of the Customer this PaymentIntent belongs to, if one exists.

  Payment methods attached to other Customers cannot be used with this PaymentIntent.

  If present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.

• paymentIntentDescription :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• paymentIntentId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• paymentIntentInvoice :: Maybe PaymentIntentInvoice'Variants

  invoice: ID of the invoice that created this PaymentIntent, if it exists.

• paymentIntentLastPaymentError :: Maybe PaymentIntentLastPaymentError'

  last_payment_error: The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.

• paymentIntentLivemode :: Bool

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

• paymentIntentMetadata :: Maybe 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. For more information, see the documentation.

• paymentIntentNextAction :: Maybe PaymentIntentNextAction'

  next_action: If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.

• paymentIntentOnBehalfOf :: Maybe PaymentIntentOnBehalfOf'Variants

  on_behalf_of: The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.

• paymentIntentPaymentMethod :: Maybe PaymentIntentPaymentMethod'Variants

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

• paymentIntentPaymentMethodOptions :: Maybe PaymentIntentPaymentMethodOptions'

  payment_method_options: Payment-method-specific configuration for this PaymentIntent.

• paymentIntentPaymentMethodTypes :: [Text]

  payment_method_types: The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.

• paymentIntentReceiptEmail :: Maybe Text

  receipt_email: Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

  Constraints:

  • Maximum length of 5000
• paymentIntentReview :: Maybe PaymentIntentReview'Variants

  review: ID of the review associated with this PaymentIntent, if any.

• paymentIntentSetupFutureUsage :: Maybe PaymentIntentSetupFutureUsage'

  setup_future_usage: Indicates that you intend to make future payments with this PaymentIntent's payment method.

  Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.

  When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

• paymentIntentShipping :: Maybe PaymentIntentShipping'

  shipping: Shipping information for this PaymentIntent.

• paymentIntentStatementDescriptor :: Maybe Text

  statement_descriptor: For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.

  Constraints:

  • Maximum length of 5000
• paymentIntentStatementDescriptorSuffix :: Maybe Text

  statement_descriptor_suffix: Provides information about a card payment 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
• paymentIntentStatus :: PaymentIntentStatus'

  status: Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent status.

• paymentIntentTransferData :: Maybe PaymentIntentTransferData'

  transfer_data: The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.

• paymentIntentTransferGroup :: Maybe Text

  transfer_group: A string that identifies the resulting payment as part of a group. See the PaymentIntents use case for connected accounts for details.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentIntent

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntent -> PaymentIntent -> Bool

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

Show PaymentIntent

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntent -> ShowS

show :: PaymentIntent -> String

showList :: [PaymentIntent] -> ShowS

ToJSON PaymentIntent

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntent -> Value

toEncoding :: PaymentIntent -> Encoding

toJSONList :: [PaymentIntent] -> Value

toEncodingList :: [PaymentIntent] -> Encoding

FromJSON PaymentIntent

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntent

parseJSONList :: Value -> Parser [PaymentIntent]

mkPaymentIntent

Arguments

:: Int

paymentIntentAmount

-> PaymentIntentCaptureMethod'

paymentIntentCaptureMethod

-> PaymentIntentConfirmationMethod'

paymentIntentConfirmationMethod

-> Int

paymentIntentCreated

-> Text

paymentIntentCurrency

-> Text

paymentIntentId

-> Bool

paymentIntentLivemode

-> [Text]

paymentIntentPaymentMethodTypes

-> PaymentIntentStatus'

paymentIntentStatus

-> PaymentIntent

Create a new PaymentIntent with all required fields.

data PaymentIntentApplication'Variants

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

ID of the Connect application that created the PaymentIntent.

Constructors

PaymentIntentApplication'Text Text

PaymentIntentApplication'Application Application

Instances

Eq PaymentIntentApplication'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentApplication'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

show :: PaymentIntentApplication'Variants -> String

showList :: [PaymentIntentApplication'Variants] -> ShowS

ToJSON PaymentIntentApplication'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentApplication'Variants -> Value

toEncoding :: PaymentIntentApplication'Variants -> Encoding

toJSONList :: [PaymentIntentApplication'Variants] -> Value

toEncodingList :: [PaymentIntentApplication'Variants] -> Encoding

FromJSON PaymentIntentApplication'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentApplication'Variants

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

data PaymentIntentCancellationReason'

Defines the enum schema located at components.schemas.payment_intent.properties.cancellation_reason in the specification.

Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).

Constructors

PaymentIntentCancellationReason'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentIntentCancellationReason'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentIntentCancellationReason'EnumAbandoned

Represents the JSON value "abandoned"

PaymentIntentCancellationReason'EnumAutomatic

Represents the JSON value "automatic"

PaymentIntentCancellationReason'EnumDuplicate

Represents the JSON value "duplicate"

PaymentIntentCancellationReason'EnumFailedInvoice

Represents the JSON value "failed_invoice"

PaymentIntentCancellationReason'EnumFraudulent

Represents the JSON value "fraudulent"

PaymentIntentCancellationReason'EnumRequestedByCustomer

Represents the JSON value "requested_by_customer"

PaymentIntentCancellationReason'EnumVoidInvoice

Represents the JSON value "void_invoice"

Instances

Eq PaymentIntentCancellationReason'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentCancellationReason'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentCancellationReason' -> ShowS

show :: PaymentIntentCancellationReason' -> String

showList :: [PaymentIntentCancellationReason'] -> ShowS

ToJSON PaymentIntentCancellationReason'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentCancellationReason' -> Value

toEncoding :: PaymentIntentCancellationReason' -> Encoding

toJSONList :: [PaymentIntentCancellationReason'] -> Value

toEncodingList :: [PaymentIntentCancellationReason'] -> Encoding

FromJSON PaymentIntentCancellationReason'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentCancellationReason'

parseJSONList :: Value -> Parser [PaymentIntentCancellationReason']

data PaymentIntentCaptureMethod'

Defines the enum schema located at components.schemas.payment_intent.properties.capture_method in the specification.

Controls when the funds will be captured from the customer's account.

Constructors

PaymentIntentCaptureMethod'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentIntentCaptureMethod'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentIntentCaptureMethod'EnumAutomatic

Represents the JSON value "automatic"

PaymentIntentCaptureMethod'EnumManual

Represents the JSON value "manual"

Instances

Eq PaymentIntentCaptureMethod'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentCaptureMethod'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentCaptureMethod' -> ShowS

show :: PaymentIntentCaptureMethod' -> String

showList :: [PaymentIntentCaptureMethod'] -> ShowS

ToJSON PaymentIntentCaptureMethod'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentCaptureMethod' -> Value

toEncoding :: PaymentIntentCaptureMethod' -> Encoding

toJSONList :: [PaymentIntentCaptureMethod'] -> Value

toEncodingList :: [PaymentIntentCaptureMethod'] -> Encoding

FromJSON PaymentIntentCaptureMethod'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentCaptureMethod'

parseJSONList :: Value -> Parser [PaymentIntentCaptureMethod']

data PaymentIntentCharges'

Defines the object schema located at components.schemas.payment_intent.properties.charges in the specification.

Charges that were created by this PaymentIntent, if any.

Constructors

PaymentIntentCharges'

Fields

• paymentIntentCharges'Data :: [Charge]

  data: This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` parameter.

• paymentIntentCharges'HasMore :: Bool

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

• paymentIntentCharges'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentIntentCharges'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentCharges'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentCharges' -> ShowS

show :: PaymentIntentCharges' -> String

showList :: [PaymentIntentCharges'] -> ShowS

ToJSON PaymentIntentCharges'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentCharges' -> Value

toEncoding :: PaymentIntentCharges' -> Encoding

toJSONList :: [PaymentIntentCharges'] -> Value

toEncodingList :: [PaymentIntentCharges'] -> Encoding

FromJSON PaymentIntentCharges'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentCharges'

parseJSONList :: Value -> Parser [PaymentIntentCharges']

mkPaymentIntentCharges'

Arguments

:: [Charge]

paymentIntentCharges'Data

-> Bool

paymentIntentCharges'HasMore

-> Text

paymentIntentCharges'Url

-> PaymentIntentCharges'

Create a new PaymentIntentCharges' with all required fields.

data PaymentIntentConfirmationMethod'

Defines the enum schema located at components.schemas.payment_intent.properties.confirmation_method in the specification.

Constructors

PaymentIntentConfirmationMethod'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentIntentConfirmationMethod'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentIntentConfirmationMethod'EnumAutomatic

Represents the JSON value "automatic"

PaymentIntentConfirmationMethod'EnumManual

Represents the JSON value "manual"

Instances

Eq PaymentIntentConfirmationMethod'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentConfirmationMethod'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentConfirmationMethod' -> ShowS

show :: PaymentIntentConfirmationMethod' -> String

showList :: [PaymentIntentConfirmationMethod'] -> ShowS

ToJSON PaymentIntentConfirmationMethod'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentConfirmationMethod' -> Value

toEncoding :: PaymentIntentConfirmationMethod' -> Encoding

toJSONList :: [PaymentIntentConfirmationMethod'] -> Value

toEncodingList :: [PaymentIntentConfirmationMethod'] -> Encoding

FromJSON PaymentIntentConfirmationMethod'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentConfirmationMethod'

parseJSONList :: Value -> Parser [PaymentIntentConfirmationMethod']

data PaymentIntentCustomer'Variants

Defines the oneOf schema located at components.schemas.payment_intent.properties.customer.anyOf in the specification.

ID of the Customer this PaymentIntent belongs to, if one exists.

Payment methods attached to other Customers cannot be used with this PaymentIntent.

If present in combination with setup_future_usage, this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.

Constructors

PaymentIntentCustomer'Text Text

PaymentIntentCustomer'Customer Customer

PaymentIntentCustomer'DeletedCustomer DeletedCustomer

Instances

Eq PaymentIntentCustomer'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentCustomer'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

show :: PaymentIntentCustomer'Variants -> String

showList :: [PaymentIntentCustomer'Variants] -> ShowS

ToJSON PaymentIntentCustomer'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentCustomer'Variants -> Value

toEncoding :: PaymentIntentCustomer'Variants -> Encoding

toJSONList :: [PaymentIntentCustomer'Variants] -> Value

toEncodingList :: [PaymentIntentCustomer'Variants] -> Encoding

FromJSON PaymentIntentCustomer'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentCustomer'Variants

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

data PaymentIntentInvoice'Variants

Defines the oneOf schema located at components.schemas.payment_intent.properties.invoice.anyOf in the specification.

ID of the invoice that created this PaymentIntent, if it exists.

Constructors

PaymentIntentInvoice'Text Text

PaymentIntentInvoice'Invoice Invoice

Instances

Eq PaymentIntentInvoice'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentInvoice'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

show :: PaymentIntentInvoice'Variants -> String

showList :: [PaymentIntentInvoice'Variants] -> ShowS

ToJSON PaymentIntentInvoice'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentInvoice'Variants -> Value

toEncoding :: PaymentIntentInvoice'Variants -> Encoding

toJSONList :: [PaymentIntentInvoice'Variants] -> Value

toEncodingList :: [PaymentIntentInvoice'Variants] -> Encoding

FromJSON PaymentIntentInvoice'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentInvoice'Variants

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

data PaymentIntentLastPaymentError'

Defines the object schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf in the specification.

The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.

Constructors

PaymentIntentLastPaymentError'

Fields

• paymentIntentLastPaymentError'Charge :: Maybe Text

  charge: For card errors, the ID of the failed charge.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Code :: Maybe Text

  code: For some errors that could be handled programmatically, a short string indicating the error code reported.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'DeclineCode :: Maybe Text

  decline_code: For card errors resulting from a card issuer decline, a short string indicating the card issuer's reason for the decline if they provide one.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'DocUrl :: Maybe Text

  doc_url: A URL to more information about the error code reported.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Message :: Maybe Text

  message: A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

  Constraints:

  • Maximum length of 40000
• paymentIntentLastPaymentError'Param :: Maybe Text

  param: If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'PaymentIntent :: Maybe PaymentIntent

  payment_intent: A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

  A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

  Related guide: Payment Intents API.

• paymentIntentLastPaymentError'PaymentMethod :: Maybe PaymentMethod

  payment_method: PaymentMethod objects represent your customer's payment instruments. They can be used with PaymentIntents to collect payments or saved to Customer objects to store instrument details for future payments.

  Related guides: Payment Methods and More Payment Scenarios.

• paymentIntentLastPaymentError'PaymentMethodType :: Maybe Text

  payment_method_type: If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'SetupIntent :: Maybe SetupIntent

  setup_intent: A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

  Create a SetupIntent as soon as you're ready to collect your customer's payment credentials. Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid. The SetupIntent then transitions through multiple statuses as it guides you through the setup process.

  Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions may need to be run through Strong Customer Authentication at the time of payment method collection in order to streamline later off-session payments. If the SetupIntent is used with a Customer, upon success, it will automatically attach the resulting payment method to that Customer. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.

  By using SetupIntents, you ensure that your customers experience the minimum set of required friction, even as regulations change over time.

  Related guide: Setup Intents API.

• paymentIntentLastPaymentError'Source :: Maybe PaymentIntentLastPaymentError'Source'

  source: The source object for errors returned on a request involving a source.

• paymentIntentLastPaymentError'Type :: Maybe PaymentIntentLastPaymentError'Type'

  type: The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error`

Instances

Eq PaymentIntentLastPaymentError'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentLastPaymentError'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError' -> ShowS

show :: PaymentIntentLastPaymentError' -> String

showList :: [PaymentIntentLastPaymentError'] -> ShowS

ToJSON PaymentIntentLastPaymentError'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError' -> Value

toEncoding :: PaymentIntentLastPaymentError' -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'] -> Encoding

FromJSON PaymentIntentLastPaymentError'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError']

mkPaymentIntentLastPaymentError' :: PaymentIntentLastPaymentError'

Create a new PaymentIntentLastPaymentError' with all required fields.

data PaymentIntentLastPaymentError'Source'

Defines the object schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf in the specification.

The source object for errors returned on a request involving a source.

Constructors

PaymentIntentLastPaymentError'Source'

Fields

• paymentIntentLastPaymentError'Source'Account :: Maybe PaymentIntentLastPaymentError'Source'Account'Variants

  account: The ID of the account that the bank account is associated with.

• paymentIntentLastPaymentError'Source'AccountHolderName :: Maybe Text

  account_holder_name: The name of the person or business that owns the bank account.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'AccountHolderType :: Maybe Text

  account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'AchCreditTransfer :: Maybe SourceTypeAchCreditTransfer

  ach_credit_transfer

• paymentIntentLastPaymentError'Source'AchDebit :: Maybe SourceTypeAchDebit

  ach_debit

• paymentIntentLastPaymentError'Source'AcssDebit :: Maybe SourceTypeAcssDebit

  acss_debit

• paymentIntentLastPaymentError'Source'AddressCity :: Maybe Text

  address_city: City/District/Suburb/Town/Village.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'AddressCountry :: Maybe Text

  address_country: Billing address country, if provided when creating card.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'AddressLine1 :: Maybe Text

  address_line1: Address line 1 (Street address/PO Box/Company name).

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'AddressLine1Check :: Maybe Text

  address_line1_check: If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'AddressLine2 :: Maybe Text

  address_line2: Address line 2 (Apartment/Suite/Unit/Building).

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'AddressState :: Maybe Text

  address_state: State/County/Province/Region.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'AddressZip :: Maybe Text

  address_zip: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'AddressZipCheck :: Maybe Text

  address_zip_check: If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Alipay :: Maybe SourceTypeAlipay

  alipay

• paymentIntentLastPaymentError'Source'Amount :: Maybe Int

  amount: A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.

• paymentIntentLastPaymentError'Source'AuBecsDebit :: Maybe SourceTypeAuBecsDebit

  au_becs_debit

• paymentIntentLastPaymentError'Source'AvailablePayoutMethods :: Maybe [PaymentIntentLastPaymentError'Source'AvailablePayoutMethods']

  available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.

• paymentIntentLastPaymentError'Source'Bancontact :: Maybe SourceTypeBancontact

  bancontact

• paymentIntentLastPaymentError'Source'BankName :: Maybe Text

  bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Brand :: Maybe Text

  brand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Card :: Maybe SourceTypeCard

  card

• paymentIntentLastPaymentError'Source'CardPresent :: Maybe SourceTypeCardPresent

  card_present

• paymentIntentLastPaymentError'Source'ClientSecret :: Maybe Text

  client_secret: The client secret of the source. Used for client-side retrieval using a publishable key.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'CodeVerification :: Maybe SourceCodeVerificationFlow

  code_verification:

• paymentIntentLastPaymentError'Source'Country :: Maybe Text

  country: Two-letter ISO code representing the country the bank account is located in.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Created :: Maybe Int

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

• paymentIntentLastPaymentError'Source'Currency :: Maybe Text

  currency: Three-letter ISO code for the currency paid out to the bank account.

• paymentIntentLastPaymentError'Source'Customer :: Maybe PaymentIntentLastPaymentError'Source'Customer'Variants

  customer: The ID of the customer that the bank account is associated with.

• paymentIntentLastPaymentError'Source'CvcCheck :: Maybe Text

  cvc_check: If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'DefaultForCurrency :: Maybe Bool

  default_for_currency: Whether this bank account is the default external account for its currency.

• paymentIntentLastPaymentError'Source'DynamicLast4 :: Maybe Text

  dynamic_last4: (For tokenized numbers only.) The last four digits of the device account number.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Eps :: Maybe SourceTypeEps

  eps

• paymentIntentLastPaymentError'Source'ExpMonth :: Maybe Int

  exp_month: Two-digit number representing the card's expiration month.

• paymentIntentLastPaymentError'Source'ExpYear :: Maybe Int

  exp_year: Four-digit number representing the card's expiration year.

• paymentIntentLastPaymentError'Source'Fingerprint :: Maybe Text

  fingerprint: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Flow :: Maybe Text

  flow: The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Funding :: Maybe Text

  funding: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Giropay :: Maybe SourceTypeGiropay

  giropay

• paymentIntentLastPaymentError'Source'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Ideal :: Maybe SourceTypeIdeal

  ideal

• paymentIntentLastPaymentError'Source'Klarna :: Maybe SourceTypeKlarna

  klarna

• paymentIntentLastPaymentError'Source'Last4 :: Maybe Text

  last4: The last four digits of the bank account number.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Livemode :: Maybe Bool

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

• paymentIntentLastPaymentError'Source'Metadata :: Maybe 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.

• paymentIntentLastPaymentError'Source'Multibanco :: Maybe SourceTypeMultibanco

  multibanco

• paymentIntentLastPaymentError'Source'Name :: Maybe Text

  name: Cardholder name.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner :: Maybe PaymentIntentLastPaymentError'Source'Owner'

  owner: Information about the owner of the payment instrument that may be used or required by particular source types.

• paymentIntentLastPaymentError'Source'P24 :: Maybe SourceTypeP24

  p24

• paymentIntentLastPaymentError'Source'Receiver :: Maybe SourceReceiverFlow

  receiver:

• paymentIntentLastPaymentError'Source'Recipient :: Maybe PaymentIntentLastPaymentError'Source'Recipient'Variants

  recipient: The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

• paymentIntentLastPaymentError'Source'Redirect :: Maybe SourceRedirectFlow

  redirect:

• paymentIntentLastPaymentError'Source'RoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'SepaDebit :: Maybe SourceTypeSepaDebit

  sepa_debit

• paymentIntentLastPaymentError'Source'Sofort :: Maybe SourceTypeSofort

  sofort

• paymentIntentLastPaymentError'Source'SourceOrder :: Maybe SourceOrder

  source_order:

• paymentIntentLastPaymentError'Source'StatementDescriptor :: Maybe Text

  statement_descriptor: Extra information about a source. This will appear on your customer's statement every time you charge the source.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Status :: Maybe Text

  status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

  For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'ThreeDSecure :: Maybe SourceTypeThreeDSecure

  three_d_secure

• paymentIntentLastPaymentError'Source'TokenizationMethod :: Maybe Text

  tokenization_method: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Type :: Maybe PaymentIntentLastPaymentError'Source'Type'

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

• paymentIntentLastPaymentError'Source'Usage :: Maybe Text

  usage: Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Wechat :: Maybe SourceTypeWechat

  wechat

Instances

Eq PaymentIntentLastPaymentError'Source'

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntentLastPaymentError'Source' -> PaymentIntentLastPaymentError'Source' -> Bool

(/=) :: PaymentIntentLastPaymentError'Source' -> PaymentIntentLastPaymentError'Source' -> Bool

Show PaymentIntentLastPaymentError'Source'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError'Source' -> ShowS

show :: PaymentIntentLastPaymentError'Source' -> String

showList :: [PaymentIntentLastPaymentError'Source'] -> ShowS

ToJSON PaymentIntentLastPaymentError'Source'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError'Source' -> Value

toEncoding :: PaymentIntentLastPaymentError'Source' -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'Source'] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'Source'] -> Encoding

FromJSON PaymentIntentLastPaymentError'Source'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'Source'

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError'Source']

mkPaymentIntentLastPaymentError'Source' :: PaymentIntentLastPaymentError'Source'

Create a new PaymentIntentLastPaymentError'Source' with all required fields.

data PaymentIntentLastPaymentError'Source'Account'Variants

Defines the oneOf schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.account.anyOf in the specification.

The ID of the account that the bank account is associated with.

Constructors

PaymentIntentLastPaymentError'Source'Account'Text Text

PaymentIntentLastPaymentError'Source'Account'Account Account

Instances

Eq PaymentIntentLastPaymentError'Source'Account'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntentLastPaymentError'Source'Account'Variants -> PaymentIntentLastPaymentError'Source'Account'Variants -> Bool

(/=) :: PaymentIntentLastPaymentError'Source'Account'Variants -> PaymentIntentLastPaymentError'Source'Account'Variants -> Bool

Show PaymentIntentLastPaymentError'Source'Account'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError'Source'Account'Variants -> ShowS

show :: PaymentIntentLastPaymentError'Source'Account'Variants -> String

showList :: [PaymentIntentLastPaymentError'Source'Account'Variants] -> ShowS

ToJSON PaymentIntentLastPaymentError'Source'Account'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError'Source'Account'Variants -> Value

toEncoding :: PaymentIntentLastPaymentError'Source'Account'Variants -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'Source'Account'Variants] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'Source'Account'Variants] -> Encoding

FromJSON PaymentIntentLastPaymentError'Source'Account'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'Source'Account'Variants

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError'Source'Account'Variants]

data PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'

Defines the enum schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.available_payout_methods.items in the specification.

Constructors

PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'EnumInstant

Represents the JSON value "instant"

PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntentLastPaymentError'Source'AvailablePayoutMethods' -> PaymentIntentLastPaymentError'Source'AvailablePayoutMethods' -> Bool

(/=) :: PaymentIntentLastPaymentError'Source'AvailablePayoutMethods' -> PaymentIntentLastPaymentError'Source'AvailablePayoutMethods' -> Bool

Show PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError'Source'AvailablePayoutMethods' -> ShowS

show :: PaymentIntentLastPaymentError'Source'AvailablePayoutMethods' -> String

showList :: [PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'] -> ShowS

ToJSON PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError'Source'AvailablePayoutMethods' -> Value

toEncoding :: PaymentIntentLastPaymentError'Source'AvailablePayoutMethods' -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'] -> Encoding

FromJSON PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'Source'AvailablePayoutMethods'

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError'Source'AvailablePayoutMethods']

data PaymentIntentLastPaymentError'Source'Customer'Variants

Defines the oneOf schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.customer.anyOf in the specification.

The ID of the customer that the bank account is associated with.

Constructors

PaymentIntentLastPaymentError'Source'Customer'Text Text

PaymentIntentLastPaymentError'Source'Customer'Customer Customer

PaymentIntentLastPaymentError'Source'Customer'DeletedCustomer DeletedCustomer

Instances

Eq PaymentIntentLastPaymentError'Source'Customer'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntentLastPaymentError'Source'Customer'Variants -> PaymentIntentLastPaymentError'Source'Customer'Variants -> Bool

(/=) :: PaymentIntentLastPaymentError'Source'Customer'Variants -> PaymentIntentLastPaymentError'Source'Customer'Variants -> Bool

Show PaymentIntentLastPaymentError'Source'Customer'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError'Source'Customer'Variants -> ShowS

show :: PaymentIntentLastPaymentError'Source'Customer'Variants -> String

showList :: [PaymentIntentLastPaymentError'Source'Customer'Variants] -> ShowS

ToJSON PaymentIntentLastPaymentError'Source'Customer'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError'Source'Customer'Variants -> Value

toEncoding :: PaymentIntentLastPaymentError'Source'Customer'Variants -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'Source'Customer'Variants] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'Source'Customer'Variants] -> Encoding

FromJSON PaymentIntentLastPaymentError'Source'Customer'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'Source'Customer'Variants

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError'Source'Customer'Variants]

data PaymentIntentLastPaymentError'Source'Owner'

Defines the object schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.owner.anyOf in the specification.

Information about the owner of the payment instrument that may be used or required by particular source types.

Constructors

PaymentIntentLastPaymentError'Source'Owner'

Fields

• paymentIntentLastPaymentError'Source'Owner'Address :: Maybe PaymentIntentLastPaymentError'Source'Owner'Address'

  address: Owner's address.

• paymentIntentLastPaymentError'Source'Owner'Email :: Maybe Text

  email: Owner's email address.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'Name :: Maybe Text

  name: Owner's full name.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'Phone :: Maybe Text

  phone: Owner's phone number (including extension).

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'VerifiedAddress :: Maybe PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'

  verified_address: Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

• paymentIntentLastPaymentError'Source'Owner'VerifiedEmail :: Maybe Text

  verified_email: Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'VerifiedName :: Maybe Text

  verified_name: Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'VerifiedPhone :: Maybe Text

  verified_phone: Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentIntentLastPaymentError'Source'Owner'

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntentLastPaymentError'Source'Owner' -> PaymentIntentLastPaymentError'Source'Owner' -> Bool

(/=) :: PaymentIntentLastPaymentError'Source'Owner' -> PaymentIntentLastPaymentError'Source'Owner' -> Bool

Show PaymentIntentLastPaymentError'Source'Owner'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError'Source'Owner' -> ShowS

show :: PaymentIntentLastPaymentError'Source'Owner' -> String

showList :: [PaymentIntentLastPaymentError'Source'Owner'] -> ShowS

ToJSON PaymentIntentLastPaymentError'Source'Owner'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError'Source'Owner' -> Value

toEncoding :: PaymentIntentLastPaymentError'Source'Owner' -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'Source'Owner'] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'Source'Owner'] -> Encoding

FromJSON PaymentIntentLastPaymentError'Source'Owner'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'Source'Owner'

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError'Source'Owner']

mkPaymentIntentLastPaymentError'Source'Owner' :: PaymentIntentLastPaymentError'Source'Owner'

Create a new PaymentIntentLastPaymentError'Source'Owner' with all required fields.

data PaymentIntentLastPaymentError'Source'Owner'Address'

Defines the object schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.owner.anyOf.properties.address.anyOf in the specification.

Owner\'s address.

Constructors

PaymentIntentLastPaymentError'Source'Owner'Address'

Fields

• paymentIntentLastPaymentError'Source'Owner'Address'City :: Maybe Text

  city: City, district, suburb, town, or village.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'Address'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'Address'Line1 :: Maybe Text

  line1: Address line 1 (e.g., street, PO Box, or company name).

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'Address'Line2 :: Maybe Text

  line2: Address line 2 (e.g., apartment, suite, unit, or building).

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'Address'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'Address'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentIntentLastPaymentError'Source'Owner'Address'

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntentLastPaymentError'Source'Owner'Address' -> PaymentIntentLastPaymentError'Source'Owner'Address' -> Bool

(/=) :: PaymentIntentLastPaymentError'Source'Owner'Address' -> PaymentIntentLastPaymentError'Source'Owner'Address' -> Bool

Show PaymentIntentLastPaymentError'Source'Owner'Address'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError'Source'Owner'Address' -> ShowS

show :: PaymentIntentLastPaymentError'Source'Owner'Address' -> String

showList :: [PaymentIntentLastPaymentError'Source'Owner'Address'] -> ShowS

ToJSON PaymentIntentLastPaymentError'Source'Owner'Address'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError'Source'Owner'Address' -> Value

toEncoding :: PaymentIntentLastPaymentError'Source'Owner'Address' -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'Source'Owner'Address'] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'Source'Owner'Address'] -> Encoding

FromJSON PaymentIntentLastPaymentError'Source'Owner'Address'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'Source'Owner'Address'

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError'Source'Owner'Address']

mkPaymentIntentLastPaymentError'Source'Owner'Address' :: PaymentIntentLastPaymentError'Source'Owner'Address'

Create a new PaymentIntentLastPaymentError'Source'Owner'Address' with all required fields.

data PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'

Defines the object schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.owner.anyOf.properties.verified_address.anyOf in the specification.

Verified owner\'s address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constructors

PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'

Fields

• paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'City :: Maybe Text

  city: City, district, suburb, town, or village.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'Country :: Maybe Text

  country: Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'Line1 :: Maybe Text

  line1: Address line 1 (e.g., street, PO Box, or company name).

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'Line2 :: Maybe Text

  line2: Address line 2 (e.g., apartment, suite, unit, or building).

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'PostalCode :: Maybe Text

  postal_code: ZIP or postal code.

  Constraints:

  • Maximum length of 5000
• paymentIntentLastPaymentError'Source'Owner'VerifiedAddress'State :: Maybe Text

  state: State, county, province, or region.

  Constraints:

  • Maximum length of 5000

Instances

Eq PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' -> PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' -> Bool

(/=) :: PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' -> PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' -> Bool

Show PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' -> ShowS

show :: PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' -> String

showList :: [PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'] -> ShowS

ToJSON PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' -> Value

toEncoding :: PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'] -> Encoding

FromJSON PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress']

mkPaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' :: PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress'

Create a new PaymentIntentLastPaymentError'Source'Owner'VerifiedAddress' with all required fields.

data PaymentIntentLastPaymentError'Source'Recipient'Variants

Defines the oneOf schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.recipient.anyOf in the specification.

The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

Constructors

PaymentIntentLastPaymentError'Source'Recipient'Text Text

PaymentIntentLastPaymentError'Source'Recipient'Recipient Recipient

Instances

Eq PaymentIntentLastPaymentError'Source'Recipient'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntentLastPaymentError'Source'Recipient'Variants -> PaymentIntentLastPaymentError'Source'Recipient'Variants -> Bool

(/=) :: PaymentIntentLastPaymentError'Source'Recipient'Variants -> PaymentIntentLastPaymentError'Source'Recipient'Variants -> Bool

Show PaymentIntentLastPaymentError'Source'Recipient'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError'Source'Recipient'Variants -> ShowS

show :: PaymentIntentLastPaymentError'Source'Recipient'Variants -> String

showList :: [PaymentIntentLastPaymentError'Source'Recipient'Variants] -> ShowS

ToJSON PaymentIntentLastPaymentError'Source'Recipient'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError'Source'Recipient'Variants -> Value

toEncoding :: PaymentIntentLastPaymentError'Source'Recipient'Variants -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'Source'Recipient'Variants] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'Source'Recipient'Variants] -> Encoding

FromJSON PaymentIntentLastPaymentError'Source'Recipient'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'Source'Recipient'Variants

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError'Source'Recipient'Variants]

data PaymentIntentLastPaymentError'Source'Type'

Defines the enum schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.source.anyOf.properties.type in the specification.

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

Constructors

PaymentIntentLastPaymentError'Source'Type'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentIntentLastPaymentError'Source'Type'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentIntentLastPaymentError'Source'Type'EnumAchCreditTransfer

Represents the JSON value "ach_credit_transfer"

PaymentIntentLastPaymentError'Source'Type'EnumAchDebit

Represents the JSON value "ach_debit"

PaymentIntentLastPaymentError'Source'Type'EnumAcssDebit

Represents the JSON value "acss_debit"

PaymentIntentLastPaymentError'Source'Type'EnumAlipay

Represents the JSON value "alipay"

PaymentIntentLastPaymentError'Source'Type'EnumAuBecsDebit

Represents the JSON value "au_becs_debit"

PaymentIntentLastPaymentError'Source'Type'EnumBancontact

Represents the JSON value "bancontact"

PaymentIntentLastPaymentError'Source'Type'EnumCard

Represents the JSON value "card"

PaymentIntentLastPaymentError'Source'Type'EnumCardPresent

Represents the JSON value "card_present"

PaymentIntentLastPaymentError'Source'Type'EnumEps

Represents the JSON value "eps"

PaymentIntentLastPaymentError'Source'Type'EnumGiropay

Represents the JSON value "giropay"

PaymentIntentLastPaymentError'Source'Type'EnumIdeal

Represents the JSON value "ideal"

PaymentIntentLastPaymentError'Source'Type'EnumKlarna

Represents the JSON value "klarna"

PaymentIntentLastPaymentError'Source'Type'EnumMultibanco

Represents the JSON value "multibanco"

PaymentIntentLastPaymentError'Source'Type'EnumP24

Represents the JSON value "p24"

PaymentIntentLastPaymentError'Source'Type'EnumSepaDebit

Represents the JSON value "sepa_debit"

PaymentIntentLastPaymentError'Source'Type'EnumSofort

Represents the JSON value "sofort"

PaymentIntentLastPaymentError'Source'Type'EnumThreeDSecure

Represents the JSON value "three_d_secure"

PaymentIntentLastPaymentError'Source'Type'EnumWechat

Represents the JSON value "wechat"

Instances

Eq PaymentIntentLastPaymentError'Source'Type'

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntentLastPaymentError'Source'Type' -> PaymentIntentLastPaymentError'Source'Type' -> Bool

(/=) :: PaymentIntentLastPaymentError'Source'Type' -> PaymentIntentLastPaymentError'Source'Type' -> Bool

Show PaymentIntentLastPaymentError'Source'Type'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError'Source'Type' -> ShowS

show :: PaymentIntentLastPaymentError'Source'Type' -> String

showList :: [PaymentIntentLastPaymentError'Source'Type'] -> ShowS

ToJSON PaymentIntentLastPaymentError'Source'Type'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError'Source'Type' -> Value

toEncoding :: PaymentIntentLastPaymentError'Source'Type' -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'Source'Type'] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'Source'Type'] -> Encoding

FromJSON PaymentIntentLastPaymentError'Source'Type'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'Source'Type'

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError'Source'Type']

data PaymentIntentLastPaymentError'Type'

Defines the enum schema located at components.schemas.payment_intent.properties.last_payment_error.anyOf.properties.type in the specification.

The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error`

Constructors

PaymentIntentLastPaymentError'Type'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentIntentLastPaymentError'Type'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentIntentLastPaymentError'Type'EnumApiConnectionError

Represents the JSON value "api_connection_error"

PaymentIntentLastPaymentError'Type'EnumApiError

Represents the JSON value "api_error"

PaymentIntentLastPaymentError'Type'EnumAuthenticationError

Represents the JSON value "authentication_error"

PaymentIntentLastPaymentError'Type'EnumCardError

Represents the JSON value "card_error"

PaymentIntentLastPaymentError'Type'EnumIdempotencyError

Represents the JSON value "idempotency_error"

PaymentIntentLastPaymentError'Type'EnumInvalidRequestError

Represents the JSON value "invalid_request_error"

PaymentIntentLastPaymentError'Type'EnumRateLimitError

Represents the JSON value "rate_limit_error"

Instances

Eq PaymentIntentLastPaymentError'Type'

Defined in StripeAPI.Types.PaymentIntent

Methods

(==) :: PaymentIntentLastPaymentError'Type' -> PaymentIntentLastPaymentError'Type' -> Bool

(/=) :: PaymentIntentLastPaymentError'Type' -> PaymentIntentLastPaymentError'Type' -> Bool

Show PaymentIntentLastPaymentError'Type'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentLastPaymentError'Type' -> ShowS

show :: PaymentIntentLastPaymentError'Type' -> String

showList :: [PaymentIntentLastPaymentError'Type'] -> ShowS

ToJSON PaymentIntentLastPaymentError'Type'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentLastPaymentError'Type' -> Value

toEncoding :: PaymentIntentLastPaymentError'Type' -> Encoding

toJSONList :: [PaymentIntentLastPaymentError'Type'] -> Value

toEncodingList :: [PaymentIntentLastPaymentError'Type'] -> Encoding

FromJSON PaymentIntentLastPaymentError'Type'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentLastPaymentError'Type'

parseJSONList :: Value -> Parser [PaymentIntentLastPaymentError'Type']

data PaymentIntentNextAction'

Defines the object schema located at components.schemas.payment_intent.properties.next_action.anyOf in the specification.

If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.

Constructors

PaymentIntentNextAction'

Fields

• paymentIntentNextAction'AlipayHandleRedirect :: Maybe PaymentIntentNextActionAlipayHandleRedirect

  alipay_handle_redirect:

• paymentIntentNextAction'BoletoDisplayDetails :: Maybe PaymentIntentNextActionBoleto

  boleto_display_details:

• paymentIntentNextAction'OxxoDisplayDetails :: Maybe PaymentIntentNextActionDisplayOxxoDetails

  oxxo_display_details:

• paymentIntentNextAction'RedirectToUrl :: Maybe PaymentIntentNextActionRedirectToUrl

  redirect_to_url:

• paymentIntentNextAction'Type :: Maybe Text

  type: Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, or `oxxo_display_details`.

  Constraints:

  • Maximum length of 5000
• paymentIntentNextAction'UseStripeSdk :: Maybe Object

  use_stripe_sdk: When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.

• paymentIntentNextAction'VerifyWithMicrodeposits :: Maybe PaymentIntentNextActionVerifyWithMicrodeposits

  verify_with_microdeposits:

Instances

Eq PaymentIntentNextAction'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentNextAction'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentNextAction' -> ShowS

show :: PaymentIntentNextAction' -> String

showList :: [PaymentIntentNextAction'] -> ShowS

ToJSON PaymentIntentNextAction'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentNextAction' -> Value

toEncoding :: PaymentIntentNextAction' -> Encoding

toJSONList :: [PaymentIntentNextAction'] -> Value

toEncodingList :: [PaymentIntentNextAction'] -> Encoding

FromJSON PaymentIntentNextAction'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentNextAction'

parseJSONList :: Value -> Parser [PaymentIntentNextAction']

mkPaymentIntentNextAction' :: PaymentIntentNextAction'

Create a new PaymentIntentNextAction' with all required fields.

data PaymentIntentOnBehalfOf'Variants

Defines the oneOf schema located at components.schemas.payment_intent.properties.on_behalf_of.anyOf in the specification.

The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents use case for connected accounts for details.

Constructors

PaymentIntentOnBehalfOf'Text Text

PaymentIntentOnBehalfOf'Account Account

Instances

Eq PaymentIntentOnBehalfOf'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentOnBehalfOf'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

show :: PaymentIntentOnBehalfOf'Variants -> String

showList :: [PaymentIntentOnBehalfOf'Variants] -> ShowS

ToJSON PaymentIntentOnBehalfOf'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentOnBehalfOf'Variants -> Value

toEncoding :: PaymentIntentOnBehalfOf'Variants -> Encoding

toJSONList :: [PaymentIntentOnBehalfOf'Variants] -> Value

toEncodingList :: [PaymentIntentOnBehalfOf'Variants] -> Encoding

FromJSON PaymentIntentOnBehalfOf'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentOnBehalfOf'Variants

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

data PaymentIntentPaymentMethod'Variants

Defines the oneOf schema located at components.schemas.payment_intent.properties.payment_method.anyOf in the specification.

ID of the payment method used in this PaymentIntent.

Constructors

PaymentIntentPaymentMethod'Text Text

PaymentIntentPaymentMethod'PaymentMethod PaymentMethod

Instances

Eq PaymentIntentPaymentMethod'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentPaymentMethod'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

show :: PaymentIntentPaymentMethod'Variants -> String

showList :: [PaymentIntentPaymentMethod'Variants] -> ShowS

ToJSON PaymentIntentPaymentMethod'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentPaymentMethod'Variants -> Value

toEncoding :: PaymentIntentPaymentMethod'Variants -> Encoding

toJSONList :: [PaymentIntentPaymentMethod'Variants] -> Value

toEncodingList :: [PaymentIntentPaymentMethod'Variants] -> Encoding

FromJSON PaymentIntentPaymentMethod'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentPaymentMethod'Variants

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

data PaymentIntentPaymentMethodOptions'

Defines the object schema located at components.schemas.payment_intent.properties.payment_method_options.anyOf in the specification.

Payment-method-specific configuration for this PaymentIntent.

Constructors

PaymentIntentPaymentMethodOptions'

Fields

• paymentIntentPaymentMethodOptions'AcssDebit :: Maybe PaymentIntentPaymentMethodOptionsAcssDebit

  acss_debit:

• paymentIntentPaymentMethodOptions'AfterpayClearpay :: Maybe PaymentMethodOptionsAfterpayClearpay

  afterpay_clearpay:

• paymentIntentPaymentMethodOptions'Alipay :: Maybe PaymentMethodOptionsAlipay

  alipay:

• paymentIntentPaymentMethodOptions'Bancontact :: Maybe PaymentMethodOptionsBancontact

  bancontact:

• paymentIntentPaymentMethodOptions'Boleto :: Maybe PaymentMethodOptionsBoleto

  boleto:

• paymentIntentPaymentMethodOptions'Card :: Maybe PaymentIntentPaymentMethodOptionsCard

  card:

• paymentIntentPaymentMethodOptions'CardPresent :: Maybe PaymentMethodOptionsCardPresent

  card_present:

• paymentIntentPaymentMethodOptions'Oxxo :: Maybe PaymentMethodOptionsOxxo

  oxxo:

• paymentIntentPaymentMethodOptions'P24 :: Maybe PaymentMethodOptionsP24

  p24:

• paymentIntentPaymentMethodOptions'SepaDebit :: Maybe PaymentIntentPaymentMethodOptionsSepaDebit

  sepa_debit:

• paymentIntentPaymentMethodOptions'Sofort :: Maybe PaymentMethodOptionsSofort

  sofort:

Instances

Eq PaymentIntentPaymentMethodOptions'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentPaymentMethodOptions'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentPaymentMethodOptions' -> ShowS

show :: PaymentIntentPaymentMethodOptions' -> String

showList :: [PaymentIntentPaymentMethodOptions'] -> ShowS

ToJSON PaymentIntentPaymentMethodOptions'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentPaymentMethodOptions' -> Value

toEncoding :: PaymentIntentPaymentMethodOptions' -> Encoding

toJSONList :: [PaymentIntentPaymentMethodOptions'] -> Value

toEncodingList :: [PaymentIntentPaymentMethodOptions'] -> Encoding

FromJSON PaymentIntentPaymentMethodOptions'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentPaymentMethodOptions'

parseJSONList :: Value -> Parser [PaymentIntentPaymentMethodOptions']

mkPaymentIntentPaymentMethodOptions' :: PaymentIntentPaymentMethodOptions'

Create a new PaymentIntentPaymentMethodOptions' with all required fields.

data PaymentIntentReview'Variants

Defines the oneOf schema located at components.schemas.payment_intent.properties.review.anyOf in the specification.

ID of the review associated with this PaymentIntent, if any.

Constructors

PaymentIntentReview'Text Text

PaymentIntentReview'Review Review

Instances

Eq PaymentIntentReview'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentReview'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

show :: PaymentIntentReview'Variants -> String

showList :: [PaymentIntentReview'Variants] -> ShowS

ToJSON PaymentIntentReview'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentReview'Variants -> Value

toEncoding :: PaymentIntentReview'Variants -> Encoding

toJSONList :: [PaymentIntentReview'Variants] -> Value

toEncodingList :: [PaymentIntentReview'Variants] -> Encoding

FromJSON PaymentIntentReview'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentReview'Variants

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

data PaymentIntentSetupFutureUsage'

Defines the enum schema located at components.schemas.payment_intent.properties.setup_future_usage in the specification.

Indicates that you intend to make future payments with this PaymentIntent's payment method.

Providing this parameter will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.

When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

Constructors

PaymentIntentSetupFutureUsage'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentIntentSetupFutureUsage'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentIntentSetupFutureUsage'EnumOffSession

Represents the JSON value "off_session"

PaymentIntentSetupFutureUsage'EnumOnSession

Represents the JSON value "on_session"

Instances

Eq PaymentIntentSetupFutureUsage'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentSetupFutureUsage'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentSetupFutureUsage' -> ShowS

show :: PaymentIntentSetupFutureUsage' -> String

showList :: [PaymentIntentSetupFutureUsage'] -> ShowS

ToJSON PaymentIntentSetupFutureUsage'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentSetupFutureUsage' -> Value

toEncoding :: PaymentIntentSetupFutureUsage' -> Encoding

toJSONList :: [PaymentIntentSetupFutureUsage'] -> Value

toEncodingList :: [PaymentIntentSetupFutureUsage'] -> Encoding

FromJSON PaymentIntentSetupFutureUsage'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentSetupFutureUsage'

parseJSONList :: Value -> Parser [PaymentIntentSetupFutureUsage']

data PaymentIntentShipping'

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

Shipping information for this PaymentIntent.

Constructors

PaymentIntentShipping'

Fields

• paymentIntentShipping'Address :: Maybe Address

  address:

• paymentIntentShipping'Carrier :: Maybe Text

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

  Constraints:

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

  name: Recipient name.

  Constraints:

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

  phone: Recipient phone (including extension).

  Constraints:

  • Maximum length of 5000
• paymentIntentShipping'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 PaymentIntentShipping'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentShipping'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentShipping' -> ShowS

show :: PaymentIntentShipping' -> String

showList :: [PaymentIntentShipping'] -> ShowS

ToJSON PaymentIntentShipping'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentShipping' -> Value

toEncoding :: PaymentIntentShipping' -> Encoding

toJSONList :: [PaymentIntentShipping'] -> Value

toEncodingList :: [PaymentIntentShipping'] -> Encoding

FromJSON PaymentIntentShipping'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentShipping'

parseJSONList :: Value -> Parser [PaymentIntentShipping']

mkPaymentIntentShipping' :: PaymentIntentShipping'

Create a new PaymentIntentShipping' with all required fields.

data PaymentIntentStatus'

Defines the enum schema located at components.schemas.payment_intent.properties.status in the specification.

Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent status.

Constructors

PaymentIntentStatus'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

PaymentIntentStatus'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

PaymentIntentStatus'EnumCanceled

Represents the JSON value "canceled"

PaymentIntentStatus'EnumProcessing

Represents the JSON value "processing"

PaymentIntentStatus'EnumRequiresAction

Represents the JSON value "requires_action"

PaymentIntentStatus'EnumRequiresCapture

Represents the JSON value "requires_capture"

PaymentIntentStatus'EnumRequiresConfirmation

Represents the JSON value "requires_confirmation"

PaymentIntentStatus'EnumRequiresPaymentMethod

Represents the JSON value "requires_payment_method"

PaymentIntentStatus'EnumSucceeded

Represents the JSON value "succeeded"

Instances

Eq PaymentIntentStatus'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentStatus'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentStatus' -> ShowS

show :: PaymentIntentStatus' -> String

showList :: [PaymentIntentStatus'] -> ShowS

ToJSON PaymentIntentStatus'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentStatus' -> Value

toEncoding :: PaymentIntentStatus' -> Encoding

toJSONList :: [PaymentIntentStatus'] -> Value

toEncodingList :: [PaymentIntentStatus'] -> Encoding

FromJSON PaymentIntentStatus'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentStatus'

parseJSONList :: Value -> Parser [PaymentIntentStatus']

data PaymentIntentTransferData'

Defines the object schema located at components.schemas.payment_intent.properties.transfer_data.anyOf in the specification.

The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents use case for connected accounts for details.

Constructors

PaymentIntentTransferData'

Fields

• paymentIntentTransferData'Amount :: Maybe Int

  amount: Amount intended to be collected by this PaymentIntent. 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).

• paymentIntentTransferData'Destination :: Maybe PaymentIntentTransferData'Destination'Variants

  destination: The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.

Instances

Eq PaymentIntentTransferData'

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentTransferData'

Defined in StripeAPI.Types.PaymentIntent

Methods

showsPrec :: Int -> PaymentIntentTransferData' -> ShowS

show :: PaymentIntentTransferData' -> String

showList :: [PaymentIntentTransferData'] -> ShowS

ToJSON PaymentIntentTransferData'

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentTransferData' -> Value

toEncoding :: PaymentIntentTransferData' -> Encoding

toJSONList :: [PaymentIntentTransferData'] -> Value

toEncodingList :: [PaymentIntentTransferData'] -> Encoding

FromJSON PaymentIntentTransferData'

Defined in StripeAPI.Types.PaymentIntent

Methods

parseJSON :: Value -> Parser PaymentIntentTransferData'

parseJSONList :: Value -> Parser [PaymentIntentTransferData']

mkPaymentIntentTransferData' :: PaymentIntentTransferData'

Create a new PaymentIntentTransferData' with all required fields.

data PaymentIntentTransferData'Destination'Variants

Defines the oneOf schema located at components.schemas.payment_intent.properties.transfer_data.anyOf.properties.destination.anyOf in the specification.

The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to upon payment success.

Constructors

PaymentIntentTransferData'Destination'Text Text

PaymentIntentTransferData'Destination'Account Account

Instances

Eq PaymentIntentTransferData'Destination'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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

Show PaymentIntentTransferData'Destination'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

show :: PaymentIntentTransferData'Destination'Variants -> String

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

ToJSON PaymentIntentTransferData'Destination'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

toJSON :: PaymentIntentTransferData'Destination'Variants -> Value

toEncoding :: PaymentIntentTransferData'Destination'Variants -> Encoding

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

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

FromJSON PaymentIntentTransferData'Destination'Variants

Defined in StripeAPI.Types.PaymentIntent

Methods

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

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