payment_method_mobilepay
{
"type": "object",
"title": "payment_method_mobilepay",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_multibanco
{
"type": "object",
"title": "payment_method_multibanco",
"properties": {},
"description": "",
"x-expandableFields": []
}
payment_method_naver_pay
{
"type": "object",
"title": "payment_method_naver_pay",
"required": [
"funding"
],
"properties": {
"funding": {
"enum": [
"card",
"points"
],
"type": "string",
"description": "Whether to fund this transaction with Naver Pay points or a card.",
"x-stripeBypassValidation": true
},
"buyer_id": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_nz_bank_account
{
"type": "object",
"title": "payment_method_nz_bank_account",
"required": [
"bank_code",
"bank_name",
"branch_code",
"last4"
],
"properties": {
"last4": {
"type": "string",
"maxLength": 5000,
"description": "Last four digits of the bank account number."
},
"suffix": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The suffix of the bank account number."
},
"bank_code": {
"type": "string",
"maxLength": 5000,
"description": "The numeric code for the bank account's bank."
},
"bank_name": {
"type": "string",
"maxLength": 5000,
"description": "The name of the bank."
},
"branch_code": {
"type": "string",
"maxLength": 5000,
"description": "The numeric code for the bank account's bank branch."
},
"account_holder_name": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_affirm
{
"type": "object",
"title": "payment_method_options_affirm",
"properties": {
"capture_method": {
"enum": [
"manual"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account."
},
"preferred_locale": {
"type": "string",
"maxLength": 30,
"description": "Preferred language of the Affirm authorization page that the customer is redirected to."
},
"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_afterpay_clearpay
{
"type": "object",
"title": "payment_method_options_afterpay_clearpay",
"properties": {
"reference": {
"type": "string",
"nullable": true,
"maxLength": 5000,
"description": "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name."
},
"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).",
"x-stripeBypassValidation": true
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_alipay
{
"type": "object",
"title": "payment_method_options_alipay",
"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_alma
{
"type": "object",
"title": "payment_method_options_alma",
"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_amazon_pay
{
"type": "object",
"title": "payment_method_options_amazon_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)."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_bancontact
{
"type": "object",
"title": "payment_method_options_bancontact",
"required": [
"preferred_language"
],
"properties": {
"preferred_language": {
"enum": [
"de",
"en",
"fr",
"nl"
],
"type": "string",
"description": "Preferred language of the Bancontact 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_billie
{
"type": "object",
"title": "payment_method_options_billie",
"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_boleto
{
"type": "object",
"title": "payment_method_options_boleto",
"required": [
"expires_after_days"
],
"properties": {
"expires_after_days": {
"type": "integer",
"description": "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time."
},
"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_card_installments
{
"type": "object",
"title": "payment_method_options_card_installments",
"required": [
"enabled"
],
"properties": {
"plan": {
"anyOf": [
{
"$ref": "#/components/schemas/payment_method_details_card_installments_plan"
}
],
"nullable": true,
"description": "Installment plan selected for this PaymentIntent."
},
"enabled": {
"type": "boolean",
"description": "Whether Installments are enabled for this PaymentIntent."
},
"available_plans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/payment_method_details_card_installments_plan"
},
"nullable": true,
"description": "Installment plans that may be selected for this PaymentIntent."
}
},
"description": "",
"x-expandableFields": [
"available_plans",
"plan"
]
}
payment_method_options_card_mandate_options
{
"type": "object",
"title": "payment_method_options_card_mandate_options",
"required": [
"amount",
"amount_type",
"interval",
"reference",
"start_date"
],
"properties": {
"amount": {
"type": "integer",
"description": "Amount to be charged for future payments, specified in the presentment currency."
},
"end_date": {
"type": "integer",
"format": "unix-time",
"nullable": true,
"description": "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."
},
"interval": {
"enum": [
"day",
"month",
"sporadic",
"week",
"year"
],
"type": "string",
"description": "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`."
},
"reference": {
"type": "string",
"maxLength": 80,
"description": "Unique identifier for the mandate or subscription."
},
"start_date": {
"type": "integer",
"format": "unix-time",
"description": "Start date of the mandate or subscription. Start date should not be lesser than yesterday."
},
"amount_type": {
"enum": [
"fixed",
"maximum"
],
"type": "string",
"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": 200,
"description": "A description of the mandate or subscription that is meant to be displayed to the customer."
},
"interval_count": {
"type": "integer",
"nullable": true,
"description": "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`."
},
"supported_types": {
"type": "array",
"items": {
"enum": [
"india"
],
"type": "string"
},
"nullable": true,
"description": "Specifies the type of mandates supported. Possible values are `india`."
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_card_present
{
"type": "object",
"title": "payment_method_options_card_present",
"properties": {
"routing": {
"$ref": "#/components/schemas/payment_method_options_card_present_routing"
},
"capture_method": {
"enum": [
"manual",
"manual_preferred"
],
"type": "string",
"description": "Controls when the funds will be captured from the customer's account.",
"x-stripeBypassValidation": true
},
"request_extended_authorization": {
"type": "boolean",
"nullable": true,
"description": "Request ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity)"
},
"request_incremental_authorization_support": {
"type": "boolean",
"nullable": true,
"description": "Request ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support."
}
},
"description": "",
"x-expandableFields": [
"routing"
]
}
payment_method_options_card_present_routing
{
"type": "object",
"title": "payment_method_options_card_present_routing",
"properties": {
"requested_priority": {
"enum": [
"domestic",
"international"
],
"type": "string",
"nullable": true,
"description": "Requested routing priority"
}
},
"description": "",
"x-expandableFields": []
}
payment_method_options_cashapp
{
"type": "object",
"title": "payment_method_options_cashapp",
"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_crypto
{
"type": "object",
"title": "payment_method_options_crypto",
"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_method_options_customer_balance
{
"type": "object",
"title": "payment_method_options_customer_balance",
"properties": {
"funding_type": {
"enum": [
"bank_transfer"
],
"type": "string",
"nullable": true,
"description": "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."
},
"bank_transfer": {
"$ref": "#/components/schemas/payment_method_options_customer_balance_bank_transfer"
},
"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": [
"bank_transfer"
]
}
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."
}
},
"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_twint
{
"type": "object",
"title": "payment_method_options_twint",
"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_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 or android."
},
"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)."
}
},
"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": []
}