payment_method_options_customer_balance_bank_transfer
{
"type": "object",
"title": "payment_method_options_customer_balance_bank_transfer",
"properties": {
"type": {
"enum": [
"eu_bank_transfer",
"gb_bank_transfer",
"jp_bank_transfer",
"mx_bank_transfer",
"us_bank_transfer"
],
"type": "string",
"nullable": true,
"description": "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
"x-stripeBypassValidation": true
},
"eu_bank_transfer": {
"$ref": "#/components/schemas/payment_method_options_customer_balance_eu_bank_account"
},
"requested_address_types": {
"type": "array",
"items": {
"enum": [
"aba",
"iban",
"sepa",
"sort_code",
"spei",
"swift",
"zengin"
],
"type": "string",
"x-stripeBypassValidation": true
},
"description": "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`."
}
},
"description": "",
"x-expandableFields": [
"eu_bank_transfer"
]
}
payment_method_options_customer_balance_eu_bank_account
{
"type": "object",
"title": "payment_method_options_customer_balance_eu_bank_account",
"required": [
"country"
],
"properties": {
"country": {
"enum": [
"BE",
"DE",
"ES",
"FR",
"IE",
"NL"
],
"type": "string",
"description": "The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_fpx
{
"type": "object",
"title": "payment_method_options_fpx",
"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_method_options_giropay
{
"type": "object",
"title": "payment_method_options_giropay",
"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_method_options_grabpay
{
"type": "object",
"title": "payment_method_options_grabpay",
"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_method_options_ideal
{
"type": "object",
"title": "payment_method_options_ideal",
"properties": {
"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_method_options_interac_present
{
"type": "object",
"title": "payment_method_options_interac_present",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_options_klarna
{
"type": "object",
"title": "payment_method_options_klarna",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"preferred_locale": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Preferred locale of the Klarna checkout page that the customer is redirected to."
},
"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_method_options_konbini
{
"type": "object",
"title": "payment_method_options_konbini",
"properties": {
"expires_at": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
},
"expires_after_days": {
"type": "integer",
"nullable": true,
"description": "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST."
},
"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)."
},
"confirmation_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores."
},
"product_description": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_kr_card
{
"type": "object",
"title": "payment_method_options_kr_card",
"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_method_options_mandate_options_pix
{
"type": "object",
"title": "payment_method_options_mandate_options_pix",
"properties": {
"amount": {
"type": "integer",
"description": "Amount to be charged for future payments."
},
"currency": {
"type": "string",
"format": "currency",
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase."
},
"end_date": {
"type": "string",
"maxLength": 5000,
"description": "Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`."
},
"reference": {
"type": "string",
"maxLength": 5000,
"description": "Subscription name displayed to buyers in their bank app."
},
"start_date": {
"type": "string",
"maxLength": 5000,
"description": "Start date of the mandate, in `YYYY-MM-DD`."
},
"amount_type": {
"enum": [
"fixed",
"maximum"
],
"type": "string",
"description": "Type of amount."
},
"payment_schedule": {
"enum": [
"halfyearly",
"monthly",
"quarterly",
"weekly",
"yearly"
],
"type": "string",
"description": "Schedule at which the future payments will be charged."
},
"amount_includes_iof": {
"enum": [
"always",
"never"
],
"type": "string",
"description": "Determines if the amount includes the IOF tax."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_mandate_options_upi
{
"type": "object",
"title": "payment_method_options_mandate_options_upi",
"properties": {
"amount": {
"type": "integer",
"nullable": true,
"description": "Amount to be charged for future payments."
},
"end_date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "End date of the mandate or subscription."
},
"amount_type": {
"enum": [
"fixed",
"maximum"
],
"type": "string",
"nullable": true,
"description": "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 20,
"description": "A description of the mandate or subscription that is meant to be displayed to the customer."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_mb_way
{
"type": "object",
"title": "payment_method_options_mb_way",
"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_method_options_multibanco
{
"type": "object",
"title": "payment_method_options_multibanco",
"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_method_options_oxxo
{
"type": "object",
"title": "payment_method_options_oxxo",
"required": [
"expires_after_days"
],
"properties": {
"expires_after_days": {
"type": "integer",
"description": "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time."
},
"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_method_options_p24
{
"type": "object",
"title": "payment_method_options_p24",
"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_method_options_pay_by_bank
{
"type": "object",
"title": "payment_method_options_pay_by_bank",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_options_paynow
{
"type": "object",
"title": "payment_method_options_paynow",
"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_method_options_paypal
{
"type": "object",
"title": "payment_method_options_paypal",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID."
},
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"preferred_locale": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Preferred locale of the PayPal checkout page that the customer is redirected to."
},
"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_method_options_pix
{
"type": "object",
"title": "payment_method_options_pix",
"properties": {
"expires_at": {
"type": "integer",
"nullable": true,
"description": "The timestamp at which the Pix expires."
},
"mandate_options": {
"$ref": "#/components/schemas/payment_method_options_mandate_options_pix"
},
"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)."
},
"amount_includes_iof": {
"enum": [
"always",
"never"
],
"type": "string",
"description": "Determines if the amount includes the IOF tax."
},
"expires_after_seconds": {
"type": "integer",
"nullable": true,
"description": "The number of seconds (between 10 and 1209600) after which Pix payment will expire."
}
},
"description": "",
"x-expandableFields": [
"mandate_options"
]
}
payment_method_options_promptpay
{
"type": "object",
"title": "payment_method_options_promptpay",
"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_method_options_revolut_pay
{
"type": "object",
"title": "payment_method_options_revolut_pay",
"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).",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_satispay
{
"type": "object",
"title": "payment_method_options_satispay",
"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",
"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_method_options_scalapay
{
"type": "object",
"title": "payment_method_options_scalapay",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_sofort
{
"type": "object",
"title": "payment_method_options_sofort",
"properties": {
"preferred_language": {
"enum": [
"de",
"en",
"es",
"fr",
"it",
"nl",
"pl"
],
"type": "string",
"nullable": true,
"description": "Preferred language of the SOFORT authorization page that the customer is redirected to."
},
"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_method_options_sunbit
{
"type": "object",
"title": "payment_method_options_sunbit",
"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"
],
"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_method_options_twint
{
"type": "object",
"title": "payment_method_options_twint",
"properties": {
"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_method_options_upi
{
"type": "object",
"title": "payment_method_options_upi",
"properties": {
"setup_future_usage": {
"enum": [
"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_method_options_us_bank_account_mandate_options
{
"type": "object",
"title": "payment_method_options_us_bank_account_mandate_options",
"properties": {
"collection_method": {
"enum": [
"paper"
],
"type": "string",
"description": "Mandate collection method",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_wechat_pay
{
"type": "object",
"title": "payment_method_options_wechat_pay",
"properties": {
"app_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The app ID registered with WeChat Pay. Only required when client is ios, android, or mini_program."
},
"client": {
"enum": [
"android",
"ios",
"web"
],
"type": "string",
"nullable": true,
"description": "The client type that the end customer will pay from",
"x-stripeBypassValidation": true
},
"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_method_options_zip
{
"type": "object",
"title": "payment_method_options_zip",
"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_method_oxxo
{
"type": "object",
"title": "payment_method_oxxo",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_p24
{
"type": "object",
"title": "payment_method_p24",
"properties": {
"bank": {
"enum": [
"alior_bank",
"bank_millennium",
"bank_nowy_bfg_sa",
"bank_pekao_sa",
"banki_spbdzielcze",
"blik",
"bnp_paribas",
"boz",
"citi_handlowy",
"credit_agricole",
"envelobank",
"etransfer_pocztowy24",
"getin_bank",
"ideabank",
"ing",
"inteligo",
"mbank_mtransfer",
"nest_przelew",
"noble_pay",
"pbac_z_ipko",
"plus_bank",
"santander_przelew24",
"tmobile_usbugi_bankowe",
"toyota_bank",
"velobank",
"volkswagen_bank"
],
"type": "string",
"nullable": true,
"description": "The customer's bank, if provided.",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payment_method_pay_by_bank
{
"type": "object",
"title": "payment_method_pay_by_bank",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_payco
{
"type": "object",
"title": "payment_method_payco",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_paynow
{
"type": "object",
"title": "payment_method_paynow",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_paypal
{
"type": "object",
"title": "payment_method_paypal",
"properties": {
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."
},
"payer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "PayPal account PayerID. This identifier uniquely identifies the PayPal customer."
},
"payer_email": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_payto
{
"type": "object",
"title": "payment_method_payto",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"pay_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The PayID alias for the bank account."
},
"bsb_number": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank-State-Branch number of the bank account."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_pix
{
"type": "object",
"title": "payment_method_pix",
"properties": {
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular Pix account. You can use this attribute to check whether two Pix accounts are the same."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_promptpay
{
"type": "object",
"title": "payment_method_promptpay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_revolut_pay
{
"type": "object",
"title": "payment_method_revolut_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_samsung_pay
{
"type": "object",
"title": "payment_method_samsung_pay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_satispay
{
"type": "object",
"title": "payment_method_satispay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_scalapay
{
"type": "object",
"title": "payment_method_scalapay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_sepa_debit
{
"type": "object",
"title": "payment_method_sepa_debit",
"properties": {
"last4": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Last four characters of the IBAN."
},
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country the bank account is located in."
},
"bank_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Bank code of bank associated with the bank account."
},
"branch_code": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Branch code of bank associated with the bank account."
},
"fingerprint": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
},
"generated_from": {
"anyOf": [
{
"$ref": "#/components/schemas/sepa_debit_generated_from"
}
],
"nullable": true,
"description": "Information about the object that generated this PaymentMethod."
}
},
"description": "",
"x-expandableFields": [
"generated_from"
]
}
payment_method_sofort
{
"type": "object",
"title": "payment_method_sofort",
"properties": {
"country": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Two-letter ISO code representing the country the bank account is located in."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_sunbit
{
"type": "object",
"title": "payment_method_sunbit",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_swish
{
"type": "object",
"title": "payment_method_swish",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_twint
{
"type": "object",
"title": "payment_method_twint",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_upi
{
"type": "object",
"title": "payment_method_upi",
"properties": {
"vpa": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Customer's unique Virtual Payment Address"
}
},
"description": "",
"x-expandableFields": []
}