Stripe: Setup intents schemas
44 Stripe schemas with complete fields and constraints.
← Setup intents operations · All schemas
Cancel a Setup Intent — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use [PaymentIntents](https://docs.stripe.com/api#payment_intents) to drive the payment flow. Create a SetupIntent when you're ready to collect your customer's payment credentials. Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides you through the setup process. Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a [Customer](https://docs.stripe.com/api#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or [setup_future_usage](https://docs.stripe.com/api#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) |
allowed_payment_method_types | JSON | Optional | |
allowed_payment_method_types (anyOf 1) | array | Alternative | The list of payment method types to allow for this SetupIntent. Stripe will only use methods in this list when determining the payment methods to offer. |
allowed_payment_method_types (anyOf 1)[] | string | Each item | Known values: acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boku_promptpay, boleto, capchase_pay, card, card_present, cashapp, check_scan, click_to_pay, crypto, customer_balance, demo_pay, duitnow, dummy_auth_push, dummy_passthrough_card, edenred, eps, fpx, gcash, getbalance, gift_card, giropay, gopay, grabpay, id_bank_transfer, ideal, interac_present, kakao_pay, klarna, knet, konbini, kr_card, kr_market, kriya, link, mb_way, mobilepay, momo, mondu, multibanco, naver_pay, netbanking, ng_bank, ng_bank_transfer, ng_card, ng_market, ng_ussd, ng_wallet, nz_bank_account, octopus, oxxo, p24, paper_check, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, qris, rechnung, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, shop_pay, shopeepay, sofort, south_korea_market, stripe_balance, sunbit, swish, tamara, test_pay, touch_n_go, truemoney, twint, upi, us_bank_account, us_cash_voucher, vipps, wechat_pay, wero, zip |
allowed_payment_method_types (anyOf 2) | null | Alternative | |
application | JSON | Optional | |
application (anyOf 1) | JSON | Alternative | ID of the Connect application that created the SetupIntent. |
application (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
application (anyOf 1) (anyOf 2) | Model | Alternative | Expand PostApplicationFeesIdRefund — response body — application / object: application |
application (anyOf 2) | null | Alternative | |
attach_to_self | boolean | Optional | If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. |
automatic_payment_methods | JSON | Optional | |
automatic_payment_methods (anyOf 1) | JSON | Alternative | Settings for dynamic payment methods compatible with this Setup Intent |
automatic_payment_methods (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a SetupIntent — response body — automatic_payment_methods / value / allow_redirects: always, never |
automatic_payment_methods (anyOf 2) | null | Alternative | |
cancellation_reason | JSON | Optional | |
cancellation_reason (anyOf 1) | string | Alternative | Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`. Known values: abandoned, duplicate, requested_by_customer |
cancellation_reason (anyOf 2) | null | Alternative | |
client_secret | JSON | Optional | |
client_secret (anyOf 1) | string | Alternative | The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. Maximum length: 5000 |
client_secret (anyOf 2) | null | Alternative | |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
customer | JSON | Optional | |
customer (anyOf 1) | JSON | Alternative | ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. |
customer (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
customer (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a customer — response body |
customer (anyOf 1) (anyOf 3) | Model | Alternative | Expand Delete a customer — response body |
customer (anyOf 2) | null | Alternative | |
customer_account | JSON | Optional | |
customer_account (anyOf 1) | string | Alternative | ID of the Account this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. Maximum length: 5000 |
customer_account (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 5000 |
description (anyOf 2) | null | Alternative | |
excluded_payment_method_types | JSON | Optional | |
excluded_payment_method_types (anyOf 1) | array | Alternative | Payment method types that are excluded from this SetupIntent. |
excluded_payment_method_types (anyOf 1)[] | string | Each item | Known values: acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, cashapp, crypto, customer_balance, eps, fpx, giropay, grabpay, ideal, kakao_pay, klarna, konbini, kr_card, mb_way, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sequra, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip |
excluded_payment_method_types (anyOf 2) | null | Alternative | |
flow_directions | JSON | Optional | |
flow_directions (anyOf 1) | array | Alternative | Indicates the directions of money movement for which this payment method is intended to be used. Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes. |
flow_directions (anyOf 1)[] | string | Each item | Known values: inbound, outbound |
flow_directions (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
last_setup_error | JSON | Optional | |
last_setup_error (anyOf 1) | JSON | Alternative | The error encountered in the previous SetupIntent confirmation. |
last_setup_error (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error |
last_setup_error (anyOf 2) | null | Alternative | |
latest_attempt | JSON | Optional | |
latest_attempt (anyOf 1) | JSON | Alternative | The most recent SetupAttempt for this SetupIntent. |
latest_attempt (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
latest_attempt (anyOf 1) (anyOf 2) | Model | Alternative | Expand List all Setup Attempts — response body — data item |
latest_attempt (anyOf 2) | null | Alternative | |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
managed_payments | JSON | Optional | |
managed_payments (anyOf 1) | JSON | Alternative | |
managed_payments (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a Setup Intent — response body — managed payments value enabled |
managed_payments (anyOf 2) | null | Alternative | |
mandate | JSON | Optional | |
mandate (anyOf 1) | JSON | Alternative | ID of the multi use Mandate generated by the SetupIntent. |
mandate (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
mandate (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
mandate (anyOf 2) | null | Alternative | |
metadata | JSON | Optional | |
metadata (anyOf 1) | object | Alternative | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field |
metadata (anyOf 1).* | string | Additional keys | Maximum length: 500 |
metadata (anyOf 2) | null | Alternative | |
next_action | JSON | Optional | |
next_action (anyOf 1) | JSON | Alternative | If present, this property tells you what actions you need to take in order for your customer to continue payment setup. |
next_action (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits |
next_action (anyOf 2) | null | Alternative | |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: setup_intent |
on_behalf_of | JSON | Optional | |
on_behalf_of (anyOf 1) | JSON | Alternative | The account (if any) for which the setup is intended. |
on_behalf_of (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
on_behalf_of (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create an account — response body |
on_behalf_of (anyOf 2) | null | Alternative | |
payment_method | JSON | Optional | |
payment_method (anyOf 1) | JSON | Alternative | ID of the payment method used with this SetupIntent. If the payment method is `card_present` and isn't a digital wallet, then the [generated_card](https://docs.stripe.com/api/setup_attempts/object#setup_attempt_object-payment_method_details-card_present-generated_card) associated with the `latest_attempt` is attached to the Customer instead. |
payment_method (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
payment_method (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
payment_method (anyOf 2) | null | Alternative | |
payment_method_configuration_details | JSON | Optional | |
payment_method_configuration_details (anyOf 1) | JSON | Alternative | Information about the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) used for this Setup Intent. |
payment_method_configuration_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a Setup Intent — response body — payment method configuration details value id, parent |
payment_method_configuration_details (anyOf 2) | null | Alternative | |
payment_method_options | JSON | Optional | |
payment_method_options (anyOf 1) | JSON | Alternative | Payment method-specific configuration for this SetupIntent. |
payment_method_options (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account |
payment_method_options (anyOf 2) | null | Alternative | |
payment_method_types | array | Required within parent | The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). |
payment_method_types[] | string | Each item | Maximum length: 5000 |
single_use_mandate | JSON | Optional | |
single_use_mandate (anyOf 1) | JSON | Alternative | ID of the single_use Mandate generated by the SetupIntent. |
single_use_mandate (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
single_use_mandate (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
single_use_mandate (anyOf 2) | null | Alternative | |
status | string | Required within parent | [Status](https://docs.stripe.com/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. Known values: canceled, processing, requires_action, requires_confirmation, requires_payment_method, succeeded |
usage | string | Required within parent | Indicates how the payment method is intended to be used in the future. Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`. Maximum length: 5000 |
Referenced models: Create an account — response body, Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error, PostApplicationFeesIdRefund — response body — application / object: application, Create a customer — response body, Delete a customer — response body, Retrieve a Mandate — response body, Cancel a SetupIntent — response body — automatic_payment_methods / value / allow_redirects: always, never, Create a Payment Method — response body, Cancel a Setup Intent — response body — payment method configuration details value id, parent, Cancel a Setup Intent — response body — managed payments value enabled, List all Setup Attempts — response body — data item, Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account
Cancel a Setup Intent — response body — managed payments value enabled
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enabled | boolean | Required within parent | Set to `true` to enable [Managed Payments](https://docs.stripe.com/payments/managed-payments), Stripe's merchant of record solution, for this session. |
Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits
Referenced models: Create a Payment Method — response body — zip, Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits cashapp handle redirect or display qr code, Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits upi handle redirect or display qr code, Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits verify with microdeposits, Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits pix display qr code, Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits redirect to url
Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits cashapp handle redirect or display qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hosted_instructions_url | string | Required within parent | The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration. Maximum length: 5000 |
mobile_auth_url | string | Required within parent | The url for mobile redirect based auth Maximum length: 5000 |
qr_code | Model | Required within parent | Expand Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits upi handle redirect or display qr code qr code |
Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits pix display qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | string | Required within parent | The raw data string used to generate QR code, it should be used together with QR code library. Maximum length: 5000 |
expires_at | JSON | Required within parent | |
expires_at (anyOf 1) | integer | Alternative | The date (unix timestamp) when the PIX expires. Format: unix-time |
expires_at (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hosted_instructions_url | string | Required within parent | The URL to the hosted pix instructions page, which allows customers to view the pix QR code. Maximum length: 5000 |
image_url_png | string | Required within parent | The image_url_png string used to render png QR code Maximum length: 5000 |
image_url_svg | string | Required within parent | The image_url_svg string used to render svg QR code Maximum length: 5000 |
Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits redirect to url
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
return_url | JSON | Optional | |
return_url (anyOf 1) | string | Alternative | If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion. Maximum length: 5000 |
return_url (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The URL you must redirect your customer to in order to authenticate. Maximum length: 5000 |
url (anyOf 2) | null | Alternative |
Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits upi handle redirect or display qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hosted_instructions_url | string | Required within parent | The URL to the hosted UPI instructions page, which allows customers to view the QR code. Maximum length: 5000 |
qr_code | Model | Required within parent | Expand Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits upi handle redirect or display qr code qr code |
Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits upi handle redirect or display qr code qr code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expires_at | JSON | Required within parent | |
expires_at (anyOf 1) | integer | Alternative | The date (unix timestamp) when the QR code expires. Format: unix-time |
expires_at (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
image_url_png | string | Required within parent | The image_url_png string used to render QR code Maximum length: 5000 |
image_url_svg | string | Required within parent | The image_url_svg string used to render QR code Maximum length: 5000 |
Cancel a Setup Intent — response body — next action value blik authorize, cashapp handle redirect or display qr code, pix display qr code, redirect to url, type, upi handle redirect or display qr code, use stripe sdk, verify with microdeposits verify with microdeposits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
arrival_date | JSON | Required within parent | |
arrival_date (anyOf 1) | integer | Alternative | The timestamp when the microdeposits are expected to land. Format: unix-time |
arrival_date (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hosted_verification_url | string | Required within parent | The URL for the hosted verification page, which allows customers to verify their bank account. Maximum length: 5000 |
microdeposit_type | JSON | Optional | |
microdeposit_type (anyOf 1) | string | Alternative | The type of the microdeposit sent to the customer. Used to distinguish between different verification methods. Known values: amounts, descriptor_code |
microdeposit_type (anyOf 2) | null | Alternative |
Cancel a Setup Intent — response body — payment method configuration details value id, parent
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | ID of the payment method configuration used. Maximum length: 5000 |
parent | JSON | Optional | |
parent (anyOf 1) | string | Alternative | ID of the parent payment method configuration used. Maximum length: 5000 |
parent (anyOf 2) | null | Alternative |
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account
Referenced models: Create a Payment Method — response body — zip, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account upi mandate options, Cancel a SetupIntent — response body — payment_method_options / value / acss_debit, amazon_pay, bacs_debit, bizum, blik, card, card_present, klarna, link, paypal, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / verification_method: automatic, instant, microdeposits, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account bacs debit mandate options, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account blik mandate options, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account card mandate options, network, request three d secure, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account klarna currency, preferred locale, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account paypal billing agreement id, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account payto mandate options, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account pix mandate options, Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account sepa debit mandate options, Cancel a SetupIntent — response body — payment_method_options / value / acss_debit, amazon_pay, bacs_debit, bizum, blik, card, card_present, klarna, link, paypal, payto, pix, sepa_debit, upi, us_bank_account / us_bank_account / verification_method: automatic, instant, microdeposits, Cancel a SetupIntent — response body — payment_method_options / value / acss_debit, amazon_pay, bacs_debit, bizum, blik, card, card_present, klarna, link, paypal, payto, pix, sepa_debit, upi, us_bank_account / pix / verification_method: automatic, instant, microdeposits
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account bacs debit mandate options
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account blik mandate options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mandate_options | Model | Optional | Expand Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account blik mandate options mandate options |
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account blik mandate options mandate options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expires_at | JSON | Optional | |
expires_at (anyOf 1) | JSON | Alternative | |
expires_at (anyOf 1) (anyOf 1) | integer | Alternative | Date at which the mandate expires. 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 | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | Type of the mandate. Known values: off_session |
type (anyOf 2) | null | Alternative |
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account card mandate options, network, request three d secure
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mandate_options | JSON | Optional | |
mandate_options (anyOf 1) | JSON | Alternative | Configuration options for setting up an eMandate for cards issued in India. |
mandate_options (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a SetupIntent — response body — payment_method_options / value / acss_debit, amazon_pay, bacs_debit, bizum, blik, card, card_present, klarna, link, paypal, payto, pix, sepa_debit, upi, us_bank_account / card / mandate_options, network, request_three_d_secure / mandate_options / value / amount_type: fixed, maximum, interval: day, month, sporadic, week, year |
mandate_options (anyOf 2) | null | Alternative | |
network | JSON | Optional | |
network (anyOf 1) | string | Alternative | Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time. Known values: amex, cartes_bancaires, diners, discover, eftpos_au, girocard, interac, jcb, link, mastercard, unionpay, unknown, visa |
network (anyOf 2) | null | Alternative | |
request_three_d_secure | JSON | Optional | |
request_three_d_secure (anyOf 1) | string | Alternative | We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. Known values: any, automatic, challenge |
request_three_d_secure (anyOf 2) | null | Alternative |
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account klarna currency, preferred locale
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | The currency of the setup intent. Three letter ISO currency code. Format: currency |
currency (anyOf 2) | null | Alternative | |
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 |
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account paypal billing agreement id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
billing_agreement_id | JSON | Optional | |
billing_agreement_id (anyOf 1) | string | Alternative | The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. Maximum length: 5000 |
billing_agreement_id (anyOf 2) | null | Alternative |
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account payto mandate options
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account pix mandate options
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account sepa debit mandate options
Cancel a Setup Intent — response body — payment method options value acss debit, amazon pay, bacs debit, bizum, blik, card, card present, klarna, link, paypal, payto, pix, sepa debit, upi, us bank account upi mandate options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mandate_options | Model | Optional | Expand Retrieve a Mandate — response body — payment method details upi |
Referenced models: Retrieve a Mandate — response body — payment method details upi
Cancel a SetupIntent — response body — automatic_payment_methods / value / allow_redirects: always, never
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allow_redirects | string | Optional | Controls whether this SetupIntent will accept redirect-based payment methods. Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. Known values: always, never |
enabled | JSON | Optional | |
enabled (anyOf 1) | boolean | Alternative | Automatically calculates compatible payment methods |
enabled (anyOf 2) | null | Alternative |
Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
advice_code | string | Optional | For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines/card#retrying-issuer-declines) if they provide one. Maximum length: 5000 |
charge | string | Optional | For card errors, the ID of the failed charge. Maximum length: 5000 |
code | string | Optional | For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported. Maximum length: 5000 |
decline_code | string | Optional | For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. Maximum length: 5000 |
doc_url | string | Optional | A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported. Maximum length: 5000 |
message | string | Optional | A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. Maximum length: 40000 |
network_advice_code | string | Optional | For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error. Maximum length: 5000 |
network_decline_code | string | Optional | For payments declined by the network, an alphanumeric code which indicates the reason the payment failed. Maximum length: 5000 |
param | string | Optional | If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. Maximum length: 5000 |
payment_intent | Model | Optional | Expand Cancel a Payment Intent — response body |
payment_method | Model | Optional | Expand Create a Payment Method — response body |
payment_method_type | string | Optional | If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors. Maximum length: 5000 |
request_log_url | string | Optional | A URL to the request log entry in your dashboard. Maximum length: 5000 |
setup_intent | Model | Optional | Expand Cancel a Setup Intent — response body |
source | JSON | Optional | The [source object](https://docs.stripe.com/api/sources/object) for errors returned on a request involving a source. |
source (anyOf 1) | Model | Alternative | Expand Retrieve a bank account — response body |
source (anyOf 2) | Model | Alternative | Expand Retrieve a card — customers get Customers Customer Cards Id — response body |
source (anyOf 3) | Model | Alternative | Expand Create a source — response body |
type | string | Required within parent | The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` Known values: api_error, card_error, idempotency_error, invalid_request_error |
Referenced models: Retrieve a bank account — response body, Retrieve a card — customers get Customers Customer Cards Id — response body, Cancel a Payment Intent — response body, Create a Payment Method — response body, Cancel a Setup Intent — response body, Create a source — response body
Cancel a SetupIntent — response body — payment_method_options / value / acss_debit, amazon_pay, bacs_debit, bizum, blik, card, card_present, klarna, link, paypal, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / verification_method: automatic, instant, microdeposits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | Currency supported by the bank account Known values: cad, usd |
currency (anyOf 2) | null | Alternative | |
mandate_options | Model | Optional | Expand Cancel a SetupIntent — response body — payment_method_options / value / acss_debit, amazon_pay, bacs_debit, bizum, blik, card, card_present, klarna, link, paypal, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / verification_method: automatic, instant, microdeposits mandate options |
verification_method | string | Optional | Bank account verification method. The default value is `automatic`. Known values: automatic, instant, microdeposits |
Cancel a SetupIntent — response body — payment_method_options / value / acss_debit, amazon_pay, bacs_debit, bizum, blik, card, card_present, klarna, link, paypal, payto, pix, sepa_debit, upi, us_bank_account / acss_debit / verification_method: automatic, instant, microdeposits mandate options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_mandate_url | string | Optional | A URL for custom mandate text Maximum length: 5000 |
default_for | array | Optional | List of Stripe products where this mandate can be selected automatically. |
default_for[] | string | Each item | Known values: invoice, subscription |
interval_description | JSON | Optional | |
interval_description (anyOf 1) | string | Alternative | Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'. Maximum length: 5000 |
interval_description (anyOf 2) | null | Alternative | |
payment_schedule | JSON | Optional | |
payment_schedule (anyOf 1) | string | Alternative | Payment schedule for the mandate. Known values: combined, interval, sporadic |
payment_schedule (anyOf 2) | null | Alternative | |
transaction_type | JSON | Optional | |
transaction_type (anyOf 1) | string | Alternative | Transaction type of the mandate. Known values: business, personal |
transaction_type (anyOf 2) | null | Alternative |
Cancel a SetupIntent — response body — payment_method_options / value / acss_debit, amazon_pay, bacs_debit, bizum, blik, card, card_present, klarna, link, paypal, payto, pix, sepa_debit, upi, us_bank_account / card / mandate_options, network, request_three_d_secure / mandate_options / value / amount_type: fixed, maximum, interval: day, month, sporadic, week, year
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount to be charged for future payments, specified in the presentment currency. |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_type | string | Required within parent | One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param. Known values: fixed, maximum |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | A description of the mandate or subscription that is meant to be displayed to the customer. Maximum length: 200 |
description (anyOf 2) | null | Alternative | |
end_date | JSON | Optional | |
end_date (anyOf 1) | JSON | Alternative | |
end_date (anyOf 1) (anyOf 1) | integer | Alternative | End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date. Format: unix-time |
end_date (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
end_date (anyOf 2) | null | Alternative | |
interval | string | Required within parent | Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`. Known values: day, month, sporadic, week, year |
interval_count | JSON | Optional | |
interval_count (anyOf 1) | JSON | Alternative | |
interval_count (anyOf 1) (anyOf 1) | integer | Alternative | The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`. |
interval_count (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
interval_count (anyOf 2) | null | Alternative | |
reference | string | Required within parent | Unique identifier for the mandate or subscription. Maximum length: 80 |
start_date | JSON | Required within parent | |
start_date (anyOf 1) | integer | Alternative | Start date of the mandate or subscription. Start date should not be lesser than yesterday. Format: unix-time |
start_date (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
supported_types | JSON | Optional | |
supported_types (anyOf 1) | array | Alternative | Specifies the type of mandates supported. Possible values are `india`. |
supported_types (anyOf 1)[] | string | Each item | Known values: india |
supported_types (anyOf 2) | null | Alternative |
Cancel a SetupIntent — response body — payment_method_options / value / acss_debit, amazon_pay, bacs_debit, bizum, blik, card, card_present, klarna, link, paypal, payto, pix, sepa_debit, upi, us_bank_account / pix / verification_method: automatic, instant, microdeposits
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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 payto mandate options |
verification_method | string | Optional | Bank account verification method. The default value is `automatic`. Known values: automatic, instant, microdeposits |
Cancel a SetupIntent — response body — payment_method_options / value / acss_debit, amazon_pay, bacs_debit, bizum, blik, card, card_present, klarna, link, paypal, payto, pix, sepa_debit, upi, us_bank_account / us_bank_account / 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 |
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
Create a Setup Intent — request body — body mandate data customer acceptance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customer_acceptance | object | Required within parent | |
customer_acceptance.accepted_at | integer | Optional | Format: unix-time |
customer_acceptance.offline | object | Optional | |
customer_acceptance.online | object | Optional | |
customer_acceptance.online.ip_address | string | Required within parent | |
customer_acceptance.online.user_agent | string | Required within parent | Maximum length: 5000 |
customer_acceptance.type | string | Required within parent | One of: offline, online Maximum length: 5000 |
Create a Setup Intent — request body — body payment method data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. |
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 Setup Intent — request body — body payment method data billing details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (anyOf 1) | object | Alternative | |
address (anyOf 1).city | string | Optional | Maximum length: 5000 |
address (anyOf 1).country | string | Optional | Maximum length: 5000 |
address (anyOf 1).line1 | string | Optional | Maximum length: 5000 |
address (anyOf 1).line2 | string | Optional | Maximum length: 5000 |
address (anyOf 1).postal_code | string | Optional | Maximum length: 5000 |
address (anyOf 1).state | string | Optional | Maximum length: 5000 |
address (anyOf 2) | string | Alternative | One of: |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | |
email (anyOf 2) | string | Alternative | One of: |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Maximum length: 5000 |
name (anyOf 2) | string | Alternative | One of: |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Maximum length: 5000 |
phone (anyOf 2) | string | Alternative | One of: |
tax_id | string | Optional | Maximum length: 5000 |
Create a Setup Intent — request body — body payment method data eps
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank | string | Optional | One of: arzte_und_apotheker_bank, austrian_anadi_bank_ag, bank_austria, bankhaus_carl_spangler, bankhaus_schelhammer_und_schattera_ag, bawag_psk_ag, bks_bank_ag, brull_kallmus_bank_ag, btv_vier_lander_bank, capital_bank_grawe_gruppe_ag, deutsche_bank_ag, dolomitenbank, easybank_ag, erste_bank_und_sparkassen, hypo_alpeadriabank_international_ag, hypo_bank_burgenland_aktiengesellschaft, hypo_noe_lb_fur_niederosterreich_u_wien, hypo_oberosterreich_salzburg_steiermark, hypo_tirol_bank_ag, hypo_vorarlberg_bank_ag, marchfelder_bank, oberbank_ag, raiffeisen_bankengruppe_osterreich, schoellerbank_ag, sparda_bank_wien, volksbank_gruppe, volkskreditbank_ag, vr_bank_braunau Maximum length: 5000 |
Create a Setup Intent — request body — body payment method options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payment method-specific configuration for this SetupIntent. |
acss_debit | Model | Optional | Expand Create a Setup Intent — request body — body payment method options acss debit |
amazon_pay | object | Optional | |
bacs_debit | object | Optional | |
bacs_debit.mandate_options | object | Optional | |
bacs_debit.mandate_options.reference_prefix | JSON | Optional | |
bacs_debit.mandate_options.reference_prefix (anyOf 1) | string | Alternative | Maximum length: 12 |
bacs_debit.mandate_options.reference_prefix (anyOf 2) | string | Alternative | One of: |
bizum | object | Optional | |
blik | object | Optional | |
blik.code | string | Optional | Maximum length: 5000 |
blik.mandate_options | object | Optional | |
blik.mandate_options.expires_at | integer | Optional | Format: unix-time |
card | Model | Optional | Expand Create a Setup Intent — request body — body payment method options card |
card_present | object | Optional | |
klarna | Model | Optional | Expand Create a Setup Intent — request body — body payment method options klarna |
link | object | Optional | |
paypal | object | Optional | |
paypal.billing_agreement_id | string | Optional | Maximum length: 5000 |
payto | Model | Optional | Expand Create a Setup Intent — request body — body payment method options payto |
pix | Model | Optional | Expand Create a Setup Intent — request body — body payment method options pix |
sepa_debit | object | Optional | |
sepa_debit.mandate_options | object | Optional | |
sepa_debit.mandate_options.reference_prefix | JSON | Optional | |
sepa_debit.mandate_options.reference_prefix (anyOf 1) | string | Alternative | Maximum length: 12 |
sepa_debit.mandate_options.reference_prefix (anyOf 2) | string | Alternative | One of: |
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 |
upi.setup_future_usage | string | Optional | One of: , none, off_session, on_session |
us_bank_account | Model | Optional | Expand Create a Setup Intent — request body — body payment method options us bank account |
Referenced models: Create a Setup Intent — request body — body payment method options acss debit, Create a Setup Intent — request body — body payment method options card, Create a Setup Intent — request body — body payment method options klarna, Create a Setup Intent — request body — body payment method options payto, Create a Setup Intent — request body — body payment method options pix, Create a Setup Intent — request body — body payment method options us bank account
Create a Setup Intent — request body — body payment method options acss debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | One of: cad, usd |
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.default_for | array | Optional | |
mandate_options.default_for[] | string | Each item | One of: invoice, subscription |
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 |
verification_method | string | Optional | One of: automatic, instant, microdeposits |
Create a Setup Intent — request body — body payment method options card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mandate_options | Model | Optional | Expand Create a Setup Intent — request body — body payment method options card 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_three_d_secure | string | Optional | One of: any, automatic, challenge |
three_d_secure | Model | Optional | Expand Create a Setup Intent — request body — body payment method options card three d secure |
Referenced models: Create a Setup Intent — request body — body payment method options card mandate options, Create a Setup Intent — request body — body payment method options card three d secure
Create a Setup Intent — request body — body payment method options card 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 |
currency | string | Required within parent | Format: currency |
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 Setup Intent — request body — body payment method options card 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 | Optional | Maximum length: 5000 |
electronic_commerce_indicator | string | Optional | One of: 01, 02, 05, 06, 07 |
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 | Optional | Maximum length: 5000 |
version | string | Optional | One of: 1.0.2, 2.1.0, 2.2.0, 2.3.0, 2.3.1 |
Create a Setup Intent — request body — body payment method options klarna
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Format: currency |
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 |
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 | Required within parent | |
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 Setup Intent — request body — body payment method options payto
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mandate_options | Model | Optional | Expand Create a Setup Intent — request body — body payment method options payto mandate options |
Referenced models: Create a Setup Intent — request body — body payment method options payto mandate options
Create a Setup Intent — request body — body payment method options payto 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 |
start_date | JSON | Optional | |
start_date (anyOf 1) | string | Alternative | Maximum length: 5000 |
start_date (anyOf 2) | string | Alternative | One of: |
Create a Setup Intent — request body — body payment method options pix
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mandate_options | Model | Optional | Expand Create a Setup Intent — request body — body payment method options pix mandate options |
Referenced models: Create a Setup Intent — request body — body payment method options pix mandate options
Create a Setup Intent — request body — body payment method options pix mandate options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | integer | Optional | |
amount_includes_iof | string | Optional | One of: always, never |
amount_type | string | Optional | One of: fixed, maximum |
currency | string | Optional | Format: currency |
end_date | string | Optional | Maximum length: 5000 |
payment_schedule | string | Optional | One of: halfyearly, monthly, quarterly, weekly, yearly |
reference | string | Optional | Maximum length: 35 |
start_date | string | Optional | Maximum length: 5000 |
Create a Setup Intent — request body — body payment method options us bank account
| 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 |
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
Create a Setup Intent — request body — body payment method options us bank account financial connections
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filters | object | Optional | |
filters.account_subcategories | array | Optional | |
filters.account_subcategories[] | string | Each item | One of: checking, savings Maximum length: 5000 |
permissions | array | Optional | |
permissions[] | string | Each item | One of: balances, ownership, payment_method, transactions Maximum length: 5000 |
prefetch | array | Optional | |
prefetch[] | string | Each item | One of: balances, ownership, transactions |
return_url | string | Optional | Maximum length: 5000 |