Stripe: Payment intents schemas (part 3)
42 Stripe schemas with complete fields and constraints.
← Payment intents operations · All schemas
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / card_present / capture_method: manual, manual preferred
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
capture_method | string | Optional | Controls when the funds will be captured from the customer's account. Known values: manual, manual_preferred |
request_extended_authorization | JSON | Optional | |
request_extended_authorization (anyOf 1) | boolean | Alternative | Request ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity) |
request_extended_authorization (anyOf 2) | null | Alternative | |
request_incremental_authorization_support | JSON | Optional | |
request_incremental_authorization_support (anyOf 1) | boolean | Alternative | 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. |
request_incremental_authorization_support (anyOf 2) | null | Alternative | |
routing | Model | Optional | Expand Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / card_present / capture_method: manual, manual preferred routing |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / card_present / capture_method: manual, manual preferred routing
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
requested_priority | JSON | Optional | |
requested_priority (anyOf 1) | string | Alternative | Requested routing priority Known values: domestic, international |
requested_priority (anyOf 2) | null | Alternative |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / eps / capture_method: automatic delayed, manual, manual preferred, setup future usage: none, off session, on session, verification method: automatic, instant, microdeposits
Referenced models: Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / eps / capture_method: automatic delayed, manual, manual preferred, setup future usage: none, off session, on session, verification method: automatic, instant, microdeposits installments, Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / payto / setup_future_usage: none, off session mandate options, Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / card_present / capture_method: manual, manual preferred routing
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / eps / capture_method: automatic delayed, manual, manual preferred, setup future usage: none, off session, on session, verification method: automatic, instant, microdeposits installments
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / eps / capture_method: automatic delayed, manual, manual preferred, setup future usage: none, off session, on session, verification method: automatic, instant, microdeposits installments plan
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
count | JSON | Optional | |
count (anyOf 1) | JSON | Alternative | |
count (anyOf 1) (anyOf 1) | integer | Alternative | For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. |
count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
count (anyOf 2) | null | Alternative | |
interval | JSON | Optional | |
interval (anyOf 1) | string | Alternative | For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. One of `month`. Known values: month |
interval (anyOf 2) | null | Alternative | |
type | string | Required within parent | Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`. Known values: bonus, fixed_count, revolving |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / klarna / capture_method: manual, setup future usage: none, off session, on session
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
capture_method | string | Optional | Controls when the funds will be captured from the customer's account. Known values: manual |
preferred_locale | JSON | Optional | |
preferred_locale (anyOf 1) | string | Alternative | Preferred locale of the Klarna checkout page that the customer is redirected to. Maximum length: 5000 |
preferred_locale (anyOf 2) | null | Alternative | |
setup_future_usage | string | Optional | Indicates that you intend to make future payments with this PaymentIntent's payment method. If 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. If 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. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). Known values: none, off_session, on_session |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / konbini / setup_future_usage: none
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
confirmation_number | JSON | Optional | |
confirmation_number (anyOf 1) | string | Alternative | An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Maximum length: 5000 |
confirmation_number (anyOf 2) | null | Alternative | |
expires_after_days | JSON | Optional | |
expires_after_days (anyOf 1) | JSON | Alternative | |
expires_after_days (anyOf 1) (anyOf 1) | integer | Alternative | 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. |
expires_after_days (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_after_days (anyOf 2) | null | Alternative | |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | JSON | Alternative | |
expires_at (anyOf 1) (anyOf 1) | integer | Alternative | The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set. Format: unix-time |
expires_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_at (anyOf 2) | null | Alternative | |
product_description | JSON | Optional | |
product_description (anyOf 1) | string | Alternative | A product descriptor of up to 22 characters, which will appear to customers at the convenience store. Maximum length: 5000 |
product_description (anyOf 2) | null | Alternative | |
setup_future_usage | string | Optional | Indicates that you intend to make future payments with this PaymentIntent's payment method. If 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. If 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. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). Known values: none |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / payto / setup_future_usage: none, off session
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mandate_options | Model | Optional | Expand Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / payto / setup_future_usage: none, off session mandate options |
setup_future_usage | string | Optional | Indicates that you intend to make future payments with this PaymentIntent's payment method. If 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. If 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. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). Known values: none, off_session |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / payto / setup_future_usage: none, off session mandate options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | integer | Alternative | Amount that will be collected. It is required when `amount_type` is `fixed`. |
amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | |
amount_type | JSON | Optional | |
amount_type (anyOf 1) | string | Alternative | The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`. Known values: fixed, maximum |
amount_type (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. Maximum length: 5000 |
end_date (anyOf 2) | null | Alternative | |
payment_schedule | JSON | Optional | |
payment_schedule (anyOf 1) | string | Alternative | The periodicity at which payments will be collected. Defaults to `adhoc`. Known values: adhoc, annual, daily, fortnightly, monthly, quarterly, semi_annual, weekly |
payment_schedule (anyOf 2) | null | Alternative | |
payments_per_period | JSON | Optional | |
payments_per_period (anyOf 1) | JSON | Alternative | |
payments_per_period (anyOf 1) (anyOf 1) | integer | Alternative | The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. |
payments_per_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
payments_per_period (anyOf 2) | null | Alternative | |
purpose | JSON | Optional | |
purpose (anyOf 1) | string | Alternative | The purpose for which payments are made. Has a default value based on your merchant category code. Known values: dependant_support, government, loan, mortgage, other, pension, personal, retail, salary, tax, utility |
purpose (anyOf 2) | null | Alternative |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / pix / amount_includes_iof: always, never, setup future usage: none, off session
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_includes_iof | string | Optional | Determines if the amount includes the IOF tax. Known values: always, never |
expires_after_seconds | JSON | Optional | |
expires_after_seconds (anyOf 1) | JSON | Alternative | |
expires_after_seconds (anyOf 1) (anyOf 1) | integer | Alternative | The number of seconds (between 10 and 1209600) after which Pix payment will expire. |
expires_after_seconds (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_after_seconds (anyOf 2) | null | Alternative | |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | JSON | Alternative | |
expires_at (anyOf 1) (anyOf 1) | integer | Alternative | The timestamp at which the Pix expires. |
expires_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
expires_at (anyOf 2) | null | Alternative | |
mandate_options | Model | Optional | Expand Create a Checkout Session — response body — payment method options value acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, boleto, card, cashapp, customer balance, eps, fpx, giropay, grabpay, ideal, kakao pay, klarna, konbini, kr card, link, mobilepay, multibanco, naver pay, oxxo, p24, payco, paynow, paypal, payto, pix, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, sunbit, swish, twint, upi, us bank account, wechat pay pix mandate options |
setup_future_usage | string | Optional | Indicates that you intend to make future payments with this PaymentIntent's payment method. If 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. If 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. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). Known values: none, off_session |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / sofort / setup_future_usage: none, off session
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
preferred_language | JSON | Optional | |
preferred_language (anyOf 1) | string | Alternative | Preferred language of the SOFORT authorization page that the customer is redirected to. Known values: de, en, es, fr, it, nl, pl |
preferred_language (anyOf 2) | null | Alternative | |
setup_future_usage | string | Optional | Indicates that you intend to make future payments with this PaymentIntent's payment method. If 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. If 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. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). Known values: none, off_session |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / swish / setup_future_usage: none
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | A reference for this payment to be displayed in the Swish app. Maximum length: 35 |
reference (anyOf 2) | null | Alternative | |
setup_future_usage | string | Optional | Indicates that you intend to make future payments with this PaymentIntent's payment method. If 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. If 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. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). Known values: none |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / upi / setup_future_usage: off session, on session
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
setup_future_usage | string | Optional | Indicates that you intend to make future payments with this PaymentIntent's payment method. If 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. If 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. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). Known values: off_session, on_session |
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / us_bank_account / setup_future_usage: none, off session, on session, transaction purpose: goods, other, services, unspecified, verification method: automatic, instant, microdeposits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
financial_connections | Model | Optional | Expand Create a Checkout Session — response body — payment method options value acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, boleto, card, cashapp, customer balance, eps, fpx, giropay, grabpay, ideal, kakao pay, klarna, konbini, kr card, link, mobilepay, multibanco, naver pay, oxxo, p24, payco, paynow, paypal, payto, pix, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, sunbit, swish, twint, upi, us bank account, wechat pay us bank account financial connections |
mandate_options | Model | Optional | Expand Retrieve a Mandate — response body — payment method details us bank account |
setup_future_usage | string | Optional | Indicates that you intend to make future payments with this PaymentIntent's payment method. If 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. If 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. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). Known values: none, off_session, on_session |
target_date | string | Optional | Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. Maximum length: 5000 |
transaction_purpose | string | Optional | The purpose of the transaction. Known values: goods, other, services, unspecified |
verification_method | string | Optional | Bank account verification method. The default value is `automatic`. Known values: automatic, instant, microdeposits |
Referenced models: Create a Checkout Session — response body — payment method options value acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, boleto, card, cashapp, customer balance, eps, fpx, giropay, grabpay, ideal, kakao pay, klarna, konbini, kr card, link, mobilepay, multibanco, naver pay, oxxo, p24, payco, paynow, paypal, payto, pix, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, sunbit, swish, twint, upi, us bank account, wechat pay us bank account financial connections, Retrieve a Mandate — response body — payment method details us bank account
Cancel a PaymentIntent — response body — payment_method_options / value / acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, card_present, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, interac_present, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip / wechat_pay / setup_future_usage: none
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
app_id | JSON | Optional | |
app_id (anyOf 1) | string | Alternative | The app ID registered with WeChat Pay. Only required when client is ios, android, or mini_program. Maximum length: 5000 |
app_id (anyOf 2) | null | Alternative | |
client | JSON | Optional | |
client (anyOf 1) | string | Alternative | The client type that the end customer will pay from Known values: android, ios, web |
client (anyOf 2) | null | Alternative | |
setup_future_usage | string | Optional | Indicates that you intend to make future payments with this PaymentIntent's payment method. If 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. If 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. When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication). Known values: none |
Cancel a PaymentIntent — response body — processing / value / type: card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
card | Model | Optional | Expand Cancel a PaymentIntent — response body — processing / value / type: card card |
type | string | Required within parent | Type of the payment method for which payment is in `processing` state, one of `card`. Known values: card |
Referenced models: Cancel a PaymentIntent — response body — processing / value / type: card card
Cancel a PaymentIntent — response body — processing / value / type: card card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customer_notification | Model | Optional | Expand Cancel a PaymentIntent — response body — processing / value / type: card card customer notification |
Referenced models: Cancel a PaymentIntent — response body — processing / value / type: card card customer notification
Cancel a PaymentIntent — response body — processing / value / type: card card customer notification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_requested | JSON | Optional | |
approval_requested (anyOf 1) | boolean | Alternative | Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank. |
approval_requested (anyOf 2) | null | Alternative | |
completes_at | JSON | Optional | |
completes_at (anyOf 1) | JSON | Alternative | |
completes_at (anyOf 1) (anyOf 1) | integer | Alternative | If customer approval is required, they need to provide approval before this time. Format: unix-time |
completes_at (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
completes_at (anyOf 2) | null | Alternative |
Create a Payment Intent — request body — body amount details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Provides industry-specific information about the amount. |
discount_amount | JSON | Optional | |
discount_amount (anyOf 1) | integer | Alternative | |
discount_amount (anyOf 2) | string | Alternative | One of: |
enforce_arithmetic_validation | boolean | Optional | |
line_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | |
line_items (anyOf 1)[] | Model | Each item | Expand Create a Payment Intent — request body — body amount details line items array item |
line_items (anyOf 2) | string | Alternative | One of: |
shipping | JSON | Optional | |
shipping (anyOf 1) | object | Alternative | |
shipping (anyOf 1).amount | JSON | Optional | |
shipping (anyOf 1).amount (anyOf 1) | integer | Alternative | |
shipping (anyOf 1).amount (anyOf 2) | string | Alternative | One of: |
shipping (anyOf 1).from_postal_code | JSON | Optional | |
shipping (anyOf 1).from_postal_code (anyOf 1) | string | Alternative | Maximum length: 10 |
shipping (anyOf 1).from_postal_code (anyOf 2) | string | Alternative | One of: |
shipping (anyOf 1).to_postal_code | JSON | Optional | |
shipping (anyOf 1).to_postal_code (anyOf 1) | string | Alternative | Maximum length: 10 |
shipping (anyOf 1).to_postal_code (anyOf 2) | string | Alternative | One of: |
shipping (anyOf 2) | string | Alternative | One of: |
tax | JSON | Optional | |
tax (anyOf 1) | object | Alternative | |
tax (anyOf 1).total_tax_amount | integer | Required within parent | |
tax (anyOf 2) | string | Alternative | One of: |
Referenced models: Create a Payment Intent — request body — body amount details line items array item
Create a Payment Intent — request body — body amount details line items array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
discount_amount | integer | Optional | |
payment_method_options | Model | Optional | Expand Create a Payment Intent — request body — body amount details line items array item payment method options |
product_code | string | Optional | Maximum length: 12 |
product_name | string | Required within parent | Maximum length: 1024 |
quantity | integer | Required within parent | |
tax | object | Optional | |
tax.total_tax_amount | integer | Required within parent | |
unit_cost | integer | Required within parent | |
unit_of_measure | string | Optional | Maximum length: 12 |
Referenced models: Create a Payment Intent — request body — body amount details line items array item payment method options
Create a Payment Intent — request body — body amount details line items array item payment method options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
card | object | Optional | |
card.commodity_code | string | Optional | Maximum length: 12 |
card_present | object | Optional | |
card_present.commodity_code | string | Optional | Maximum length: 12 |
klarna | object | Optional | |
klarna.image_url | string | Optional | Maximum length: 4096 |
klarna.product_url | string | Optional | Maximum length: 4096 |
klarna.reference | string | Optional | Maximum length: 255 |
klarna.subscription_reference | string | Optional | Maximum length: 255 |
paypal | object | Optional | |
paypal.category | string | Optional | One of: digital_goods, donation, physical_goods |
paypal.description | string | Optional | Maximum length: 127 |
paypal.sold_by | string | Optional | Maximum length: 127 |
Create a Payment Intent — request body — body payment method data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear in the [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. |
acss_debit | object | Optional | |
acss_debit.account_number | string | Required within parent | Maximum length: 5000 |
acss_debit.institution_number | string | Required within parent | Maximum length: 5000 |
acss_debit.transit_number | string | Required within parent | Maximum length: 5000 |
affirm | object | Optional | |
afterpay_clearpay | object | Optional | |
alipay | object | Optional | |
allow_redisplay | string | Optional | One of: always, limited, unspecified |
alma | object | Optional | |
amazon_pay | object | Optional | |
au_becs_debit | object | Optional | |
au_becs_debit.account_number | string | Required within parent | Maximum length: 5000 |
au_becs_debit.bsb_number | string | Required within parent | Maximum length: 5000 |
bacs_debit | object | Optional | |
bacs_debit.account_number | string | Optional | Maximum length: 5000 |
bacs_debit.sort_code | string | Optional | Maximum length: 5000 |
bancontact | object | Optional | |
billie | object | Optional | |
billing_details | Model | Optional | Expand Create a Setup Intent — request body — body payment method data billing details |
bizum | object | Optional | |
blik | object | Optional | |
boleto | object | Optional | |
boleto.tax_id | string | Required within parent | Maximum length: 5000 |
cashapp | object | Optional | |
crypto | object | Optional | |
customer_balance | object | Optional | |
eps | Model | Optional | Expand Create a Setup Intent — request body — body payment method data eps |
fpx | object | Optional | |
fpx.bank | string | Required within parent | One of: affin_bank, agrobank, alliance_bank, ambank, bank_islam, bank_muamalat, bank_of_china, bank_rakyat, bnp_paribas, bsn, cimb, citibank, deutsche_bank, hong_leong_bank, hsbc, kfh, maybank2e, maybank2u, mbsb_bank, ocbc, pb_enterprise, public_bank, rhb, standard_chartered, uob Maximum length: 5000 |
giropay | object | Optional | |
grabpay | object | Optional | |
ideal | object | Optional | |
ideal.bank | string | Optional | One of: abn_amro, adyen, asn_bank, bunq, buut, finom, handelsbanken, ing, knab, mollie, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot, yoursafe Maximum length: 5000 |
interac_present | object | Optional | |
kakao_pay | object | Optional | |
klarna | object | Optional | |
klarna.dob | object | Optional | |
klarna.dob.day | integer | Required within parent | |
klarna.dob.month | integer | Required within parent | |
klarna.dob.year | integer | Required within parent | |
konbini | object | Optional | |
kr_card | object | Optional | |
link | object | Optional | |
mb_way | object | Optional | |
metadata | object | Optional | Additional keys: see wildcard field |
metadata.* | string | Additional keys | |
mobilepay | object | Optional | |
multibanco | object | Optional | |
naver_pay | object | Optional | |
naver_pay.funding | string | Optional | One of: card, points |
nz_bank_account | object | Optional | |
nz_bank_account.account_holder_name | string | Optional | Maximum length: 5000 |
nz_bank_account.account_number | string | Required within parent | Maximum length: 5000 |
nz_bank_account.bank_code | string | Required within parent | Maximum length: 5000 |
nz_bank_account.branch_code | string | Required within parent | Maximum length: 5000 |
nz_bank_account.reference | string | Optional | Maximum length: 128 |
nz_bank_account.suffix | string | Required within parent | Maximum length: 5000 |
oxxo | object | Optional | |
p24 | object | Optional | |
p24.bank | string | Optional | One of: 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 |
pay_by_bank | object | Optional | |
payco | object | Optional | |
paynow | object | Optional | |
paypal | object | Optional | |
paypay | object | Optional | |
payto | object | Optional | |
payto.account_number | string | Optional | Maximum length: 5000 |
payto.bsb_number | string | Optional | Maximum length: 5000 |
payto.pay_id | string | Optional | Maximum length: 5000 |
pix | object | Optional | |
promptpay | object | Optional | |
radar_options | object | Optional | |
radar_options.session | string | Optional | Maximum length: 5000 |
revolut_pay | object | Optional | |
samsung_pay | object | Optional | |
satispay | object | Optional | |
scalapay | object | Optional | |
sepa_debit | object | Optional | |
sepa_debit.iban | string | Required within parent | Maximum length: 5000 |
sequra | object | Optional | |
sofort | object | Optional | |
sofort.country | string | Required within parent | One of: AT, BE, DE, ES, IT, NL |
sunbit | object | Optional | |
swish | object | Optional | |
twint | object | Optional | |
type | string | Required within parent | One of: acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip |
upi | object | Optional | |
upi.mandate_options | object | Optional | |
upi.mandate_options.amount | integer | Optional | |
upi.mandate_options.amount_type | string | Optional | One of: fixed, maximum |
upi.mandate_options.description | string | Optional | Maximum length: 20 |
upi.mandate_options.end_date | integer | Optional | Format: unix-time |
us_bank_account | object | Optional | |
us_bank_account.account_holder_type | string | Optional | One of: company, individual |
us_bank_account.account_number | string | Optional | Maximum length: 5000 |
us_bank_account.account_type | string | Optional | One of: checking, savings |
us_bank_account.financial_connections_account | string | Optional | Maximum length: 5000 |
us_bank_account.routing_number | string | Optional | Maximum length: 5000 |
wechat_pay | object | Optional | |
zip | object | Optional |
Referenced models: Create a Setup Intent — request body — body payment method data billing details, Create a Setup Intent — request body — body payment method data eps
Create a Payment Intent — request body — body payment method options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment method-specific configuration for this PaymentIntent. |
acss_debit | JSON | Optional | |
acss_debit (anyOf 1) | Model | Alternative | Expand Create a PaymentIntent — request body — body / payment_method_options / acss_debit / setup_future_usage: , none, off session, on session, verification method: automatic, instant, microdeposits |
acss_debit (anyOf 2) | string | Alternative | One of: |
affirm | JSON | Optional | |
affirm (anyOf 1) | object | Alternative | |
affirm (anyOf 1).capture_method | string | Optional | One of: , manual |
affirm (anyOf 1).preferred_locale | string | Optional | Maximum length: 30 |
affirm (anyOf 1).setup_future_usage | string | Optional | One of: none |
affirm (anyOf 2) | string | Alternative | One of: |
afterpay_clearpay | JSON | Optional | |
afterpay_clearpay (anyOf 1) | object | Alternative | |
afterpay_clearpay (anyOf 1).capture_method | string | Optional | One of: , manual |
afterpay_clearpay (anyOf 1).reference | string | Optional | Maximum length: 128 |
afterpay_clearpay (anyOf 1).setup_future_usage | string | Optional | One of: none |
afterpay_clearpay (anyOf 2) | string | Alternative | One of: |
alipay | JSON | Optional | |
alipay (anyOf 1) | object | Alternative | |
alipay (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
alipay (anyOf 2) | string | Alternative | One of: |
alma | JSON | Optional | |
alma (anyOf 1) | object | Alternative | |
alma (anyOf 1).capture_method | string | Optional | One of: , manual |
alma (anyOf 2) | string | Alternative | One of: |
amazon_pay | JSON | Optional | |
amazon_pay (anyOf 1) | object | Alternative | |
amazon_pay (anyOf 1).capture_method | string | Optional | One of: , manual |
amazon_pay (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
amazon_pay (anyOf 2) | string | Alternative | One of: |
au_becs_debit | JSON | Optional | |
au_becs_debit (anyOf 1) | object | Alternative | |
au_becs_debit (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session, on_session |
au_becs_debit (anyOf 1).target_date | string | Optional | Maximum length: 5000 |
au_becs_debit (anyOf 2) | string | Alternative | One of: |
bacs_debit | JSON | Optional | |
bacs_debit (anyOf 1) | object | Alternative | |
bacs_debit (anyOf 1).mandate_options | object | Optional | |
bacs_debit (anyOf 1).mandate_options.reference_prefix | JSON | Optional | |
bacs_debit (anyOf 1).mandate_options.reference_prefix (anyOf 1) | string | Alternative | Maximum length: 12 |
bacs_debit (anyOf 1).mandate_options.reference_prefix (anyOf 2) | string | Alternative | One of: |
bacs_debit (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session, on_session |
bacs_debit (anyOf 1).target_date | string | Optional | Maximum length: 5000 |
bacs_debit (anyOf 2) | string | Alternative | One of: |
bancontact | JSON | Optional | |
bancontact (anyOf 1) | object | Alternative | |
bancontact (anyOf 1).preferred_language | string | Optional | One of: de, en, fr, nl |
bancontact (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
bancontact (anyOf 2) | string | Alternative | One of: |
billie | JSON | Optional | |
billie (anyOf 1) | Model | Alternative | Expand Create a PaymentIntent — request body — body / payment_method_options / billie / capture_method: , manual |
billie (anyOf 2) | string | Alternative | One of: |
bizum | JSON | Optional | |
bizum (anyOf 1) | object | Alternative | |
bizum (anyOf 2) | string | Alternative | One of: |
blik | JSON | Optional | |
blik (anyOf 1) | object | Alternative | |
blik (anyOf 1).code | string | Optional | Maximum length: 5000 |
blik (anyOf 1).mandate_options | object | Optional | |
blik (anyOf 1).mandate_options.expires_at | integer | Optional | Format: unix-time |
blik (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
blik (anyOf 2) | string | Alternative | One of: |
boleto | JSON | Optional | |
boleto (anyOf 1) | object | Alternative | |
boleto (anyOf 1).expires_after_days | integer | Optional | |
boleto (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session, on_session |
boleto (anyOf 2) | string | Alternative | One of: |
card | JSON | Optional | |
card (anyOf 1) | Model | Alternative | Expand Create a PaymentIntent — request body — body / payment_method_options / card / capture_method: , manual, request extended authorization: if available, never, request incremental authorization: if available, never, request multicapture: if available, never, request overcapture: if available, never, request three d secure: any, automatic, challenge, setup future usage: , none, off session, on session |
card (anyOf 2) | string | Alternative | One of: |
card_present | JSON | Optional | |
card_present (anyOf 1) | object | Alternative | |
card_present (anyOf 1).capture_method | string | Optional | One of: manual, manual_preferred |
card_present (anyOf 1).request_extended_authorization | boolean | Optional | |
card_present (anyOf 1).request_incremental_authorization_support | boolean | Optional | |
card_present (anyOf 1).routing | object | Optional | |
card_present (anyOf 1).routing.requested_priority | string | Optional | One of: domestic, international |
card_present (anyOf 2) | string | Alternative | One of: |
cashapp | JSON | Optional | |
cashapp (anyOf 1) | object | Alternative | |
cashapp (anyOf 1).capture_method | string | Optional | One of: , manual |
cashapp (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session, on_session |
cashapp (anyOf 2) | string | Alternative | One of: |
crypto | JSON | Optional | |
crypto (anyOf 1) | object | Alternative | |
crypto (anyOf 1).setup_future_usage | string | Optional | One of: none |
crypto (anyOf 2) | string | Alternative | One of: |
customer_balance | JSON | Optional | |
customer_balance (anyOf 1) | Model | Alternative | Expand Create a Checkout Session — request body — body payment method options customer balance |
customer_balance (anyOf 2) | string | Alternative | One of: |
eps | JSON | Optional | |
eps (anyOf 1) | object | Alternative | |
eps (anyOf 1).setup_future_usage | string | Optional | One of: none |
eps (anyOf 2) | string | Alternative | One of: |
fpx | JSON | Optional | |
fpx (anyOf 1) | object | Alternative | |
fpx (anyOf 1).setup_future_usage | string | Optional | One of: none |
fpx (anyOf 2) | string | Alternative | One of: |
giropay | JSON | Optional | |
giropay (anyOf 1) | object | Alternative | |
giropay (anyOf 1).setup_future_usage | string | Optional | One of: none |
giropay (anyOf 2) | string | Alternative | One of: |
grabpay | JSON | Optional | |
grabpay (anyOf 1) | object | Alternative | |
grabpay (anyOf 1).setup_future_usage | string | Optional | One of: none |
grabpay (anyOf 2) | string | Alternative | One of: |
ideal | JSON | Optional | |
ideal (anyOf 1) | object | Alternative | |
ideal (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
ideal (anyOf 2) | string | Alternative | One of: |
interac_present | JSON | Optional | |
interac_present (anyOf 1) | object | Alternative | |
interac_present (anyOf 2) | string | Alternative | One of: |
kakao_pay | JSON | Optional | |
kakao_pay (anyOf 1) | object | Alternative | |
kakao_pay (anyOf 1).capture_method | string | Optional | One of: , manual |
kakao_pay (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
kakao_pay (anyOf 2) | string | Alternative | One of: |
klarna | JSON | Optional | |
klarna (anyOf 1) | Model | Alternative | Expand Create a PaymentIntent — request body — body / payment_method_options / klarna / capture_method: , manual, setup future usage: none, off session, on session |
klarna (anyOf 2) | string | Alternative | One of: |
konbini | JSON | Optional | |
konbini (anyOf 1) | object | Alternative | |
konbini (anyOf 1).confirmation_number | JSON | Optional | |
konbini (anyOf 1).confirmation_number (anyOf 1) | string | Alternative | Maximum length: 11 |
konbini (anyOf 1).confirmation_number (anyOf 2) | string | Alternative | One of: |
konbini (anyOf 1).expires_after_days | JSON | Optional | |
konbini (anyOf 1).expires_after_days (anyOf 1) | integer | Alternative | |
konbini (anyOf 1).expires_after_days (anyOf 2) | string | Alternative | One of: |
konbini (anyOf 1).expires_at | JSON | Optional | |
konbini (anyOf 1).expires_at (anyOf 1) | integer | Alternative | Format: unix-time |
konbini (anyOf 1).expires_at (anyOf 2) | string | Alternative | One of: |
konbini (anyOf 1).product_description | JSON | Optional | |
konbini (anyOf 1).product_description (anyOf 1) | string | Alternative | Maximum length: 22 |
konbini (anyOf 1).product_description (anyOf 2) | string | Alternative | One of: |
konbini (anyOf 1).setup_future_usage | string | Optional | One of: none |
konbini (anyOf 2) | string | Alternative | One of: |
kr_card | JSON | Optional | |
kr_card (anyOf 1) | object | Alternative | |
kr_card (anyOf 1).capture_method | string | Optional | One of: , manual |
kr_card (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
kr_card (anyOf 2) | string | Alternative | One of: |
link | JSON | Optional | |
link (anyOf 1) | object | Alternative | |
link (anyOf 1).capture_method | string | Optional | One of: , manual |
link (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
link (anyOf 2) | string | Alternative | One of: |
mb_way | JSON | Optional | |
mb_way (anyOf 1) | object | Alternative | |
mb_way (anyOf 1).setup_future_usage | string | Optional | One of: none |
mb_way (anyOf 2) | string | Alternative | One of: |
mobilepay | JSON | Optional | |
mobilepay (anyOf 1) | object | Alternative | |
mobilepay (anyOf 1).capture_method | string | Optional | One of: , manual |
mobilepay (anyOf 1).setup_future_usage | string | Optional | One of: none |
mobilepay (anyOf 2) | string | Alternative | One of: |
multibanco | JSON | Optional | |
multibanco (anyOf 1) | object | Alternative | |
multibanco (anyOf 1).setup_future_usage | string | Optional | One of: none |
multibanco (anyOf 2) | string | Alternative | One of: |
naver_pay | JSON | Optional | |
naver_pay (anyOf 1) | object | Alternative | |
naver_pay (anyOf 1).capture_method | string | Optional | One of: , manual |
naver_pay (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
naver_pay (anyOf 2) | string | Alternative | One of: |
nz_bank_account | JSON | Optional | |
nz_bank_account (anyOf 1) | object | Alternative | |
nz_bank_account (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session, on_session |
nz_bank_account (anyOf 1).target_date | string | Optional | Maximum length: 5000 |
nz_bank_account (anyOf 2) | string | Alternative | One of: |
oxxo | JSON | Optional | |
oxxo (anyOf 1) | object | Alternative | |
oxxo (anyOf 1).expires_after_days | integer | Optional | |
oxxo (anyOf 1).setup_future_usage | string | Optional | One of: none |
oxxo (anyOf 2) | string | Alternative | One of: |
p24 | JSON | Optional | |
p24 (anyOf 1) | object | Alternative | |
p24 (anyOf 1).setup_future_usage | string | Optional | One of: none |
p24 (anyOf 1).tos_shown_and_accepted | boolean | Optional | |
p24 (anyOf 2) | string | Alternative | One of: |
pay_by_bank | JSON | Optional | |
pay_by_bank (anyOf 1) | object | Alternative | |
pay_by_bank (anyOf 2) | string | Alternative | One of: |
payco | JSON | Optional | |
payco (anyOf 1) | object | Alternative | |
payco (anyOf 1).capture_method | string | Optional | One of: , manual |
payco (anyOf 1).setup_future_usage | string | Optional | One of: none |
payco (anyOf 2) | string | Alternative | One of: |
paynow | JSON | Optional | |
paynow (anyOf 1) | object | Alternative | |
paynow (anyOf 1).setup_future_usage | string | Optional | One of: none |
paynow (anyOf 2) | string | Alternative | One of: |
paypal | JSON | Optional | |
paypal (anyOf 1) | Model | Alternative | Expand Create a Checkout Session — request body — body payment method options paypal |
paypal (anyOf 2) | string | Alternative | One of: |
paypay | JSON | Optional | |
paypay (anyOf 1) | object | Alternative | |
paypay (anyOf 2) | string | Alternative | One of: |
payto | JSON | Optional | |
payto (anyOf 1) | Model | Alternative | Expand Create a PaymentIntent — request body — body / payment_method_options / payto / setup_future_usage: , none, off session |
payto (anyOf 2) | string | Alternative | One of: |
pix | JSON | Optional | |
pix (anyOf 1) | Model | Alternative | Expand Create a PaymentIntent — request body — body / payment_method_options / pix / amount_includes_iof: always, never, setup future usage: none, off session |
pix (anyOf 2) | string | Alternative | One of: |
promptpay | JSON | Optional | |
promptpay (anyOf 1) | object | Alternative | |
promptpay (anyOf 1).setup_future_usage | string | Optional | One of: none |
promptpay (anyOf 2) | string | Alternative | One of: |
revolut_pay | JSON | Optional | |
revolut_pay (anyOf 1) | object | Alternative | |
revolut_pay (anyOf 1).capture_method | string | Optional | One of: , manual |
revolut_pay (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
revolut_pay (anyOf 2) | string | Alternative | One of: |
samsung_pay | JSON | Optional | |
samsung_pay (anyOf 1) | object | Alternative | |
samsung_pay (anyOf 1).capture_method | string | Optional | One of: , manual |
samsung_pay (anyOf 1).setup_future_usage | string | Optional | One of: none |
samsung_pay (anyOf 2) | string | Alternative | One of: |
satispay | JSON | Optional | |
satispay (anyOf 1) | object | Alternative | |
satispay (anyOf 1).capture_method | string | Optional | One of: , manual |
satispay (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session, on_session |
satispay (anyOf 2) | string | Alternative | One of: |
scalapay | JSON | Optional | |
scalapay (anyOf 1) | object | Alternative | |
scalapay (anyOf 1).capture_method | string | Optional | One of: , manual |
scalapay (anyOf 2) | string | Alternative | One of: |
sepa_debit | JSON | Optional | |
sepa_debit (anyOf 1) | object | Alternative | |
sepa_debit (anyOf 1).mandate_options | object | Optional | |
sepa_debit (anyOf 1).mandate_options.reference_prefix | JSON | Optional | |
sepa_debit (anyOf 1).mandate_options.reference_prefix (anyOf 1) | string | Alternative | Maximum length: 12 |
sepa_debit (anyOf 1).mandate_options.reference_prefix (anyOf 2) | string | Alternative | One of: |
sepa_debit (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session, on_session |
sepa_debit (anyOf 1).target_date | string | Optional | Maximum length: 5000 |
sepa_debit (anyOf 2) | string | Alternative | One of: |
sequra | JSON | Optional | |
sequra (anyOf 1) | object | Alternative | |
sequra (anyOf 1).capture_method | string | Optional | One of: , manual |
sequra (anyOf 1).setup_future_usage | string | Optional | One of: none |
sequra (anyOf 2) | string | Alternative | One of: |
sofort | JSON | Optional | |
sofort (anyOf 1) | object | Alternative | |
sofort (anyOf 1).preferred_language | string | Optional | One of: , de, en, es, fr, it, nl, pl |
sofort (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session |
sofort (anyOf 2) | string | Alternative | One of: |
sunbit | JSON | Optional | |
sunbit (anyOf 1) | object | Alternative | |
sunbit (anyOf 1).capture_method | string | Optional | One of: , manual |
sunbit (anyOf 1).setup_future_usage | string | Optional | One of: none |
sunbit (anyOf 2) | string | Alternative | One of: |
swish | JSON | Optional | |
swish (anyOf 1) | object | Alternative | |
swish (anyOf 1).reference | JSON | Optional | |
swish (anyOf 1).reference (anyOf 1) | string | Alternative | Maximum length: 5000 |
swish (anyOf 1).reference (anyOf 2) | string | Alternative | One of: |
swish (anyOf 1).setup_future_usage | string | Optional | One of: none |
swish (anyOf 2) | string | Alternative | One of: |
twint | JSON | Optional | |
twint (anyOf 1) | object | Alternative | |
twint (anyOf 1).setup_future_usage | string | Optional | One of: none, off_session |
twint (anyOf 2) | string | Alternative | One of: |
upi | JSON | Optional | |
upi (anyOf 1) | object | Alternative | |
upi (anyOf 1).mandate_options | object | Optional | |
upi (anyOf 1).mandate_options.amount | integer | Optional | |
upi (anyOf 1).mandate_options.amount_type | string | Optional | One of: fixed, maximum |
upi (anyOf 1).mandate_options.description | string | Optional | Maximum length: 20 |
upi (anyOf 1).mandate_options.end_date | integer | Optional | Format: unix-time |
upi (anyOf 1).setup_future_usage | string | Optional | One of: , none, off_session, on_session |
upi (anyOf 2) | string | Alternative | One of: |
us_bank_account | JSON | Optional | |
us_bank_account (anyOf 1) | Model | Alternative | Expand Create a PaymentIntent — request body — body / payment_method_options / us_bank_account / setup_future_usage: , none, off session, on session, transaction purpose: , goods, other, services, unspecified, verification method: automatic, instant, microdeposits |
us_bank_account (anyOf 2) | string | Alternative | One of: |
wechat_pay | JSON | Optional | |
wechat_pay (anyOf 1) | object | Alternative | |
wechat_pay (anyOf 1).app_id | string | Optional | Maximum length: 5000 |
wechat_pay (anyOf 1).client | string | Optional | One of: android, ios, web |
wechat_pay (anyOf 1).setup_future_usage | string | Optional | One of: none |
wechat_pay (anyOf 2) | string | Alternative | One of: |
zip | JSON | Optional | |
zip (anyOf 1) | object | Alternative | |
zip (anyOf 1).setup_future_usage | string | Optional | One of: none |
zip (anyOf 2) | string | Alternative | One of: |
Referenced models: Create a PaymentIntent — request body — body / payment_method_options / acss_debit / setup_future_usage: , none, off session, on session, verification method: automatic, instant, microdeposits, Create a PaymentIntent — request body — body / payment_method_options / billie / capture_method: , manual, Create a PaymentIntent — request body — body / payment_method_options / card / capture_method: , manual, request extended authorization: if available, never, request incremental authorization: if available, never, request multicapture: if available, never, request overcapture: if available, never, request three d secure: any, automatic, challenge, setup future usage: , none, off session, on session, Create a Checkout Session — request body — body payment method options customer balance, Create a PaymentIntent — request body — body / payment_method_options / klarna / capture_method: , manual, setup future usage: none, off session, on session, Create a Checkout Session — request body — body payment method options paypal, Create a PaymentIntent — request body — body / payment_method_options / payto / setup_future_usage: , none, off session, Create a PaymentIntent — request body — body / payment_method_options / pix / amount_includes_iof: always, never, setup future usage: none, off session, Create a PaymentIntent — request body — body / payment_method_options / us_bank_account / setup_future_usage: , none, off session, on session, transaction purpose: , goods, other, services, unspecified, verification method: automatic, instant, microdeposits
Create a PaymentIntent — request body — body / payment_method_options / acss_debit / setup_future_usage: , none, off session, on session, verification method: automatic, instant, microdeposits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mandate_options | object | Optional | |
mandate_options.custom_mandate_url | JSON | Optional | |
mandate_options.custom_mandate_url (anyOf 1) | string | Alternative | |
mandate_options.custom_mandate_url (anyOf 2) | string | Alternative | One of: |
mandate_options.interval_description | string | Optional | Maximum length: 500 |
mandate_options.payment_schedule | string | Optional | One of: combined, interval, sporadic |
mandate_options.transaction_type | string | Optional | One of: business, personal |
setup_future_usage | string | Optional | One of: , none, off_session, on_session |
target_date | string | Optional | Maximum length: 5000 |
verification_method | string | Optional | One of: automatic, instant, microdeposits |
Create a PaymentIntent — request body — body / payment_method_options / billie / capture_method: , manual
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
capture_method | string | Optional | One of: , manual |
company_details | JSON | Optional | |
company_details (anyOf 1) | Model | Alternative | Expand Create a PaymentIntent — request body — body / payment_method_options / billie / capture_method: , manual company details registered address, registered name, registration number, registration type, vat |
company_details (anyOf 2) | string | Alternative | One of: |
reference | string | Optional | Maximum length: 5000 |
Create a PaymentIntent — request body — body / payment_method_options / billie / capture_method: , manual company details registered address, registered name, registration number, registration type, vat
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
registered_address | JSON | Optional | |
registered_address (anyOf 1) | object | Alternative | |
registered_address (anyOf 1).city | string | Optional | Maximum length: 5000 |
registered_address (anyOf 1).country | string | Optional | Maximum length: 5000 |
registered_address (anyOf 1).line1 | string | Optional | Maximum length: 5000 |
registered_address (anyOf 1).line2 | string | Optional | Maximum length: 5000 |
registered_address (anyOf 1).postal_code | string | Optional | Maximum length: 5000 |
registered_address (anyOf 1).state | string | Optional | Maximum length: 5000 |
registered_address (anyOf 2) | string | Alternative | One of: |
registered_name | string | Optional | Maximum length: 5000 |
registration_number | string | Optional | Maximum length: 5000 |
registration_type | string | Optional | One of: , ch_ein, de_hrb, dk_cvr, es_cif, fi_tunnus, fr_siren, fr_siret, it_rea, nl_kvk, no_org_number, no_pno, se_org_number, se_pno, uk_crn |
vat | string | Optional | Maximum length: 5000 |
Create a PaymentIntent — request body — body / payment_method_options / card / capture_method: , manual, request extended authorization: if available, never, request incremental authorization: if available, never, request multicapture: if available, never, request overcapture: if available, never, request three d secure: any, automatic, challenge, setup future usage: , none, off session, on session
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
capture_method | string | Optional | One of: , manual |
cvc_token | string | Optional | Maximum length: 5000 |
installments | object | Optional | |
installments.enabled | boolean | Optional | |
installments.plan | JSON | Optional | |
installments.plan (anyOf 1) | object | Alternative | |
installments.plan (anyOf 1).count | integer | Optional | |
installments.plan (anyOf 1).interval | string | Optional | One of: month |
installments.plan (anyOf 1).type | string | Required within parent | One of: bonus, fixed_count, revolving |
installments.plan (anyOf 2) | string | Alternative | One of: |
mandate_options | Model | Optional | Expand Create a PaymentIntent — request body — body / payment_method_options / card / capture_method: , manual, request extended authorization: if available, never, request incremental authorization: if available, never, request multicapture: if available, never, request overcapture: if available, never, request three d secure: any, automatic, challenge, setup future usage: , none, off session, on session mandate options |
network | string | Optional | One of: amex, cartes_bancaires, diners, discover, eftpos_au, girocard, interac, jcb, link, mastercard, unionpay, unknown, visa Maximum length: 5000 |
request_extended_authorization | string | Optional | One of: if_available, never |
request_incremental_authorization | string | Optional | One of: if_available, never |
request_multicapture | string | Optional | One of: if_available, never |
request_overcapture | string | Optional | One of: if_available, never |
request_three_d_secure | string | Optional | One of: any, automatic, challenge |
require_cvc_recollection | boolean | Optional | |
setup_future_usage | string | Optional | One of: , none, off_session, on_session |
statement_descriptor_suffix_kana | JSON | Optional | |
statement_descriptor_suffix_kana (anyOf 1) | string | Alternative | Maximum length: 22 |
statement_descriptor_suffix_kana (anyOf 2) | string | Alternative | One of: |
statement_descriptor_suffix_kanji | JSON | Optional | |
statement_descriptor_suffix_kanji (anyOf 1) | string | Alternative | Maximum length: 17 |
statement_descriptor_suffix_kanji (anyOf 2) | string | Alternative | One of: |
three_d_secure | Model | Optional | Expand Create a PaymentIntent — request body — body / payment_method_options / card / capture_method: , manual, request extended authorization: if available, never, request incremental authorization: if available, never, request multicapture: if available, never, request overcapture: if available, never, request three d secure: any, automatic, challenge, setup future usage: , none, off session, on session three d secure |
Referenced models: Create a PaymentIntent — request body — body / payment_method_options / card / capture_method: , manual, request extended authorization: if available, never, request incremental authorization: if available, never, request multicapture: if available, never, request overcapture: if available, never, request three d secure: any, automatic, challenge, setup future usage: , none, off session, on session mandate options, Create a PaymentIntent — request body — body / payment_method_options / card / capture_method: , manual, request extended authorization: if available, never, request incremental authorization: if available, never, request multicapture: if available, never, request overcapture: if available, never, request three d secure: any, automatic, challenge, setup future usage: , none, off session, on session three d secure
Create a PaymentIntent — request body — body / payment_method_options / card / capture_method: , manual, request extended authorization: if available, never, request incremental authorization: if available, never, request multicapture: if available, never, request overcapture: if available, never, request three d secure: any, automatic, challenge, setup future usage: , none, off session, on session mandate options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | integer | Required within parent | |
amount_type | string | Required within parent | One of: fixed, maximum |
description | string | Optional | Maximum length: 200 |
end_date | integer | Optional | Format: unix-time |
interval | string | Required within parent | One of: day, month, sporadic, week, year |
interval_count | integer | Optional | |
reference | string | Required within parent | Maximum length: 80 |
start_date | integer | Required within parent | Format: unix-time |
supported_types | array | Optional | |
supported_types[] | string | Each item | One of: india |
Create a PaymentIntent — request body — body / payment_method_options / card / capture_method: , manual, request extended authorization: if available, never, request incremental authorization: if available, never, request multicapture: if available, never, request overcapture: if available, never, request three d secure: any, automatic, challenge, setup future usage: , none, off session, on session three d secure
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ares_trans_status | string | Optional | One of: A, C, I, N, R, U, Y |
cryptogram | string | Required within parent | Maximum length: 5000 |
electronic_commerce_indicator | string | Optional | One of: 01, 02, 05, 06, 07 |
exemption_indicator | string | Optional | One of: low_risk, none |
network_options | object | Optional | |
network_options.cartes_bancaires | object | Optional | |
network_options.cartes_bancaires.cb_avalgo | string | Required within parent | One of: 0, 1, 2, 3, 4, A |
network_options.cartes_bancaires.cb_exemption | string | Optional | Maximum length: 4 |
network_options.cartes_bancaires.cb_score | integer | Optional | |
requestor_challenge_indicator | string | Optional | Maximum length: 2 |
transaction_id | string | Required within parent | Maximum length: 5000 |
version | string | Required within parent | One of: 1.0.2, 2.1.0, 2.2.0, 2.3.0, 2.3.1 |
Create a PaymentIntent — request body — body / payment_method_options / klarna / capture_method: , manual, setup future usage: none, off session, on session
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
capture_method | string | Optional | One of: , manual |
on_demand | object | Optional | |
on_demand.average_amount | integer | Optional | |
on_demand.maximum_amount | integer | Optional | |
on_demand.minimum_amount | integer | Optional | |
on_demand.purchase_interval | string | Optional | One of: day, month, week, year |
on_demand.purchase_interval_count | integer | Optional | |
preferred_locale | string | Optional | One of: cs-CZ, da-DK, de-AT, de-CH, de-DE, el-GR, en-AT, en-AU, en-BE, en-CA, en-CH, en-CZ, en-DE, en-DK, en-ES, en-FI, en-FR, en-GB, en-GR, en-IE, en-IT, en-NL, en-NO, en-NZ, en-PL, en-PT, en-RO, en-SE, en-US, es-ES, es-US, fi-FI, fr-BE, fr-CA, fr-CH, fr-FR, it-CH, it-IT, nb-NO, nl-BE, nl-NL, pl-PL, pt-PT, ro-RO, sv-FI, sv-SE |
setup_future_usage | string | Optional | One of: none, off_session, on_session |
subscriptions | JSON | Optional | |
subscriptions (anyOf 1) | array | Alternative | |
subscriptions (anyOf 1)[] | object | Each item | |
subscriptions (anyOf 1)[].interval | string | Required within parent | One of: day, month, week, year |
subscriptions (anyOf 1)[].interval_count | integer | Optional | |
subscriptions (anyOf 1)[].name | string | Optional | Maximum length: 255 |
subscriptions (anyOf 1)[].next_billing | object | Optional | |
subscriptions (anyOf 1)[].next_billing.amount | integer | Required within parent | |
subscriptions (anyOf 1)[].next_billing.date | string | Required within parent | Maximum length: 5000 |
subscriptions (anyOf 1)[].reference | string | Required within parent | Maximum length: 255 |
subscriptions (anyOf 2) | string | Alternative | One of: |
Create a PaymentIntent — request body — body / payment_method_options / payto / setup_future_usage: , none, off session
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mandate_options | Model | Optional | Expand Create a PaymentIntent — request body — body / payment_method_options / payto / setup_future_usage: , none, off session mandate options |
setup_future_usage | string | Optional | One of: , none, off_session |
Referenced models: Create a PaymentIntent — request body — body / payment_method_options / payto / setup_future_usage: , none, off session mandate options
Create a PaymentIntent — request body — body / payment_method_options / payto / setup_future_usage: , none, off session mandate options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | integer | Alternative | |
amount (anyOf 2) | string | Alternative | One of: |
amount_type | string | Optional | One of: , fixed, maximum |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | Maximum length: 5000 |
end_date (anyOf 2) | string | Alternative | One of: |
payment_schedule | string | Optional | One of: , adhoc, annual, daily, fortnightly, monthly, quarterly, semi_annual, weekly |
payments_per_period | JSON | Optional | |
payments_per_period (anyOf 1) | integer | Alternative | |
payments_per_period (anyOf 2) | string | Alternative | One of: |
purpose | string | Optional | One of: , dependant_support, government, loan, mortgage, other, pension, personal, retail, salary, tax, utility |
Create a PaymentIntent — request body — body / payment_method_options / pix / amount_includes_iof: always, never, setup future usage: none, off session
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount_includes_iof | string | Optional | One of: always, never |
expires_after_seconds | integer | Optional | |
expires_at | integer | Optional | Format: unix-time |
mandate_options | Model | Optional | Expand Create a Setup Intent — request body — body payment method options pix mandate options |
setup_future_usage | string | Optional | One of: none, off_session |
Referenced models: Create a Setup Intent — request body — body payment method options pix mandate options
Create a PaymentIntent — request body — body / payment_method_options / us_bank_account / setup_future_usage: , none, off session, on session, transaction purpose: , goods, other, services, unspecified, verification method: automatic, instant, microdeposits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
financial_connections | Model | Optional | Expand Create a Setup Intent — request body — body payment method options us bank account financial connections |
mandate_options | object | Optional | |
mandate_options.collection_method | string | Optional | One of: , paper |
networks | object | Optional | |
networks.requested | array | Optional | |
networks.requested[] | string | Each item | One of: ach, us_domestic_wire |
setup_future_usage | string | Optional | One of: , none, off_session, on_session |
target_date | string | Optional | Maximum length: 5000 |
transaction_purpose | string | Optional | One of: , goods, other, services, unspecified |
verification_method | string | Optional | One of: automatic, instant, microdeposits |
Referenced models: Create a Setup Intent — request body — body payment method options us bank account financial connections
List all Payment Intent Line Items — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
discount_amount | JSON | Optional | |
discount_amount (anyOf 1) | JSON | Alternative | |
discount_amount (anyOf 1) (anyOf 1) | integer | Alternative | The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. This field is mutually exclusive with the `amount_details[discount_amount]` field. |
discount_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
discount_amount (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: payment_intent_amount_details_line_item |
payment_method_options | JSON | Optional | |
payment_method_options (anyOf 1) | JSON | Alternative | Payment method-specific information for line items. |
payment_method_options (anyOf 1) (anyOf 1) | Model | Alternative | Expand List all Payment Intent Line Items — response body — data item payment method options Payment method-specific information for line items card, card present, klarna, paypal |
payment_method_options (anyOf 2) | null | Alternative | |
product_code | JSON | Optional | |
product_code (anyOf 1) | string | Alternative | The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. Maximum length: 5000 |
product_code (anyOf 2) | null | Alternative | |
product_name | string | Required within parent | The product name of the line item. Required for L3 rates. At most 1024 characters long. For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. Maximum length: 5000 |
quantity | JSON | Required within parent | |
quantity (anyOf 1) | integer | Alternative | The quantity of items. Required for L3 rates. An integer greater than 0. |
quantity (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tax | JSON | Optional | |
tax (anyOf 1) | JSON | Alternative | Contains information about the tax on the item. |
tax (anyOf 1) (anyOf 1) | Model | Alternative | Expand List all Payment Intent Line Items — response body — data item tax Contains information about the tax on the item total tax amount |
tax (anyOf 2) | null | Alternative | |
unit_cost | JSON | Required within parent | |
unit_cost (anyOf 1) | integer | Alternative | The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. |
unit_cost (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
unit_of_measure | JSON | Optional | |
unit_of_measure (anyOf 1) | string | Alternative | A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long. Maximum length: 5000 |
unit_of_measure (anyOf 2) | null | Alternative |
Referenced models: List all Payment Intent Line Items — response body — data item payment method options Payment method-specific information for line items card, card present, klarna, paypal, List all Payment Intent Line Items — response body — data item tax Contains information about the tax on the item total tax amount
List all Payment Intent Line Items — response body — data item payment method options Payment method-specific information for line items card, card present, klarna, paypal
Referenced models: List all Payment Intent Line Items — response body — data item payment method options Payment method-specific information for line items card, card present, klarna, paypal card, List all Payment Intent Line Items — response body — data item payment method options Payment method-specific information for line items card, card present, klarna, paypal klarna, List all Payment Intent Line Items — response body — data item payment method options Payment method-specific information for line items card, card present, klarna, paypal paypal
List all Payment Intent Line Items — response body — data item payment method options Payment method-specific information for line items card, card present, klarna, paypal card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
commodity_code | JSON | Optional | |
commodity_code (anyOf 1) | string | Alternative | Maximum length: 5000 |
commodity_code (anyOf 2) | null | Alternative |
List all Payment Intent Line Items — response body — data item payment method options Payment method-specific information for line items card, card present, klarna, paypal klarna
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
image_url | JSON | Optional | |
image_url (anyOf 1) | string | Alternative | Maximum length: 2048 |
image_url (anyOf 2) | null | Alternative | |
product_url | JSON | Optional | |
product_url (anyOf 1) | string | Alternative | Maximum length: 2048 |
product_url (anyOf 2) | null | Alternative | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | Maximum length: 255 |
reference (anyOf 2) | null | Alternative | |
subscription_reference | JSON | Optional | |
subscription_reference (anyOf 1) | string | Alternative | Maximum length: 2048 |
subscription_reference (anyOf 2) | null | Alternative |
List all Payment Intent Line Items — response body — data item payment method options Payment method-specific information for line items card, card present, klarna, paypal paypal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
category | string | Optional | Type of the line item. Known values: digital_goods, donation, physical_goods |
description | string | Optional | Description of the line item. Maximum length: 5000 |
sold_by | string | Optional | The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers). Maximum length: 5000 |
List all Payment Intent Line Items — response body — data item tax Contains information about the tax on the item total tax amount
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
total_tax_amount | JSON | Required within parent | |
total_tax_amount (anyOf 1) | integer | Alternative | The total amount of tax on a single line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. This field is mutually exclusive with the `amount_details[tax][total_tax_amount]` field. |
total_tax_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a Payment Intent — request body — body amount details discount amount, enforce arithmetic validation, line items, shipping, tax
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
discount_amount | JSON | Optional | |
discount_amount (anyOf 1) | integer | Alternative | |
discount_amount (anyOf 2) | string | Alternative | One of: |
enforce_arithmetic_validation | boolean | Optional | |
line_items | JSON | Optional | |
line_items (anyOf 1) | array | Alternative | |
line_items (anyOf 1)[] | Model | Each item | Expand Create a Payment Intent — request body — body amount details line items array item |
line_items (anyOf 2) | string | Alternative | One of: |
shipping | JSON | Optional | |
shipping (anyOf 1) | object | Alternative | |
shipping (anyOf 1).amount | JSON | Optional | |
shipping (anyOf 1).amount (anyOf 1) | integer | Alternative | |
shipping (anyOf 1).amount (anyOf 2) | string | Alternative | One of: |
shipping (anyOf 1).from_postal_code | JSON | Optional | |
shipping (anyOf 1).from_postal_code (anyOf 1) | string | Alternative | Maximum length: 10 |
shipping (anyOf 1).from_postal_code (anyOf 2) | string | Alternative | One of: |
shipping (anyOf 1).to_postal_code | JSON | Optional | |
shipping (anyOf 1).to_postal_code (anyOf 1) | string | Alternative | Maximum length: 10 |
shipping (anyOf 1).to_postal_code (anyOf 2) | string | Alternative | One of: |
shipping (anyOf 2) | string | Alternative | One of: |
tax | JSON | Optional | |
tax (anyOf 1) | object | Alternative | |
tax (anyOf 1).total_tax_amount | integer | Required within parent | |
tax (anyOf 2) | string | Alternative | One of: |
Referenced models: Create a Payment Intent — request body — body amount details line items array item
Update a Payment Intent — request body — body shipping address, carrier, name, phone, tracking number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | object | Required within parent | |
address.city | string | Optional | Maximum length: 5000 |
address.country | string | Optional | Maximum length: 5000 |
address.line1 | string | Optional | Maximum length: 5000 |
address.line2 | string | Optional | Maximum length: 5000 |
address.postal_code | string | Optional | Maximum length: 5000 |
address.state | string | Optional | Maximum length: 5000 |
carrier | string | Optional | Maximum length: 5000 |
name | string | Required within parent | Maximum length: 5000 |
phone | string | Optional | Maximum length: 5000 |
tracking_number | string | Optional | Maximum length: 5000 |