payment_flows_private_payment_methods_card_present_common_wallet
{
"type": "object",
"title": "PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"apple_pay",
"google_pay",
"samsung_pay",
"unknown"
],
"type": "string",
"description": "The type of mobile wallet, one of `apple_pay`, `google_pay`, `samsung_pay`, or `unknown`."
}
},
"description": "",
"x-expandableFields": []
}
payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters
{
"type": "object",
"title": "PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFilters",
"properties": {
"account_subcategories": {
"type": "array",
"items": {
"enum": [
"checking",
"savings"
],
"type": "string"
},
"description": "The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`."
}
},
"description": "",
"x-expandableFields": []
}
payment_flows_private_payment_methods_kakao_pay_payment_method_options
{
"type": "object",
"title": "PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_flows_private_payment_methods_klarna_dob
{
"type": "object",
"title": "PaymentFlowsPrivatePaymentMethodsKlarnaDOB",
"properties": {
"day": {
"type": "integer",
"nullable": true,
"description": "The day of birth, between 1 and 31."
},
"year": {
"type": "integer",
"nullable": true,
"description": "The four-digit year of birth."
},
"month": {
"type": "integer",
"nullable": true,
"description": "The month of birth, between 1 and 12."
}
},
"description": "",
"x-expandableFields": []
}
payment_flows_private_payment_methods_klarna_payment_intent_amount_details_line_item_payment_method_options
{
"type": "object",
"title": "PaymentFlowsPrivatePaymentMethodsKlarnaPaymentIntentAmountDetailsLineItemPaymentMethodOptions",
"properties": {
"image_url": {
"type": "string",
"nullable": true,
"maxLength": 2048
},
"reference": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"product_url": {
"type": "string",
"nullable": true,
"maxLength": 2048
},
"subscription_reference": {
"type": "string",
"nullable": true,
"maxLength": 2048
}
},
"description": "",
"x-expandableFields": []
}
payment_flows_private_payment_methods_naver_pay_payment_method_options
{
"type": "object",
"title": "PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_flows_private_payment_methods_payco_payment_method_options
{
"type": "object",
"title": "PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
}
},
"description": "",
"x-expandableFields": []
}
payment_flows_private_payment_methods_paypal_amount_details_line_item_payment_method_options
{
"type": "object",
"title": "PaymentFlowsPrivatePaymentMethodsPaypalAmountDetailsLineItemPaymentMethodOptions",
"properties": {
"sold_by": {
"type": "string",
"maxLength": 5000,
"description": "The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers)."
},
"category": {
"enum": [
"digital_goods",
"donation",
"physical_goods"
],
"type": "string",
"description": "Type of the line item."
},
"description": {
"type": "string",
"maxLength": 5000,
"description": "Description of the line item."
}
},
"description": "",
"x-expandableFields": []
}
payment_flows_private_payment_methods_samsung_pay_payment_method_options
{
"type": "object",
"title": "PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent
{
"type": "object",
"title": "PaymentIntent",
"required": [
"created",
"id",
"livemode",
"object",
"status"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"hooks": {
"$ref": "#/components/schemas/payment_flows_payment_intent_async_workflows"
},
"amount": {
"type": "integer",
"description": "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (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](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."
},
"object": {
"enum": [
"payment_intent"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"review": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/review"
}
],
"nullable": true,
"description": "ID of the review associated with this PaymentIntent, if any.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/review"
}
]
}
},
"status": {
"enum": [
"canceled",
"processing",
"requires_action",
"requires_capture",
"requires_confirmation",
"requires_payment_method",
"succeeded"
],
"type": "string",
"description": "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](https://docs.stripe.com/payments/intents#intent-statuses).",
"x-stripeBypassValidation": true
},
"created": {
"type": "integer",
"format": "unix-time",
"description": "Time at which the object was created. Measured in seconds since the Unix epoch."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"customer": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
],
"nullable": true,
"description": "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/customer"
},
{
"$ref": "#/components/schemas/deleted_customer"
}
]
}
},
"livemode": {
"type": "boolean",
"description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
},
"metadata": {
"type": "object",
"description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).",
"additionalProperties": {
"type": "string",
"maxLength": 500
}
},
"shipping": {
"anyOf": [
{
"$ref": "#/components/schemas/shipping"
}
],
"nullable": true,
"description": "Shipping information for this PaymentIntent."
},
"processing": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_processing"
}
],
"nullable": true,
"description": "If present, this property tells you about the processing state of the payment."
},
"application": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/application"
}
],
"nullable": true,
"description": "ID of the Connect application that created the PaymentIntent.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application"
}
]
}
},
"canceled_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An arbitrary string attached to the object. Often useful for displaying to users."
},
"next_action": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_next_action"
}
],
"nullable": true,
"description": "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."
},
"on_behalf_of": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/account"
}
],
"nullable": true,
"description": "You can specify the settlement merchant as the\nconnected account using the `on_behalf_of` attribute on the charge. See the PaymentIntents [use case for connected accounts](/payments/connected-accounts) for details.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/account"
}
]
}
},
"client_secret": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled."
},
"latest_charge": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/charge"
}
],
"nullable": true,
"description": "ID of the latest [Charge object](https://docs.stripe.com/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/charge"
}
]
}
},
"receipt_email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "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](https://dashboard.stripe.com/account/emails)."
},
"transfer_data": {
"anyOf": [
{
"$ref": "#/components/schemas/transfer_data"
}
],
"nullable": true,
"description": "The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts)."
},
"amount_details": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_amount_details"
},
{
"$ref": "#/components/schemas/payment_flows_amount_details_client"
}
]
},
"capture_method": {
"enum": [
"automatic",
"automatic_async",
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"payment_method": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"$ref": "#/components/schemas/payment_method"
}
],
"nullable": true,
"description": "ID of the payment method used in this PaymentIntent.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_method"
}
]
}
},
"transfer_group": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers)."
},
"amount_received": {
"type": "integer",
"description": "Amount that this PaymentIntent collects."
},
"payment_details": {
"$ref": "#/components/schemas/payment_flows_payment_details"
},
"customer_account": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "ID of the Account representing the customer that this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Accounts cannot be used with this PaymentIntent.\n\nIf [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead."
},
"managed_payments": {
"anyOf": [
{
"$ref": "#/components/schemas/smor_resource_managed_payments"
}
],
"nullable": true,
"description": "Settings for Managed Payments."
},
"amount_capturable": {
"type": "integer",
"description": "Amount that can be captured from this PaymentIntent."
},
"last_payment_error": {
"anyOf": [
{
"$ref": "#/components/schemas/api_errors"
}
],
"nullable": true,
"description": "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason."
},
"setup_future_usage": {
"enum": [
"off_session",
"on_session"
],
"type": "string",
"nullable": true,
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
},
"cancellation_reason": {
"enum": [
"abandoned",
"automatic",
"duplicate",
"expired",
"failed_invoice",
"fraudulent",
"requested_by_customer",
"void_invoice"
],
"type": "string",
"nullable": true,
"description": "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`, `automatic`, or `expired`)."
},
"confirmation_method": {
"enum": [
"automatic",
"manual"
],
"type": "string",
"description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment."
},
"presentment_details": {
"$ref": "#/components/schemas/payment_flows_payment_intent_presentment_details"
},
"payment_method_types": {
"type": "array",
"items": {
"type": "string",
"maxLength": 5000
},
"description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)."
},
"statement_descriptor": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).\n\nSetting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead."
},
"application_fee_amount": {
"type": "integer",
"nullable": true,
"description": "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 amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts)."
},
"payment_method_options": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options"
}
],
"nullable": true,
"description": "Payment-method-specific configuration for this PaymentIntent."
},
"automatic_payment_methods": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_automatic_payment_methods_payment_intent"
}
],
"nullable": true,
"description": "Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)"
},
"statement_descriptor_suffix": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement."
},
"excluded_payment_method_types": {
"type": "array",
"items": {
"enum": [
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"blik",
"boleto",
"card",
"cashapp",
"crypto",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"mb_way",
"mobilepay",
"multibanco",
"naver_pay",
"nz_bank_account",
"oxxo",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"revolut_pay",
"samsung_pay",
"satispay",
"sepa_debit",
"sofort",
"sunbit",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat_pay",
"zip"
],
"type": "string",
"x-stripeBypassValidation": true
},
"nullable": true,
"description": "The list of payment method types to exclude from use with this payment."
},
"payment_method_configuration_details": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
}
],
"nullable": true,
"description": "Information about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this PaymentIntent."
}
},
"description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](/payments/paymentintents/lifecycle)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents)",
"x-resourceId": "payment_intent",
"x-expandableFields": [
"amount_details",
"application",
"automatic_payment_methods",
"customer",
"hooks",
"last_payment_error",
"latest_charge",
"managed_payments",
"next_action",
"on_behalf_of",
"payment_details",
"payment_method",
"payment_method_configuration_details",
"payment_method_options",
"presentment_details",
"processing",
"review",
"shipping",
"transfer_data"
]
}
payment_intent_amount_details_line_item
{
"type": "object",
"title": "PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItem",
"required": [
"id",
"object",
"product_name",
"quantity",
"unit_cost"
],
"properties": {
"id": {
"type": "string",
"maxLength": 5000,
"description": "Unique identifier for the object."
},
"tax": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_tax"
}
],
"nullable": true,
"description": "Contains information about the tax on the item."
},
"object": {
"enum": [
"payment_intent_amount_details_line_item"
],
"type": "string",
"description": "String representing the object's type. Objects of the same type share the same value."
},
"quantity": {
"type": "integer",
"description": "The quantity of items. Required for L3 rates. An integer greater than 0."
},
"unit_cost": {
"type": "integer",
"description": "The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0."
},
"product_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long."
},
"product_name": {
"type": "string",
"maxLength": 5000,
"description": "The product name of the line item. Required for L3 rates. At most 1024 characters long.\n\nFor Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters."
},
"discount_amount": {
"type": "integer",
"nullable": true,
"description": "The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0.\n\nThis field is mutually exclusive with the `amount_details[discount_amount]` field."
},
"unit_of_measure": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long."
},
"payment_method_options": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_payment_method_options"
}
],
"nullable": true,
"description": "Payment method-specific information for line items."
}
},
"description": "",
"x-resourceId": "payment_intent_amount_details_line_item",
"x-expandableFields": [
"payment_method_options",
"tax"
]
}
payment_intent_card_processing
{
"type": "object",
"title": "PaymentIntentCardProcessing",
"properties": {
"customer_notification": {
"$ref": "#/components/schemas/payment_intent_processing_customer_notification"
}
},
"description": "",
"x-expandableFields": [
"customer_notification"
]
}
payment_intent_next_action
{
"type": "object",
"title": "PaymentIntentNextAction",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"maxLength": 5000,
"description": "Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`."
},
"use_stripe_sdk": {
"type": "object",
"description": "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."
},
"redirect_to_url": {
"$ref": "#/components/schemas/payment_intent_next_action_redirect_to_url"
},
"pix_display_qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_pix_display_qr_code"
},
"oxxo_display_details": {
"$ref": "#/components/schemas/payment_intent_next_action_display_oxxo_details"
},
"alipay_handle_redirect": {
"$ref": "#/components/schemas/payment_intent_next_action_alipay_handle_redirect"
},
"boleto_display_details": {
"$ref": "#/components/schemas/payment_intent_next_action_boleto"
},
"klarna_display_qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_klarna_display_qr_code"
},
"paynow_display_qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_paynow_display_qr_code"
},
"card_await_notification": {
"$ref": "#/components/schemas/payment_intent_next_action_card_await_notification"
},
"konbini_display_details": {
"$ref": "#/components/schemas/payment_intent_next_action_konbini"
},
"promptpay_display_qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_promptpay_display_qr_code"
},
"verify_with_microdeposits": {
"$ref": "#/components/schemas/payment_intent_next_action_verify_with_microdeposits"
},
"multibanco_display_details": {
"$ref": "#/components/schemas/payment_intent_next_action_display_multibanco_details"
},
"wechat_pay_display_qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_display_qr_code"
},
"wechat_pay_redirect_to_ios_app": {
"$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_ios_app"
},
"display_bank_transfer_instructions": {
"$ref": "#/components/schemas/payment_intent_next_action_display_bank_transfer_instructions"
},
"wechat_pay_redirect_to_android_app": {
"$ref": "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_android_app"
},
"upi_handle_redirect_or_display_qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_upi_handle_redirect_or_display_qr_code"
},
"swish_handle_redirect_or_display_qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_swish_handle_redirect_or_display_qr_code"
},
"cashapp_handle_redirect_or_display_qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code"
}
},
"description": "",
"x-expandableFields": [
"alipay_handle_redirect",
"boleto_display_details",
"card_await_notification",
"cashapp_handle_redirect_or_display_qr_code",
"display_bank_transfer_instructions",
"klarna_display_qr_code",
"konbini_display_details",
"multibanco_display_details",
"oxxo_display_details",
"paynow_display_qr_code",
"pix_display_qr_code",
"promptpay_display_qr_code",
"redirect_to_url",
"swish_handle_redirect_or_display_qr_code",
"upi_handle_redirect_or_display_qr_code",
"verify_with_microdeposits",
"wechat_pay_display_qr_code",
"wechat_pay_redirect_to_android_app",
"wechat_pay_redirect_to_ios_app"
]
}
payment_intent_next_action_alipay_handle_redirect
{
"type": "object",
"title": "PaymentIntentNextActionAlipayHandleRedirect",
"properties": {
"url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The URL you must redirect your customer to in order to authenticate the payment."
},
"native_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App."
},
"return_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."
},
"native_data": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_boleto
{
"type": "object",
"title": "payment_intent_next_action_boleto",
"properties": {
"pdf": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The URL to the downloadable boleto voucher PDF."
},
"number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The boleto number."
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The timestamp after which the boleto expires."
},
"hosted_voucher_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_card_await_notification
{
"type": "object",
"title": "PaymentIntentNextActionCardAwaitNotification",
"properties": {
"charge_attempt_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The time that payment will be attempted. If customer approval is required, they need to provide approval before this time."
},
"customer_approval_required": {
"type": "boolean",
"nullable": true,
"description": "For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode",
"required": [
"hosted_instructions_url",
"mobile_auth_url",
"qr_code"
],
"properties": {
"qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_cashapp_qr_code"
},
"mobile_auth_url": {
"type": "string",
"maxLength": 5000,
"description": "The url for mobile redirect based auth"
},
"hosted_instructions_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration."
}
},
"description": "",
"x-expandableFields": [
"qr_code"
]
}
payment_intent_next_action_cashapp_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionCashappQRCode",
"required": [
"expires_at",
"image_url_png",
"image_url_svg"
],
"properties": {
"expires_at": {
"type": "integer",
"format": "unix-time",
"description": "The date (unix timestamp) when the QR code expires."
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_png string used to render QR code"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_svg string used to render QR code"
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_display_bank_transfer_instructions
{
"type": "object",
"title": "PaymentIntentNextActionDisplayBankTransferInstructions",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"eu_bank_transfer",
"gb_bank_transfer",
"jp_bank_transfer",
"mx_bank_transfer",
"us_bank_transfer"
],
"type": "string",
"description": "Type of bank transfer",
"x-stripeBypassValidation": true
},
"currency": {
"type": "string",
"format": "currency",
"nullable": true,
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
},
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer."
},
"amount_remaining": {
"type": "integer",
"nullable": true,
"description": "The remaining amount that needs to be transferred to complete the payment."
},
"financial_addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/funding_instructions_bank_transfer_financial_address"
},
"description": "A list of financial addresses that can be used to fund the customer balance"
},
"hosted_instructions_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A link to a hosted page that guides your customer through completing the transfer."
}
},
"description": "",
"x-expandableFields": [
"financial_addresses"
]
}
payment_intent_next_action_display_multibanco_details
{
"type": "object",
"title": "PaymentIntentNextActionDisplayMultibancoDetails",
"properties": {
"entity": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Entity number associated with this Multibanco payment."
},
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Reference number associated with this Multibanco payment."
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The timestamp at which the Multibanco voucher expires."
},
"hosted_voucher_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_display_oxxo_details
{
"type": "object",
"title": "PaymentIntentNextActionDisplayOxxoDetails",
"properties": {
"number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "OXXO reference number."
},
"expires_after": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The timestamp after which the OXXO voucher expires."
},
"hosted_voucher_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_klarna_display_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionKlarnaDisplayQrCode",
"required": [
"data",
"image_url_png",
"image_url_svg"
],
"properties": {
"data": {
"type": "string",
"maxLength": 5000,
"description": "The data being used to generate QR code"
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The timestamp at which the QR code expires."
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_png string used to render QR code"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_svg string used to render QR code"
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_konbini
{
"type": "object",
"title": "payment_intent_next_action_konbini",
"required": [
"expires_at",
"stores"
],
"properties": {
"stores": {
"$ref": "#/components/schemas/payment_intent_next_action_konbini_stores"
},
"expires_at": {
"type": "integer",
"format": "unix-time",
"description": "The timestamp at which the pending Konbini payment expires."
},
"hosted_voucher_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher."
}
},
"description": "",
"x-expandableFields": [
"stores"
]
}
payment_intent_next_action_konbini_familymart
{
"type": "object",
"title": "payment_intent_next_action_konbini_familymart",
"required": [
"payment_code"
],
"properties": {
"payment_code": {
"type": "string",
"maxLength": 5000,
"description": "The payment code."
},
"confirmation_number": {
"type": "string",
"maxLength": 5000,
"description": "The confirmation number."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_konbini_lawson
{
"type": "object",
"title": "payment_intent_next_action_konbini_lawson",
"required": [
"payment_code"
],
"properties": {
"payment_code": {
"type": "string",
"maxLength": 5000,
"description": "The payment code."
},
"confirmation_number": {
"type": "string",
"maxLength": 5000,
"description": "The confirmation number."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_konbini_ministop
{
"type": "object",
"title": "payment_intent_next_action_konbini_ministop",
"required": [
"payment_code"
],
"properties": {
"payment_code": {
"type": "string",
"maxLength": 5000,
"description": "The payment code."
},
"confirmation_number": {
"type": "string",
"maxLength": 5000,
"description": "The confirmation number."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_konbini_seicomart
{
"type": "object",
"title": "payment_intent_next_action_konbini_seicomart",
"required": [
"payment_code"
],
"properties": {
"payment_code": {
"type": "string",
"maxLength": 5000,
"description": "The payment code."
},
"confirmation_number": {
"type": "string",
"maxLength": 5000,
"description": "The confirmation number."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_konbini_stores
{
"type": "object",
"title": "payment_intent_next_action_konbini_stores",
"properties": {
"lawson": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_next_action_konbini_lawson"
}
],
"nullable": true,
"description": "Lawson instruction details."
},
"ministop": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_next_action_konbini_ministop"
}
],
"nullable": true,
"description": "Ministop instruction details."
},
"seicomart": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_next_action_konbini_seicomart"
}
],
"nullable": true,
"description": "Seicomart instruction details."
},
"familymart": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_next_action_konbini_familymart"
}
],
"nullable": true,
"description": "FamilyMart instruction details."
}
},
"description": "",
"x-expandableFields": [
"familymart",
"lawson",
"ministop",
"seicomart"
]
}
payment_intent_next_action_paynow_display_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionPaynowDisplayQrCode",
"required": [
"data",
"image_url_png",
"image_url_svg"
],
"properties": {
"data": {
"type": "string",
"maxLength": 5000,
"description": "The raw data string used to generate QR code, it should be used together with QR code library."
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_png string used to render QR code"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_svg string used to render QR code"
},
"hosted_instructions_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_pix_display_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionPixDisplayQrCode",
"properties": {
"data": {
"type": "string",
"maxLength": 5000,
"description": "The raw data string used to generate QR code, it should be used together with QR code library."
},
"expires_at": {
"type": "integer",
"description": "The date (unix timestamp) when the PIX expires."
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_png string used to render png QR code"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_svg string used to render svg QR code"
},
"hosted_instructions_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL to the hosted pix instructions page, which allows customers to view the pix QR code."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_promptpay_display_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionPromptpayDisplayQrCode",
"required": [
"data",
"hosted_instructions_url",
"image_url_png",
"image_url_svg"
],
"properties": {
"data": {
"type": "string",
"maxLength": 5000,
"description": "The raw data string used to generate QR code, it should be used together with QR code library."
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The PNG path used to render the QR code, can be used as the source in an HTML img tag"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The SVG path used to render the QR code, can be used as the source in an HTML img tag"
},
"hosted_instructions_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_redirect_to_url
{
"type": "object",
"title": "PaymentIntentNextActionRedirectToUrl",
"properties": {
"url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The URL you must redirect your customer to in order to authenticate the payment."
},
"return_url": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_swish_handle_redirect_or_display_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode",
"required": [
"hosted_instructions_url",
"qr_code"
],
"properties": {
"qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_swish_qr_code"
},
"hosted_instructions_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL to the hosted Swish instructions page, which allows customers to view the QR code."
}
},
"description": "",
"x-expandableFields": [
"qr_code"
]
}
payment_intent_next_action_swish_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionSwishQRCode",
"required": [
"data",
"image_url_png",
"image_url_svg"
],
"properties": {
"data": {
"type": "string",
"maxLength": 5000,
"description": "The raw data string used to generate QR code, it should be used together with QR code library."
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_png string used to render QR code"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_svg string used to render QR code"
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_upi_handle_redirect_or_display_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionUpiHandleRedirectOrDisplayQrCode",
"required": [
"hosted_instructions_url",
"qr_code"
],
"properties": {
"qr_code": {
"$ref": "#/components/schemas/payment_intent_next_action_upiqr_code"
},
"hosted_instructions_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL to the hosted UPI instructions page, which allows customers to view the QR code."
}
},
"description": "",
"x-expandableFields": [
"qr_code"
]
}
payment_intent_next_action_upiqr_code
{
"type": "object",
"title": "PaymentIntentNextActionUPIQRCode",
"required": [
"expires_at",
"image_url_png",
"image_url_svg"
],
"properties": {
"expires_at": {
"type": "integer",
"format": "unix-time",
"description": "The date (unix timestamp) when the QR code expires."
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_png string used to render QR code"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_svg string used to render QR code"
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_verify_with_microdeposits
{
"type": "object",
"title": "PaymentIntentNextActionVerifyWithMicrodeposits",
"required": [
"arrival_date",
"hosted_verification_url"
],
"properties": {
"arrival_date": {
"type": "integer",
"format": "unix-time",
"description": "The timestamp when the microdeposits are expected to land."
},
"microdeposit_type": {
"enum": [
"amounts",
"descriptor_code"
],
"type": "string",
"nullable": true,
"description": "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods."
},
"hosted_verification_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL for the hosted verification page, which allows customers to verify their bank account."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_wechat_pay_display_qr_code
{
"type": "object",
"title": "PaymentIntentNextActionWechatPayDisplayQrCode",
"required": [
"data",
"hosted_instructions_url",
"image_data_url",
"image_url_png",
"image_url_svg"
],
"properties": {
"data": {
"type": "string",
"maxLength": 5000,
"description": "The data being used to generate QR code"
},
"image_url_png": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_png string used to render QR code"
},
"image_url_svg": {
"type": "string",
"maxLength": 5000,
"description": "The image_url_svg string used to render QR code"
},
"image_data_url": {
"type": "string",
"maxLength": 5000,
"description": "The base64 image data for a pre-generated QR code"
},
"hosted_instructions_url": {
"type": "string",
"maxLength": 5000,
"description": "The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_wechat_pay_redirect_to_android_app
{
"type": "object",
"title": "PaymentIntentNextActionWechatPayRedirectToAndroidApp",
"required": [
"app_id",
"nonce_str",
"package",
"partner_id",
"prepay_id",
"sign",
"timestamp"
],
"properties": {
"sign": {
"type": "string",
"maxLength": 5000,
"description": "A signature"
},
"app_id": {
"type": "string",
"maxLength": 5000,
"description": "app_id is the APP ID registered on WeChat open platform"
},
"package": {
"type": "string",
"maxLength": 5000,
"description": "package is static value"
},
"nonce_str": {
"type": "string",
"maxLength": 5000,
"description": "nonce_str is a random string"
},
"prepay_id": {
"type": "string",
"maxLength": 5000,
"description": "an unique trading ID assigned by WeChat Pay"
},
"timestamp": {
"type": "string",
"maxLength": 5000,
"description": "Specifies the current time in epoch format"
},
"partner_id": {
"type": "string",
"maxLength": 5000,
"description": "an unique merchant ID assigned by WeChat Pay"
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_next_action_wechat_pay_redirect_to_ios_app
{
"type": "object",
"title": "PaymentIntentNextActionWechatPayRedirectToIOSApp",
"required": [
"native_url"
],
"properties": {
"native_url": {
"type": "string",
"maxLength": 5000,
"description": "An universal link that redirect to WeChat Pay app"
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options
{
"type": "object",
"title": "PaymentIntentPaymentMethodOptions",
"properties": {
"eps": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_eps"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"fpx": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_fpx"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"p24": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_p24"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"pix": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_pix"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"upi": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_upi"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"zip": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_zip"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"alma": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_alma"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"blik": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_blik"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"card": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_card"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"link": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_link"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"oxxo": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_oxxo"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"ideal": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_ideal"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"payco": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_private_payment_methods_payco_payment_method_options"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"payto": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_payto"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"swish": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_swish"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"twint": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_twint"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"affirm": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_affirm"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"alipay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_alipay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"billie": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_billie"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"boleto": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_boleto"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"crypto": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_crypto"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"klarna": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_klarna"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"mb_way": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_mb_way"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"paynow": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_paynow"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"paypal": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_paypal"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"sofort": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_sofort"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"cashapp": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_cashapp"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"giropay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_giropay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"grabpay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_grabpay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"konbini": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_konbini"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"kr_card": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_kr_card"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"satispay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_satispay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"kakao_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_private_payment_methods_kakao_pay_payment_method_options"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"mobilepay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_mobilepay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"naver_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_private_payment_methods_naver_pay_payment_method_options"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"promptpay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_promptpay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"acss_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_acss_debit"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"amazon_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_amazon_pay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"bacs_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_bacs_debit"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"bancontact": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_bancontact"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"multibanco": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_multibanco"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"sepa_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"wechat_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_wechat_pay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"pay_by_bank": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_pay_by_bank"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"revolut_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_revolut_pay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"samsung_pay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_flows_private_payment_methods_samsung_pay_payment_method_options"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"card_present": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_card_present"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"au_becs_debit": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_au_becs_debit"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"interac_present": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_interac_present"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"nz_bank_account": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_nz_bank_account"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"us_bank_account": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_intent_payment_method_options_us_bank_account"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"customer_balance": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_customer_balance"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
},
"afterpay_clearpay": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_afterpay_clearpay"
},
{
"$ref": "#/components/schemas/payment_intent_type_specific_payment_method_options_client"
}
]
}
},
"description": "",
"x-expandableFields": [
"acss_debit",
"affirm",
"afterpay_clearpay",
"alipay",
"alma",
"amazon_pay",
"au_becs_debit",
"bacs_debit",
"bancontact",
"billie",
"blik",
"boleto",
"card",
"card_present",
"cashapp",
"crypto",
"customer_balance",
"eps",
"fpx",
"giropay",
"grabpay",
"ideal",
"interac_present",
"kakao_pay",
"klarna",
"konbini",
"kr_card",
"link",
"mb_way",
"mobilepay",
"multibanco",
"naver_pay",
"nz_bank_account",
"oxxo",
"p24",
"pay_by_bank",
"payco",
"paynow",
"paypal",
"payto",
"pix",
"promptpay",
"revolut_pay",
"samsung_pay",
"satispay",
"sepa_debit",
"sofort",
"swish",
"twint",
"upi",
"us_bank_account",
"wechat_pay",
"zip"
]
}
payment_intent_payment_method_options_acss_debit
{
"type": "object",
"title": "payment_intent_payment_method_options_acss_debit",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"mandate_options": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit"
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
},
"verification_method": {
"enum": [
"automatic",
"instant",
"microdeposits"
],
"type": "string",
"description": "Bank account verification method. The default value is `automatic`.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
payment_intent_payment_method_options_au_becs_debit
{
"type": "object",
"title": "payment_intent_payment_method_options_au_becs_debit",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_bacs_debit
{
"type": "object",
"title": "payment_intent_payment_method_options_bacs_debit",
"properties": {
"target_date": {
"type": "string",
"maxLength": 5000,
"description": "Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now."
},
"mandate_options": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_mandate_options_bacs_debit"
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
payment_intent_payment_method_options_blik
{
"type": "object",
"title": "payment_intent_payment_method_options_blik",
"properties": {
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_card
{
"type": "object",
"title": "payment_intent_payment_method_options_card",
"properties": {
"network": {
"enum": [
"amex",
"cartes_bancaires",
"diners",
"discover",
"eftpos_au",
"girocard",
"interac",
"jcb",
"link",
"mastercard",
"unionpay",
"unknown",
"visa"
],
"type": "string",
"nullable": true,
"description": "Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time."
},
"installments": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_card_installments"
}
],
"nullable": true,
"description": "Installment details for this payment.\n\nFor more information, see the [installments integration guide](https://docs.stripe.com/payments/installments)."
},
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account.",
"x-stripeBypassValidation": true
},
"mandate_options": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_options_card_mandate_options"
}
],
"nullable": true,
"description": "Configuration options for setting up an eMandate for cards issued in India."
},
"setup_future_usage": {
"enum": [
"none",
"off_session",
"on_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
},
"request_overcapture": {
"enum": [
"if_available",
"never"
],
"type": "string",
"description": "Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent."
},
"request_multicapture": {
"enum": [
"if_available",
"never"
],
"type": "string",
"description": "Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent."
},
"request_three_d_secure": {
"enum": [
"any",
"automatic",
"challenge"
],
"type": "string",
"nullable": true,
"description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"x-stripeBypassValidation": true
},
"require_cvc_recollection": {
"type": "boolean",
"description": "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter)."
},
"request_extended_authorization": {
"enum": [
"if_available",
"never"
],
"type": "string",
"description": "Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent."
},
"statement_descriptor_suffix_kana": {
"type": "string",
"maxLength": 5000,
"description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters."
},
"request_incremental_authorization": {
"enum": [
"if_available",
"never"
],
"type": "string",
"description": "Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent."
},
"statement_descriptor_suffix_kanji": {
"type": "string",
"maxLength": 5000,
"description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters."
}
},
"description": "",
"x-expandableFields": [
"installments",
"mandate_options"
]
}
payment_intent_payment_method_options_eps
{
"type": "object",
"title": "payment_intent_payment_method_options_eps",
"properties": {
"setup_future_usage": {
"enum": [
"none"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_link
{
"type": "object",
"title": "payment_intent_payment_method_options_link",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"setup_future_usage": {
"enum": [
"none",
"off_session"
],
"type": "string",
"description": "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nIf you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.\n\nIf the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.\n\nWhen processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication)."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_mandate_options_acss_debit
{
"type": "object",
"title": "payment_intent_payment_method_options_mandate_options_acss_debit",
"properties": {
"payment_schedule": {
"enum": [
"combined",
"interval",
"sporadic"
],
"type": "string",
"nullable": true,
"description": "Payment schedule for the mandate."
},
"transaction_type": {
"enum": [
"business",
"personal"
],
"type": "string",
"nullable": true,
"description": "Transaction type of the mandate."
},
"custom_mandate_url": {
"type": "string",
"maxLength": 5000,
"description": "A URL for custom mandate text"
},
"interval_description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."
}
},
"description": "",
"x-expandableFields": []
}
payment_intent_payment_method_options_mandate_options_bacs_debit
{
"type": "object",
"title": "payment_intent_payment_method_options_mandate_options_bacs_debit",
"properties": {
"reference_prefix": {
"type": "string",
"maxLength": 5000,
"description": "Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'."
}
},
"description": "",
"x-expandableFields": []
}