StripeAPI.Types.OrdersV2ResourcePayment · stripeapi-3.0.0.0

datadata OrdersV2ResourcePayment

#

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

Constructors

OrdersV2ResourcePayment
- ordersV2ResourcePaymentPaymentIntent :: Maybe (Nullable OrdersV2ResourcePaymentPaymentIntent'NonNullableVariants)
  payment_intent: ID of the payment intent associated with this order. Null when the order is `open`.
- ordersV2ResourcePaymentSettings :: Maybe (Nullable OrdersV2ResourcePaymentSettings'NonNullable)
  settings: Settings describing how the order should configure generated PaymentIntents.
- ordersV2ResourcePaymentStatus :: Maybe (Nullable OrdersV2ResourcePaymentStatus'NonNullable)
  status: The status of the underlying payment associated with this order, if any. Null when the order is `open`.

Instances4Eq, Show, FromJSON, ToJSON

Eq OrdersV2ResourcePaymentDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
Show OrdersV2ResourcePaymentDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
FromJSON OrdersV2ResourcePaymentDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
ToJSON OrdersV2ResourcePaymentDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment

valuemkOrdersV2ResourcePayment :: OrdersV2ResourcePayment

#

Create a new OrdersV2ResourcePayment with all required fields.

datadata OrdersV2ResourcePaymentPaymentIntent'NonNullableVariants

#

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

ID of the payment intent associated with this order. Null when the order is `open`.

Constructors

OrdersV2ResourcePaymentPaymentIntent'NonNullableText Text
OrdersV2ResourcePaymentPaymentIntent'NonNullablePaymentIntent PaymentIntent

Instances4Eq, Show, FromJSON, ToJSON

Eq OrdersV2ResourcePaymentPaymentIntent'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
Show OrdersV2ResourcePaymentPaymentIntent'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
FromJSON OrdersV2ResourcePaymentPaymentIntent'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
ToJSON OrdersV2ResourcePaymentPaymentIntent'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment

datadata OrdersV2ResourcePaymentSettings'NonNullable

#

Defines the object schema located at components.schemas.orders_v2_resource_payment.properties.settings.anyOf in the specification.

Settings describing how the order should configure generated PaymentIntents.

Constructors

OrdersV2ResourcePaymentSettings'NonNullable
- ordersV2ResourcePaymentSettings'NonNullableApplicationFeeAmount :: Maybe (Nullable 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.
- ordersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods :: Maybe (Nullable OrdersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullable)
  automatic_payment_methods: Indicates whether order has been opted into using Stripe Dashboard to manage payment method types.
- ordersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions :: Maybe (Nullable OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions'NonNullable)
  payment_method_options: PaymentMethod-specific configuration to provide to the order's PaymentIntent.
- ordersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes :: Maybe (Nullable [OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullable])
  payment_method_types: The list of payment method types to provide to the order's PaymentIntent. Do not include this attribute if you prefer to manage your payment methods from the Stripe Dashboard.
- ordersV2ResourcePaymentSettings'NonNullableReturnUrl :: Maybe (Nullable Text)
  return_url: The URL to redirect the customer to after they authenticate their payment.
  Constraints:
  - Maximum length of 5000
- ordersV2ResourcePaymentSettings'NonNullableStatementDescriptor :: Maybe (Nullable 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
- ordersV2ResourcePaymentSettings'NonNullableStatementDescriptorSuffix :: Maybe (Nullable 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
- ordersV2ResourcePaymentSettings'NonNullableTransferData :: Maybe (Nullable OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullable)
  transfer_data: Provides configuration for completing a transfer for the order after it is paid.

Instances4Eq, Show, FromJSON, ToJSON

Eq OrdersV2ResourcePaymentSettings'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
Show OrdersV2ResourcePaymentSettings'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
FromJSON OrdersV2ResourcePaymentSettings'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
ToJSON OrdersV2ResourcePaymentSettings'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment

valuemkOrdersV2ResourcePaymentSettings'NonNullable :: OrdersV2ResourcePaymentSettings'NonNullable

#

Create a new OrdersV2ResourcePaymentSettings'NonNullable with all required fields.

datadata OrdersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullable

#

Defines the object schema located at components.schemas.orders_v2_resource_payment.properties.settings.anyOf.properties.automatic_payment_methods.anyOf in the specification.

Indicates whether order has been opted into using Stripe Dashboard to manage payment method types.

Constructors

OrdersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullable
- ordersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullableEnabled :: Maybe Bool
  enabled: Whether this Order has been opted into managing payment method types via the Stripe Dashboard.

Instances4Eq, Show, FromJSON, ToJSON

Eq OrdersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
Show OrdersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
FromJSON OrdersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
ToJSON OrdersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment

value

mkOrdersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullable :: OrdersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullable

#

Create a new OrdersV2ResourcePaymentSettings'NonNullableAutomaticPaymentMethods'NonNullable with all required fields.

datadata OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions'NonNullable

#

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

PaymentMethod-specific configuration to provide to the order\'s PaymentIntent.

Constructors

OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions'NonNullable

Instances4Eq, Show, FromJSON, ToJSON

Eq OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
Show OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
FromJSON OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
ToJSON OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment

value

mkOrdersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions'NonNullable :: OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions'NonNullable

#

Create a new OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodOptions'NonNullable with all required fields.

datadata OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullable

#

Defines the enum schema located at components.schemas.orders_v2_resource_payment.properties.settings.anyOf.properties.payment_method_types.items in the specification.

Constructors

OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumAcssDebit
Represents the JSON value "acss_debit"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumAfterpayClearpay
Represents the JSON value "afterpay_clearpay"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumAlipay
Represents the JSON value "alipay"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumAuBecsDebit
Represents the JSON value "au_becs_debit"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumBacsDebit
Represents the JSON value "bacs_debit"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumBancontact
Represents the JSON value "bancontact"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumCard
Represents the JSON value "card"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumCustomerBalance
Represents the JSON value "customer_balance"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumEps
Represents the JSON value "eps"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumFpx
Represents the JSON value "fpx"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumGiropay
Represents the JSON value "giropay"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumGrabpay
Represents the JSON value "grabpay"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumIdeal
Represents the JSON value "ideal"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumKlarna
Represents the JSON value "klarna"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumLink
Represents the JSON value "link"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumOxxo
Represents the JSON value "oxxo"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumP24
Represents the JSON value "p24"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumPaypal
Represents the JSON value "paypal"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumSepaDebit
Represents the JSON value "sepa_debit"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumSofort
Represents the JSON value "sofort"
OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableEnumWechatPay
Represents the JSON value "wechat_pay"

Instances4Eq, Show, FromJSON, ToJSON

Eq OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
Show OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
FromJSON OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
ToJSON OrdersV2ResourcePaymentSettings'NonNullablePaymentMethodTypes'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment

datadata OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullable

#

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

Provides configuration for completing a transfer for the order after it is paid.

Constructors

OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullable
- ordersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableAmount :: Maybe (Nullable Int)
  amount: The amount that will be transferred automatically when the order is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
- ordersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDestination :: Maybe OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDestination'Variants
  destination: ID of the Connected account receiving the transfer.

Instances4Eq, Show, FromJSON, ToJSON

Eq OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
Show OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
FromJSON OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
ToJSON OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment

value

mkOrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullable :: OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullable

#

Create a new OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullable with all required fields.

datadata OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDestination'Variants

#

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

ID of the Connected account receiving the transfer.

Constructors

OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDestination'Text Text
OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDestination'Account Account

Instances4Eq, Show, FromJSON, ToJSON

Eq OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
Show OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
FromJSON OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
ToJSON OrdersV2ResourcePaymentSettings'NonNullableTransferData'NonNullableDestination'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment

datadata OrdersV2ResourcePaymentStatus'NonNullable

#

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

The status of the underlying payment associated with this order, if any. Null when the order is `open`.

Constructors

OrdersV2ResourcePaymentStatus'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
OrdersV2ResourcePaymentStatus'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
OrdersV2ResourcePaymentStatus'NonNullableEnumCanceled
Represents the JSON value "canceled"
OrdersV2ResourcePaymentStatus'NonNullableEnumComplete
Represents the JSON value "complete"
OrdersV2ResourcePaymentStatus'NonNullableEnumNotRequired
Represents the JSON value "not_required"
OrdersV2ResourcePaymentStatus'NonNullableEnumProcessing
Represents the JSON value "processing"
OrdersV2ResourcePaymentStatus'NonNullableEnumRequiresAction
Represents the JSON value "requires_action"
OrdersV2ResourcePaymentStatus'NonNullableEnumRequiresCapture
Represents the JSON value "requires_capture"
OrdersV2ResourcePaymentStatus'NonNullableEnumRequiresConfirmation
Represents the JSON value "requires_confirmation"
OrdersV2ResourcePaymentStatus'NonNullableEnumRequiresPaymentMethod
Represents the JSON value "requires_payment_method"

Instances4Eq, Show, FromJSON, ToJSON

Eq OrdersV2ResourcePaymentStatus'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
Show OrdersV2ResourcePaymentStatus'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
FromJSON OrdersV2ResourcePaymentStatus'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment
ToJSON OrdersV2ResourcePaymentStatus'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.OrdersV2ResourcePayment