The SetupIntent object

Core Resources

Setup Intents

Attributes

idstringretrievable with publishable key
Unique identifier for the object.

automatic_payment_methodsnullable object

Settings for dynamic payment methods compatible with this Setup Intent

automatic_payment_methods.allow_redirectsnullable enum

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 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.

Possible enum values

always

(Default) This SetupIntent will accept redirect-based payment methods. return_url may be required to confirm this SetupIntent.

never

This SetupIntent will not accept redirect-based payment methods. Payment methods that require redirect will be filtered. return_url will not be required to confirm this SetupIntent.

automatic_payment_methods.enablednullable boolean
Automatically calculates compatible payment methods

client_secretnullable stringretrievable with publishable key
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.

customernullable stringExpandable
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.

descriptionnullable stringretrievable with publishable key
An arbitrary string attached to the object. Often useful for displaying to users.

last_setup_errornullable objectretrievable with publishable key

The error encountered in the previous SetupIntent confirmation.

last_setup_error.advice_codenullable string
For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.

last_setup_error.codenullable string
For some errors that could be handled programmatically, a short string indicating the error code reported.

last_setup_error.decline_codenullable string
For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide one.

last_setup_error.doc_urlnullable string
A URL to more information about the error code reported.

last_setup_error.messagenullable string
A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

last_setup_error.network_advice_codenullable string
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.

last_setup_error.network_decline_codenullable string
For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.

last_setup_error.paramnullable string
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.

last_setup_error.payment_methodnullable object

The PaymentMethod object for errors returned on a request involving a PaymentMethod.

last_setup_error.payment_method.idstring
Unique identifier for the object.

last_setup_error.payment_method.objectstring
String representing the object’s type. Objects of the same type share the same value.

last_setup_error.payment_method.acss_debitnullable object
If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.
- last_setup_error.payment_method.acss_debit.bank_namenullable string
  Name of the bank associated with the bank account.
- last_setup_error.payment_method.acss_debit.fingerprintnullable string
  Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- last_setup_error.payment_method.acss_debit.institution_numbernullable string
  Institution number of the bank account.
- last_setup_error.payment_method.acss_debit.last4nullable string
  Last four digits of the bank account number.
- last_setup_error.payment_method.acss_debit.transit_numbernullable string
  Transit number of the bank account.

last_setup_error.payment_method.affirmnullable object
If this is an affirm PaymentMethod, this hash contains details about the Affirm payment method.

last_setup_error.payment_method.afterpay_clearpaynullable object
If this is an AfterpayClearpay PaymentMethod, this hash contains details about the AfterpayClearpay payment method.

last_setup_error.payment_method.alipaynullable object
If this is an Alipay PaymentMethod, this hash contains details about the Alipay payment method.

last_setup_error.payment_method.allow_redisplaynullable enum

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.

Possible enum values

always

Use always to indicate that this payment method can always be shown to a customer in a checkout flow.

limited

Use limited to indicate that this payment method can’t always be shown to a customer in a checkout flow. For example, it can only be shown in the context of a specific subscription.

unspecified

This is the default value for payment methods where allow_redisplay wasn’t set.

last_setup_error.payment_method.almanullable object
If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.

last_setup_error.payment_method.amazon_paynullable object
If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.

last_setup_error.payment_method.au_becs_debitnullable object
If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.
- last_setup_error.payment_method.au_becs_debit.bsb_numbernullable string
  Six-digit number identifying bank and branch associated with this bank account.
- last_setup_error.payment_method.au_becs_debit.fingerprintnullable string
  Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- last_setup_error.payment_method.au_becs_debit.last4nullable string
  Last four digits of the bank account number.

last_setup_error.payment_method.bacs_debitnullable object
If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
- last_setup_error.payment_method.bacs_debit.fingerprintnullable string
  Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- last_setup_error.payment_method.bacs_debit.last4nullable string
  Last four digits of the bank account number.
- last_setup_error.payment_method.bacs_debit.sort_codenullable string
  Sort code of the bank account. (e.g., 10-20-30)

last_setup_error.payment_method.bancontactnullable object
If this is a bancontact PaymentMethod, this hash contains details about the Bancontact payment method.

last_setup_error.payment_method.billienullable object
If this is a billie PaymentMethod, this hash contains details about the Billie payment method.

last_setup_error.payment_method.billing_detailsobject
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
- last_setup_error.payment_method.billing_details.addressnullable object
  Billing address.
  last_setup_error.payment_method.billing_details.address.citynullable string
  City, district, suburb, town, or village.
  last_setup_error.payment_method.billing_details.address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  last_setup_error.payment_method.billing_details.address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  last_setup_error.payment_method.billing_details.address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  last_setup_error.payment_method.billing_details.address.postal_codenullable string
  ZIP or postal code.
  last_setup_error.payment_method.billing_details.address.statenullable string
  State, county, province, or region.
- last_setup_error.payment_method.billing_details.emailnullable string
  Email address.
- last_setup_error.payment_method.billing_details.namenullable string
  Full name.
- last_setup_error.payment_method.billing_details.phonenullable string
  Billing phone number (including extension).
- last_setup_error.payment_method.billing_details.tax_idnullable string
  Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.

last_setup_error.payment_method.bliknullable object
If this is a blik PaymentMethod, this hash contains details about the BLIK payment method.

last_setup_error.payment_method.boletonullable object
If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.
- last_setup_error.payment_method.boleto.tax_idstring
  Uniquely identifies the customer tax id (CNPJ or CPF)

last_setup_error.payment_method.cardnullable object

If this is a card PaymentMethod, this hash contains the user’s card details.

last_setup_error.payment_method.card.brandstring
Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.

last_setup_error.payment_method.card.checksnullable object
Checks on Card address and CVC if provided.
- last_setup_error.payment_method.card.checks.address_line1_checknullable string
  If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked.
- last_setup_error.payment_method.card.checks.address_postal_code_checknullable string
  If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked.
- last_setup_error.payment_method.card.checks.cvc_checknullable string
  If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked.

last_setup_error.payment_method.card.countrynullable string
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

last_setup_error.payment_method.card.display_brandnullable string
The brand to use when displaying the card, this accounts for customer’s brand choice on dual-branded cards. Can be american_express, cartes_bancaires, diners_club, discover, eftpos_australia, interac, jcb, mastercard, union_pay, visa, or other and may contain more values in the future.

last_setup_error.payment_method.card.exp_monthinteger
Two-digit number representing the card’s expiration month.

last_setup_error.payment_method.card.exp_yearinteger
Four-digit number representing the card’s expiration year.

last_setup_error.payment_method.card.fingerprintnullable string
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

last_setup_error.payment_method.card.fundingstring
Card funding type. Can be credit, debit, prepaid, or unknown.

last_setup_error.payment_method.card.generated_fromnullable object

Details of the original PaymentMethod that created this object.

last_setup_error.payment_method.card.generated_from.chargenullable string
The charge that created this object.

last_setup_error.payment_method.card.generated_from.payment_method_detailsnullable object

Transaction-specific details of the payment method used in the payment.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_presentnullable object

This hash contains the snapshot of the card_present transaction-specific details which generated this card payment method.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.amount_authorizednullable integer
The authorized amount

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.brandnullable string
Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.brand_productnullable string
The product code that identifies the specific program or product associated with a card.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.capture_beforenullable timestamp
When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.cardholder_namenullable string
The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.countrynullable string
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.descriptionnullable string
A high-level description of the type of cards issued in this range.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.emv_auth_datanullable string
Authorization response cryptogram.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.exp_monthinteger
Two-digit number representing the card’s expiration month.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.exp_yearinteger
Four-digit number representing the card’s expiration year.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.fingerprintnullable string
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.fundingnullable string
Card funding type. Can be credit, debit, prepaid, or unknown.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.generated_cardnullable string
ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.incremental_authorization_supportedboolean
Whether this PaymentIntent is eligible for incremental authorizations. Request support using request_incremental_authorization_support.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.issuernullable string
The name of the card’s issuing bank.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.last4nullable string
The last four digits of the card.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.networknullable string
Identifies which network this charge was processed on. Can be amex, cartes_bancaires, diners, discover, eftpos_au, interac, jcb, link, mastercard, unionpay, visa, or unknown.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.network_transaction_idnullable string
This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.offlinenullable object
Details about payments collected offline.
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.offline.stored_atnullable timestamp
  Time at which the payment was collected while offline
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.offline.typenullable enum
  The method used to process this payment method offline. Only deferred is allowed.
  Possible enum values
  deferred

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.overcapture_supportedboolean
Defines whether the authorized amount can be over-captured or not

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.preferred_localesnullable array of strings
The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card’s chip.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.read_methodnullable enum

How card details were read in this transaction.

Possible enum values

contact_emv

Inserting a chip card into the card reader.

contactless_emv

Tapping a contactless-enabled chip card or mobile wallet.

contactless_magstripe_mode

Older standard for contactless payments that emulated a magnetic stripe read.

magnetic_stripe_fallback

When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.

magnetic_stripe_track2

Swiping a card using the magnetic stripe reader.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.receiptnullable object
A collection of fields required to be displayed on receipts. Only required for EMV transactions.
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.account_typenullable enum
  The type of account being debited or credited
  Possible enum values
  checking
  A checking account, as when using a debit card
  credit
  A credit account, as when using a credit card
  prepaid
  A prepaid account, as when using a debit gift card
  unknown
  An unknown account
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.application_cryptogramnullable string
  The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.application_preferred_namenullable string
  The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card’s chip.
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.authorization_codenullable string
  Identifier for this transaction.
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.authorization_response_codenullable string
  EMV tag 8A. A code returned by the card issuer.
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.cardholder_verification_methodnullable string
  Describes the method used by the cardholder to verify ownership of the card. One of the following: approval, failure, none, offline_pin, offline_pin_and_signature, online_pin, or signature.
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.dedicated_file_namenullable string
  Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.terminal_verification_resultsnullable string
  A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.
- last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.transaction_status_informationnullable string
  An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.walletnullable object

If a mobile wallet was presented in the transaction, this contains the details of the mobile wallet.

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.wallet.typeenum

The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown.

Possible enum values

apple_pay

Apple Pay is a mobile payment service by Apple.

google_pay

Google Pay is a mobile payment service by Google.

samsung_pay

Samsung Pay is a mobile payment service by Samsung Electronics.

unknown

The wallet provider is unknown.

last_setup_error.payment_method.card.generated_from.payment_method_details.typestring
The type of payment method transaction-specific details from the transaction that generated this card payment method. Always card_present.

last_setup_error.payment_method.card.generated_from.setup_attemptnullable stringExpandable
The ID of the SetupAttempt that generated this PaymentMethod, if any.

last_setup_error.payment_method.card.last4string
The last four digits of the card.

last_setup_error.payment_method.card.networksnullable object
Contains information about card networks that can be used to process the payment.
- last_setup_error.payment_method.card.networks.availablearray of strings
  All networks available for selection via payment_method_options.card.network.
- last_setup_error.payment_method.card.networks.preferrednullable string
  The preferred network for co-branded cards. Can be cartes_bancaires, mastercard, visa or invalid_preference if requested network is not valid for the card.

last_setup_error.payment_method.card.regulated_statusnullable enum
Status of a card based on the card issuer.
Possible enum values
regulated
The card falls under a regulated account range.
unregulated
The card does not fall under a regulated account range.

last_setup_error.payment_method.card.three_d_secure_usagenullable object
Contains details on how this Card may be used for 3D Secure authentication.
- last_setup_error.payment_method.card.three_d_secure_usage.supportedboolean
  Whether 3D Secure is supported on this card.

last_setup_error.payment_method.card.walletnullable object
If this Card is part of a card wallet, this contains the details of the card wallet.
- last_setup_error.payment_method.card.wallet.amex_express_checkoutnullable object
  If this is a amex_express_checkout card wallet, this hash contains details about the wallet.
- last_setup_error.payment_method.card.wallet.apple_paynullable object
  If this is a apple_pay card wallet, this hash contains details about the wallet.
- last_setup_error.payment_method.card.wallet.dynamic_last4nullable string
  (For tokenized numbers only.) The last four digits of the device account number.
- last_setup_error.payment_method.card.wallet.google_paynullable object
  If this is a google_pay card wallet, this hash contains details about the wallet.
- last_setup_error.payment_method.card.wallet.linknullable object
  If this is a link card wallet, this hash contains details about the wallet.
- last_setup_error.payment_method.card.wallet.masterpassnullable object
  If this is a masterpass card wallet, this hash contains details about the wallet.
  last_setup_error.payment_method.card.wallet.masterpass.billing_addressnullable object
  Owner’s verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
  last_setup_error.payment_method.card.wallet.masterpass.billing_address.citynullable string
  City, district, suburb, town, or village.
  last_setup_error.payment_method.card.wallet.masterpass.billing_address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  last_setup_error.payment_method.card.wallet.masterpass.billing_address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  last_setup_error.payment_method.card.wallet.masterpass.billing_address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  last_setup_error.payment_method.card.wallet.masterpass.billing_address.postal_codenullable string
  ZIP or postal code.
  last_setup_error.payment_method.card.wallet.masterpass.billing_address.statenullable string
  State, county, province, or region.
  last_setup_error.payment_method.card.wallet.masterpass.emailnullable string
  Owner’s verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
  last_setup_error.payment_method.card.wallet.masterpass.namenullable string
  Owner’s verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
  last_setup_error.payment_method.card.wallet.masterpass.shipping_addressnullable object
  Owner’s verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
  last_setup_error.payment_method.card.wallet.masterpass.shipping_address.citynullable string
  City, district, suburb, town, or village.
  last_setup_error.payment_method.card.wallet.masterpass.shipping_address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  last_setup_error.payment_method.card.wallet.masterpass.shipping_address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  last_setup_error.payment_method.card.wallet.masterpass.shipping_address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  last_setup_error.payment_method.card.wallet.masterpass.shipping_address.postal_codenullable string
  ZIP or postal code.
  last_setup_error.payment_method.card.wallet.masterpass.shipping_address.statenullable string
  State, county, province, or region.
- last_setup_error.payment_method.card.wallet.samsung_paynullable object
  If this is a samsung_pay card wallet, this hash contains details about the wallet.
- last_setup_error.payment_method.card.wallet.typeenum
  The type of the card wallet, one of amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, visa_checkout, or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.
  Possible enum values
  amex_express_checkout
  apple_pay
  google_pay
  link
  masterpass
  samsung_pay
  visa_checkout
- last_setup_error.payment_method.card.wallet.visa_checkoutnullable object
  If this is a visa_checkout card wallet, this hash contains details about the wallet.
  last_setup_error.payment_method.card.wallet.visa_checkout.billing_addressnullable object
  Owner’s verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
  last_setup_error.payment_method.card.wallet.visa_checkout.billing_address.citynullable string
  City, district, suburb, town, or village.
  last_setup_error.payment_method.card.wallet.visa_checkout.billing_address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  last_setup_error.payment_method.card.wallet.visa_checkout.billing_address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  last_setup_error.payment_method.card.wallet.visa_checkout.billing_address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  last_setup_error.payment_method.card.wallet.visa_checkout.billing_address.postal_codenullable string
  ZIP or postal code.
  last_setup_error.payment_method.card.wallet.visa_checkout.billing_address.statenullable string
  State, county, province, or region.
  last_setup_error.payment_method.card.wallet.visa_checkout.emailnullable string
  Owner’s verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
  last_setup_error.payment_method.card.wallet.visa_checkout.namenullable string
  Owner’s verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
  last_setup_error.payment_method.card.wallet.visa_checkout.shipping_addressnullable object
  Owner’s verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
  last_setup_error.payment_method.card.wallet.visa_checkout.shipping_address.citynullable string
  City, district, suburb, town, or village.
  last_setup_error.payment_method.card.wallet.visa_checkout.shipping_address.countrynullable string
  Two-letter country code (ISO 3166-1 alpha-2).
  last_setup_error.payment_method.card.wallet.visa_checkout.shipping_address.line1nullable string
  Address line 1 (e.g., street, PO Box, or company name).
  last_setup_error.payment_method.card.wallet.visa_checkout.shipping_address.line2nullable string
  Address line 2 (e.g., apartment, suite, unit, or building).
  last_setup_error.payment_method.card.wallet.visa_checkout.shipping_address.postal_codenullable string
  ZIP or postal code.
  last_setup_error.payment_method.card.wallet.visa_checkout.shipping_address.statenullable string
  State, county, province, or region.

last_setup_error.payment_method.card_presentnullable object

If this is a card_present PaymentMethod, this hash contains details about the Card Present payment method.

last_setup_error.payment_method.card_present.brandnullable string
Card brand. Can be amex, cartes_bancaires, diners, discover, eftpos_au, jcb, link, mastercard, unionpay, visa or unknown.

last_setup_error.payment_method.card_present.brand_productnullable string
The product code that identifies the specific program or product associated with a card.

last_setup_error.payment_method.card_present.cardholder_namenullable string
The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.

last_setup_error.payment_method.card_present.countrynullable string
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

last_setup_error.payment_method.card_present.descriptionnullable string
A high-level description of the type of cards issued in this range.

last_setup_error.payment_method.card_present.exp_monthinteger
Two-digit number representing the card’s expiration month.

last_setup_error.payment_method.card_present.exp_yearinteger
Four-digit number representing the card’s expiration year.

last_setup_error.payment_method.card_present.fingerprintnullable string
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

last_setup_error.payment_method.card_present.fundingnullable string
Card funding type. Can be credit, debit, prepaid, or unknown.

last_setup_error.payment_method.card_present.issuernullable string
The name of the card’s issuing bank.

last_setup_error.payment_method.card_present.last4nullable string
The last four digits of the card.

last_setup_error.payment_method.card_present.networksnullable object
Contains information about card networks that can be used to process the payment.
- last_setup_error.payment_method.card_present.networks.availablearray of strings
  All networks available for selection via payment_method_options.card.network.
- last_setup_error.payment_method.card_present.networks.preferrednullable string
  The preferred network for the card.

last_setup_error.payment_method.card_present.offlinenullable object
Details about payment methods collected offline.
- last_setup_error.payment_method.card_present.offline.stored_atnullable timestamp
  Time at which the payment was collected while offline
- last_setup_error.payment_method.card_present.offline.typenullable enum
  The method used to process this payment method offline. Only deferred is allowed.
  Possible enum values
  deferred

last_setup_error.payment_method.card_present.preferred_localesnullable array of strings
The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card’s chip.

last_setup_error.payment_method.card_present.read_methodnullable enum

How card details were read in this transaction.

Possible enum values

contact_emv

Inserting a chip card into the card reader.

contactless_emv

Tapping a contactless-enabled chip card or mobile wallet.

contactless_magstripe_mode

Older standard for contactless payments that emulated a magnetic stripe read.

magnetic_stripe_fallback

When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.

magnetic_stripe_track2

Swiping a card using the magnetic stripe reader.

last_setup_error.payment_method.card_present.walletnullable object

If a mobile wallet was presented in the transaction, this contains the details of the mobile wallet.

last_setup_error.payment_method.card_present.wallet.typeenum

The type of mobile wallet, one of apple_pay, google_pay, samsung_pay, or unknown.

Possible enum values

apple_pay

Apple Pay is a mobile payment service by Apple.

google_pay

Google Pay is a mobile payment service by Google.

samsung_pay

Samsung Pay is a mobile payment service by Samsung Electronics.

unknown

The wallet provider is unknown.

last_setup_error.payment_method.cashappnullable object
If this is a cashapp PaymentMethod, this hash contains details about the Cash App Pay payment method.
- last_setup_error.payment_method.cashapp.buyer_idnullable string
  A unique and immutable identifier assigned by Cash App to every buyer.
- last_setup_error.payment_method.cashapp.cashtagnullable string
  A public identifier for buyers using Cash App.

last_setup_error.payment_method.createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.

last_setup_error.payment_method.cryptonullable object
If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.

last_setup_error.payment_method.customernullable stringExpandable
The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.

last_setup_error.payment_method.customer_balancenullable object
If this is a customer_balance PaymentMethod, this hash contains details about the CustomerBalance payment method.

last_setup_error.payment_method.epsnullable object

If this is an eps PaymentMethod, this hash contains details about the EPS payment method.

last_setup_error.payment_method.eps.banknullable enum

The customer’s bank. Should be 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_noe_lb_fur_niederosterreich_u_wien, hypo_oberosterreich_salzburg_steiermark, hypo_tirol_bank_ag, hypo_vorarlberg_bank_ag, hypo_bank_burgenland_aktiengesellschaft, marchfelder_bank, oberbank_ag, raiffeisen_bankengruppe_osterreich, schoellerbank_ag, sparda_bank_wien, volksbank_gruppe, volkskreditbank_ag, or vr_bank_braunau.

Possible enum values

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

Show 18 more

last_setup_error.payment_method.fpxnullable object
If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.
- last_setup_error.payment_method.fpx.bankenum
  The customer’s bank, if provided. Can be one of affin_bank, agrobank, alliance_bank, ambank, bank_islam, bank_muamalat, bank_rakyat, bsn, cimb, hong_leong_bank, hsbc, kfh, maybank2u, ocbc, public_bank, rhb, standard_chartered, uob, deutsche_bank, maybank2e, pb_enterprise, or bank_of_china.
  Possible enum values
  affin_bank
  agrobank
  alliance_bank
  ambank
  bank_islam
  bank_muamalat
  bank_of_china
  bank_rakyat
  bsn
  cimb
  Show 12 more

last_setup_error.payment_method.giropaynullable object
If this is a giropay PaymentMethod, this hash contains details about the Giropay payment method.

last_setup_error.payment_method.grabpaynullable object
If this is a grabpay PaymentMethod, this hash contains details about the GrabPay payment method.

last_setup_error.payment_method.idealnullable object
If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.
- last_setup_error.payment_method.ideal.banknullable enum
  The customer’s bank, if provided. Can be one of abn_amro, asn_bank, bunq, buut, handelsbanken, ing, knab, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot, or yoursafe.
  Possible enum values
  abn_amro
  asn_bank
  bunq
  buut
  handelsbanken
  ing
  knab
  moneyou
  n26
  nn
  Show 7 more
- last_setup_error.payment_method.ideal.bicnullable enum
  The Bank Identifier Code of the customer’s bank, if the bank was provided.
  Possible enum values
  ABNANL2A
  ASNBNL21
  BITSNL2A
  BUNQNL2A
  BUUTNL2A
  FVLBNL22
  HANDNL2A
  INGBNL2A
  KNABNL2H
  MOYONL21
  Show 8 more

last_setup_error.payment_method.interac_presentnullable objectPreview feature

If this is an interac_present PaymentMethod, this hash contains details about the Interac Present payment method.

last_setup_error.payment_method.interac_present.brandnullable string
Card brand. Can be interac, mastercard or visa.

last_setup_error.payment_method.interac_present.cardholder_namenullable string
The cardholder name as read from the card, in ISO 7813 format. May include alphanumeric characters, special characters and first/last name separator (/). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.

last_setup_error.payment_method.interac_present.countrynullable string
Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

last_setup_error.payment_method.interac_present.descriptionnullable string
A high-level description of the type of cards issued in this range.

last_setup_error.payment_method.interac_present.exp_monthinteger
Two-digit number representing the card’s expiration month.

last_setup_error.payment_method.interac_present.exp_yearinteger
Four-digit number representing the card’s expiration year.

last_setup_error.payment_method.interac_present.fingerprintnullable string
Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

last_setup_error.payment_method.interac_present.fundingnullable string
Card funding type. Can be credit, debit, prepaid, or unknown.

last_setup_error.payment_method.interac_present.issuernullable string
The name of the card’s issuing bank.

last_setup_error.payment_method.interac_present.last4nullable string
The last four digits of the card.

last_setup_error.payment_method.interac_present.networksnullable object
Contains information about card networks that can be used to process the payment.
- last_setup_error.payment_method.interac_present.networks.availablearray of strings
  All networks available for selection via payment_method_options.card.network.
- last_setup_error.payment_method.interac_present.networks.preferrednullable string
  The preferred network for the card.

last_setup_error.payment_method.interac_present.preferred_localesnullable array of strings
The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card’s chip.

last_setup_error.payment_method.interac_present.read_methodnullable enum

How card details were read in this transaction.

Possible enum values

contact_emv

Inserting a chip card into the card reader.

contactless_emv

Tapping a contactless-enabled chip card or mobile wallet.

contactless_magstripe_mode

Older standard for contactless payments that emulated a magnetic stripe read.

magnetic_stripe_fallback

When inserting a chip card fails three times in a row, fallback to a magnetic stripe read.

magnetic_stripe_track2

Swiping a card using the magnetic stripe reader.

last_setup_error.payment_method.kakao_paynullable object
If this is a kakao_pay PaymentMethod, this hash contains details about the Kakao Pay payment method.

last_setup_error.payment_method.klarnanullable object
If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.
- last_setup_error.payment_method.klarna.dobnullable objectExpandable
  The customer’s date of birth, if provided.
  last_setup_error.payment_method.klarna.dob.daynullable integer
  The day of birth, between 1 and 31.
  last_setup_error.payment_method.klarna.dob.monthnullable integer
  The month of birth, between 1 and 12.
  last_setup_error.payment_method.klarna.dob.yearnullable integer
  The four-digit year of birth.

last_setup_error.payment_method.konbininullable object
If this is a konbini PaymentMethod, this hash contains details about the Konbini payment method.

last_setup_error.payment_method.kr_cardnullable object
If this is a kr_card PaymentMethod, this hash contains details about the Korean Card payment method.
- last_setup_error.payment_method.kr_card.brandnullable enum
  The local credit or debit card brand.
  Possible enum values
  bc
  BC
  citi
  Citi
  hana
  Hana
  hyundai
  Hyundai
  jeju
  Jeju
  jeonbuk
  Jeonbuk
  kakaobank
  Kakao Bank
  kbank
  KBank
  kdbbank
  KDB Bank
  kookmin
  Kookmin
  Show 12 more
- last_setup_error.payment_method.kr_card.last4nullable string
  The last four digits of the card. This may not be present for American Express cards.

last_setup_error.payment_method.linknullable object
If this is an Link PaymentMethod, this hash contains details about the Link payment method.
- last_setup_error.payment_method.link.emailnullable string
  Account owner’s email address.

last_setup_error.payment_method.livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

last_setup_error.payment_method.metadatanullable object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

last_setup_error.payment_method.mobilepaynullable object
If this is a mobilepay PaymentMethod, this hash contains details about the MobilePay payment method.

last_setup_error.payment_method.multibanconullable object
If this is a multibanco PaymentMethod, this hash contains details about the Multibanco payment method.

last_setup_error.payment_method.naver_paynullable object
If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.
- last_setup_error.payment_method.naver_pay.buyer_idnullable string
  Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
- last_setup_error.payment_method.naver_pay.fundingenum
  Whether to fund this transaction with Naver Pay points or a card.
  Possible enum values
  card
  Use a card to fund this transaction.
  points
  Use Naver Pay points to fund this transaction.

last_setup_error.payment_method.nz_bank_accountnullable object
If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.
- last_setup_error.payment_method.nz_bank_account.account_holder_namenullable string
  The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.
- last_setup_error.payment_method.nz_bank_account.bank_codestring
  The numeric code for the bank account’s bank.
- last_setup_error.payment_method.nz_bank_account.bank_namestring
  The name of the bank.
- last_setup_error.payment_method.nz_bank_account.branch_codestring
  The numeric code for the bank account’s bank branch.
- last_setup_error.payment_method.nz_bank_account.last4string
  Last four digits of the bank account number.
- last_setup_error.payment_method.nz_bank_account.suffixnullable string
  The suffix of the bank account number.

last_setup_error.payment_method.oxxonullable object
If this is an oxxo PaymentMethod, this hash contains details about the OXXO payment method.

last_setup_error.payment_method.p24nullable object
If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.
- last_setup_error.payment_method.p24.banknullable enum
  The customer’s bank, if provided.

last_setup_error.payment_method.pay_by_banknullable object
If this is a pay_by_bank PaymentMethod, this hash contains details about the PayByBank payment method.

last_setup_error.payment_method.payconullable object
If this is a payco PaymentMethod, this hash contains details about the PAYCO payment method.

last_setup_error.payment_method.paynownullable object
If this is a paynow PaymentMethod, this hash contains details about the PayNow payment method.

last_setup_error.payment_method.paypalnullable object
If this is a paypal PaymentMethod, this hash contains details about the PayPal payment method.
- last_setup_error.payment_method.paypal.countrynullable string
  Two-letter ISO code representing the buyer’s country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
- last_setup_error.payment_method.paypal.payer_emailnullable string
  Owner’s email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
- last_setup_error.payment_method.paypal.payer_idnullable string
  PayPal account PayerID. This identifier uniquely identifies the PayPal customer.

last_setup_error.payment_method.pixnullable object
If this is a pix PaymentMethod, this hash contains details about the Pix payment method.

last_setup_error.payment_method.promptpaynullable object
If this is a promptpay PaymentMethod, this hash contains details about the PromptPay payment method.

last_setup_error.payment_method.radar_optionsnullable object
Options to configure Radar. See Radar Session for more information.
- last_setup_error.payment_method.radar_options.sessionnullable string
  A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.

last_setup_error.payment_method.revolut_paynullable object
If this is a revolut_pay PaymentMethod, this hash contains details about the Revolut Pay payment method.

last_setup_error.payment_method.samsung_paynullable object
If this is a samsung_pay PaymentMethod, this hash contains details about the SamsungPay payment method.

last_setup_error.payment_method.satispaynullable object
If this is a satispay PaymentMethod, this hash contains details about the Satispay payment method.

last_setup_error.payment_method.sepa_debitnullable object
If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.
- last_setup_error.payment_method.sepa_debit.bank_codenullable string
  Bank code of bank associated with the bank account.
- last_setup_error.payment_method.sepa_debit.branch_codenullable string
  Branch code of bank associated with the bank account.
- last_setup_error.payment_method.sepa_debit.countrynullable string
  Two-letter ISO code representing the country the bank account is located in.
- last_setup_error.payment_method.sepa_debit.fingerprintnullable string
  Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
- last_setup_error.payment_method.sepa_debit.generated_fromnullable object
  Information about the object that generated this PaymentMethod.
  last_setup_error.payment_method.sepa_debit.generated_from.chargenullable stringExpandable
  The ID of the Charge that generated this PaymentMethod, if any.
  last_setup_error.payment_method.sepa_debit.generated_from.setup_attemptnullable stringExpandable
  The ID of the SetupAttempt that generated this PaymentMethod, if any.
- last_setup_error.payment_method.sepa_debit.last4nullable string
  Last four characters of the IBAN.

last_setup_error.payment_method.sofortnullable object
If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.
- last_setup_error.payment_method.sofort.countrynullable string
  Two-letter ISO code representing the country the bank account is located in.

last_setup_error.payment_method.swishnullable object
If this is a swish PaymentMethod, this hash contains details about the Swish payment method.

last_setup_error.payment_method.twintnullable object
If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.

last_setup_error.payment_method.typeenum

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

Possible enum values

acss_debit

Pre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).

affirm

Affirm is a buy now, pay later payment method in the US.

afterpay_clearpay

Afterpay / Clearpay is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.

alipay

Alipay is a digital wallet payment method used in China.

alma

Alma is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments.

amazon_pay

Amazon Pay is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day.

au_becs_debit

BECS Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).

bacs_debit

Bacs Direct Debit is used to debit UK bank accounts.

bancontact

Bancontact is a bank redirect payment method used in Belgium.

billie

Billie is a payment method.

Show 40 more

last_setup_error.payment_method.us_bank_accountnullable object

If this is an us_bank_account PaymentMethod, this hash contains details about the US bank account payment method.

last_setup_error.payment_method.us_bank_account.account_holder_typenullable enum
Account holder type: individual or company.
Possible enum values
company
Account belongs to a company
individual
Account belongs to an individual

last_setup_error.payment_method.us_bank_account.account_typenullable enum
Account type: checkings or savings. Defaults to checking if omitted.
Possible enum values
checking
Bank account type is checking
savings
Bank account type is savings

last_setup_error.payment_method.us_bank_account.bank_namenullable string
The name of the bank.

last_setup_error.payment_method.us_bank_account.financial_connections_accountnullable string
The ID of the Financial Connections Account used to create the payment method.

last_setup_error.payment_method.us_bank_account.fingerprintnullable string
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

last_setup_error.payment_method.us_bank_account.last4nullable string
Last four digits of the bank account number.

last_setup_error.payment_method.us_bank_account.networksnullable object
Contains information about US bank account networks that can be used.
- last_setup_error.payment_method.us_bank_account.networks.preferrednullable string
  The preferred network.
- last_setup_error.payment_method.us_bank_account.networks.supportedarray of enums
  All supported networks.
  Possible enum values
  ach
  us_domestic_wire

last_setup_error.payment_method.us_bank_account.routing_numbernullable string
Routing number of the bank account.

last_setup_error.payment_method.us_bank_account.status_detailsnullable object

Contains information about the future reusability of this PaymentMethod.

last_setup_error.payment_method.us_bank_account.status_details.blockednullable object

Contains more information about the underlying block. This field will only be rendered if the PaymentMethod is blocked.

last_setup_error.payment_method.us_bank_account.status_details.blocked.network_codenullable enum

The ACH network code that resulted in this block.

Possible enum values

R02

Account Closed

R03

No Account, Unable to Locate Account

R04

Invalid Account Number Structure

R05

Unauthorized Debit to Consumer Account Using Corporate SEC Code

R07

Authorization Revoked By Consumer

R08

Payment Stopped

R10

Customer Advises Originator is Not Known to Receiver and/or Originator is Not Authorized by Receiver to Debit Receiver’s Account

R11

Customer Advises Entry Not in Accordance with the Terms of Authorization

R16

Account Frozen, Entry Returned Per OFAC Instructions

R20

Non-Transaction Account

Show 2 more

last_setup_error.payment_method.us_bank_account.status_details.blocked.reasonnullable enum

The reason why this PaymentMethod’s fingerprint has been blocked

Possible enum values

bank_account_closed

Bank account has been closed.

bank_account_frozen

Bank account has been frozen.

bank_account_invalid_details

Bank account details are incorrect. Please check the account number, routing number, account holder name, and account type.

bank_account_restricted

Bank account does not support debits.

bank_account_unusable

Bank account has been blocked by Stripe. Please contact Support.

debit_not_authorized

Customer has disputed a previous payment with their bank. If the network_code is R29, please confirm that Stripe’s Company IDs are allowlisted before attempting additional payments.

last_setup_error.payment_method.wechat_paynullable object
If this is an wechat_pay PaymentMethod, this hash contains details about the wechat_pay payment method.

last_setup_error.payment_method.zipnullable object
If this is a zip PaymentMethod, this hash contains details about the Zip payment method.

last_setup_error.payment_method_typenullable string
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.

last_setup_error.typeenum
The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error
Possible enum values
api_error
card_error
idempotency_error
invalid_request_error

metadatanullable object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

next_actionnullable objectretrievable with publishable key
If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
- next_action.cashapp_handle_redirect_or_display_qr_codenullable object
  The field that contains Cash App Pay QR code info
  next_action.cashapp_handle_redirect_or_display_qr_code.hosted_instructions_urlstring
  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.
  next_action.cashapp_handle_redirect_or_display_qr_code.mobile_auth_urlstring
  The url for mobile redirect based auth
  next_action.cashapp_handle_redirect_or_display_qr_code.qr_codeobject
  The field that contains CashApp QR code info
  next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.expires_attimestamp
  The date (unix timestamp) when the QR code expires.
  next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.image_url_pngstring
  The image_url_png string used to render QR code
  next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.image_url_svgstring
  The image_url_svg string used to render QR code
- next_action.redirect_to_urlnullable object
  Contains instructions for authenticating a payment by redirecting your customer to another page or application.
  next_action.redirect_to_url.return_urlnullable string
  If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.
  next_action.redirect_to_url.urlnullable string
  The URL you must redirect your customer to in order to authenticate.
- next_action.typestring
  Type of the next action to perform. Refer to the other child attributes under next_action for available values. Examples include: redirect_to_url, use_stripe_sdk, alipay_handle_redirect, oxxo_display_details, or verify_with_microdeposits.
- next_action.use_stripe_sdknullable object
  When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.
- next_action.verify_with_microdepositsnullable object
  Contains details describing microdeposits verification flow.
  next_action.verify_with_microdeposits.arrival_datetimestamp
  The timestamp when the microdeposits are expected to land.
  next_action.verify_with_microdeposits.hosted_verification_urlstring
  The URL for the hosted verification page, which allows customers to verify their bank account.
  next_action.verify_with_microdeposits.microdeposit_typenullable enum
  The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.

payment_methodnullable stringExpandableretrievable with publishable key
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 associated with the latest_attempt is attached to the Customer instead.

statusenumretrievable with publishable key
Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.
Possible enum values
canceled
processing
requires_action
requires_confirmation
requires_payment_method
succeeded

usagestringretrievable with publishable key
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.

More attributes

objectstringretrievable with publishable key
String representing the object’s type. Objects of the same type share the same value.

applicationnullable stringExpandableConnect only
ID of the Connect application that created the SetupIntent.

attach_to_selfnullable boolean
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.

cancellation_reasonnullable enumretrievable with publishable key
Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.
Possible enum values
abandoned
duplicate
requested_by_customer

createdtimestampretrievable with publishable key
Time at which the object was created. Measured in seconds since the Unix epoch.

flow_directionsnullable array of enums
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.
Possible enum values
inbound
outbound

latest_attemptnullable stringExpandable
The most recent SetupAttempt for this SetupIntent.

livemodebooleanretrievable with publishable key
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

mandatenullable stringExpandable
ID of the multi use Mandate generated by the SetupIntent.

on_behalf_ofnullable stringExpandableConnect only
The account (if any) for which the setup is intended.

payment_method_configuration_detailsnullable object
Information about the payment method configuration used for this Setup Intent.
- payment_method_configuration_details.idstring
  ID of the payment method configuration used.
- payment_method_configuration_details.parentnullable string
  ID of the parent payment method configuration used.

payment_method_optionsnullable object

Payment method-specific configuration for this SetupIntent.

payment_method_options.acss_debitnullable object
If the SetupIntent’s payment_method_types includes acss_debit, this hash contains the configurations that will be applied to each setup attempt of that type.
- payment_method_options.acss_debit.currencynullable enum
  Currency supported by the bank account
  Possible enum values
  cad
  Canadian dollars
  usd
  US dollars
- payment_method_options.acss_debit.mandate_optionsnullable object
  Additional fields for Mandate creation
  payment_method_options.acss_debit.mandate_options.custom_mandate_urlnullable string
  A URL for custom mandate text
  payment_method_options.acss_debit.mandate_options.default_fornullable array of enums
  List of Stripe products where this mandate can be selected automatically.
  Possible enum values
  invoice
  Enables payments for Stripe Invoices. ‘subscription’ must also be provided.
  subscription
  Enables payments for Stripe Subscriptions. ‘invoice’ must also be provided.
  payment_method_options.acss_debit.mandate_options.interval_descriptionnullable string
  Description of the interval. Only required if the ‘payment_schedule’ parameter is ‘interval’ or ‘combined’.
  payment_method_options.acss_debit.mandate_options.payment_schedulenullable enum
  Payment schedule for the mandate.
  Possible enum values
  combined
  Payments can be initiated at a pre-defined interval or sporadically
  interval
  Payments are initiated at a regular pre-defined interval
  sporadic
  Payments are initiated sporadically
  payment_method_options.acss_debit.mandate_options.transaction_typenullable enum
  Transaction type of the mandate.
  Possible enum values
  business
  Transactions are made for business reasons
  personal
  Transactions are made for personal reasons
- payment_method_options.acss_debit.verification_methodnullable enum
  Bank account verification method.
  Possible enum values
  automatic
  Instant verification with fallback to microdeposits.
  instant
  Instant verification.
  microdeposits
  Verification using microdeposits.

payment_method_options.amazon_paynullable object
If the SetupIntent’s payment_method_types includes amazon_pay, this hash contains the configurations that will be applied to each setup attempt of that type.

payment_method_options.bacs_debitnullable object
If the SetupIntent’s payment_method_types includes bacs_debit, this hash contains the configurations that will be applied to each setup attempt of that type.
- payment_method_options.bacs_debit.mandate_optionsnullable object
  Additional fields for Mandate creation
  payment_method_options.bacs_debit.mandate_options.reference_prefixnullable stringPreview feature
  Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: ‘/’, ‘_’, ‘-’, ‘&’, ‘.’. Cannot begin with ‘DDIC’ or ‘STRIPE’.

payment_method_options.cardnullable object

If the SetupIntent’s payment_method_types includes card, this hash contains the configurations that will be applied to each setup attempt of that type.

payment_method_options.card.mandate_optionsnullable object
Configuration options for setting up an eMandate for cards issued in India.
- payment_method_options.card.mandate_options.amountinteger
  Amount to be charged for future payments.
- payment_method_options.card.mandate_options.amount_typeenum
  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.
  Possible enum values
  fixed
  maximum
- payment_method_options.card.mandate_options.currencyenum
  Three-letter ISO currency code, in lowercase. Must be a supported currency.
- payment_method_options.card.mandate_options.descriptionnullable string
  A description of the mandate or subscription that is meant to be displayed to the customer.
- payment_method_options.card.mandate_options.end_datenullable timestamp
  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.
- payment_method_options.card.mandate_options.intervalenum
  Specifies payment frequency. One of day, week, month, year, or sporadic.
  Possible enum values
  day
  month
  sporadic
  week
  year
- payment_method_options.card.mandate_options.interval_countnullable integer
  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.
- payment_method_options.card.mandate_options.referencestring
  Unique identifier for the mandate or subscription.
- payment_method_options.card.mandate_options.start_datetimestamp
  Start date of the mandate or subscription. Start date should not be lesser than yesterday.
- payment_method_options.card.mandate_options.supported_typesnullable array of enums
  Specifies the type of mandates supported. Possible values are india.
  Possible enum values
  india

payment_method_options.card.networknullable enum
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.
Possible enum values
amex
cartes_bancaires
diners
discover
eftpos_au
girocard
interac
jcb
link
mastercard
Show 3 more

payment_method_options.card.request_three_d_securenullable enumadvanced

We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. 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 for more information on how this configuration interacts with Radar and our SCA Engine.

Possible enum values

any

Use any to manually request 3DS with a preference for a frictionless flow, increasing the likelihood of the authentication being completed without any additional input from the customer. 3DS will always be attempted if it is supported for the card, but Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

automatic

(Default) Our SCA Engine automatically prompts your customers for authentication based on risk level and other requirements.

challenge

Use challenge to request 3DS with a preference for a challenge flow, where the customer must respond to a prompt for active authentication. Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

payment_method_options.card_presentnullable object
If the SetupIntent’s payment_method_types includes card_present, this hash contains the configurations that will be applied to each setup attempt of that type.

payment_method_options.klarnanullable object
If the SetupIntent’s payment_method_types includes klarna, this hash contains the configurations that will be applied to each setup attempt of that type.
- payment_method_options.klarna.currencynullable enum
  The currency of the setup intent. Three letter ISO currency code.
- payment_method_options.klarna.preferred_localenullable string
  Preferred locale of the Klarna checkout page that the customer is redirected to.

payment_method_options.linknullable object
If the SetupIntent’s payment_method_types includes link, this hash contains the configurations that will be applied to each setup attempt of that type.

payment_method_options.paypalnullable object
If the SetupIntent’s payment_method_types includes paypal, this hash contains the configurations that will be applied to each setup attempt of that type.
- payment_method_options.paypal.billing_agreement_idnullable string
  The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.

payment_method_options.sepa_debitnullable object
If the SetupIntent’s payment_method_types includes sepa_debit, this hash contains the configurations that will be applied to each setup attempt of that type.
- payment_method_options.sepa_debit.mandate_optionsnullable object
  Additional fields for Mandate creation
  payment_method_options.sepa_debit.mandate_options.reference_prefixnullable stringPreview feature
  Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: ‘/’, ‘_’, ‘-’, ‘&’, ‘.’. Cannot begin with ‘STRIPE’.

payment_method_options.us_bank_accountnullable object

If the SetupIntent’s payment_method_types includes us_bank_account, this hash contains the configurations that will be applied to each setup attempt of that type.

payment_method_options.us_bank_account.financial_connectionsnullable object

Additional fields for Financial Connections Session creation

payment_method_options.us_bank_account.financial_connections.filtersnullable object
Filter the list of accounts that are allowed to be linked.
- payment_method_options.us_bank_account.financial_connections.filters.account_subcategoriesnullable array of enums
  The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.
  Possible enum values
  checking
  Bank account subcategory is checking
  savings
  Bank account subcategory is savings

payment_method_options.us_bank_account.financial_connections.permissionsnullable array of enums

The list of permissions to request. The payment_method permission must be included.

Possible enum values

balances

Allows accessing balance data from the account.

ownership

Allows accessing ownership data from the account.

payment_method

Allows the creation of a payment method from the account.

transactions

Allows accessing transactions data from the account.

payment_method_options.us_bank_account.financial_connections.prefetchnullable array of enums

Data features requested to be retrieved upon account creation.

Possible enum values

balances

Requests to prefetch balance data on accounts collected in this session.

ownership

Requests to prefetch ownership data on accounts collected in this session.

transactions

Requests to prefetch transaction data on accounts collected in this session.

payment_method_options.us_bank_account.financial_connections.return_urlnullable string
For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

payment_method_options.us_bank_account.mandate_optionsnullable object
Additional fields for Mandate creation
- payment_method_options.us_bank_account.mandate_options.collection_methodnullable enum
  Mandate collection method
  Possible enum values
  paper
  Mandate customer acceptance was collected using a paper document

payment_method_options.us_bank_account.verification_methodnullable enum

Bank account verification method.

Possible enum values

automatic

Instant verification with fallback to microdeposits.

instant

Instant verification only.

microdeposits

Verification using microdeposits. Cannot be used with Stripe Checkout, Hosted Invoices, or Payment Element.

payment_method_typesarray of stringsretrievable with publishable key
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.

single_use_mandatenullable stringExpandable
ID of the single_use Mandate generated by the SetupIntent.

The SetupIntent object

{
  "id": "seti_1Mm8s8LkdIwHu7ix0OXBfTRG",
  "object": "setup_intent",
  "application": null,
  "cancellation_reason": null,
  "client_secret": "seti_1Mm8s8LkdIwHu7ix0OXBfTRG_secret_NXDICkPqPeiBTAFqWmkbff09lRmSVXe",
  "created": 1678942624,
  "customer": null,
  "description": null,
  "flow_directions": null,
  "last_setup_error": null,
  "latest_attempt": null,
  "livemode": false,
  "mandate": null,
  "metadata": {},
  "next_action": null,
  "on_behalf_of": null,
  "payment_method": null,
  "payment_method_options": {
    "card": {
      "mandate_options": null,
      "network": null,
      "request_three_d_secure": "automatic"
    }
  },
  "payment_method_types": [
    "card"
  ],
  "single_use_mandate": null,
  "status": "requires_payment_method",
  "usage": "off_session"
}

The SetupIntent object

Attributes

idstringretrievable with publishable key

automatic_payment_methodsnullable object

automatic_payment_methods.allow_redirectsnullable enum

automatic_payment_methods.enablednullable boolean

client_secretnullable stringretrievable with publishable key

customernullable stringExpandable

descriptionnullable stringretrievable with publishable key

last_setup_errornullable objectretrievable with publishable key

last_setup_error.advice_codenullable string

last_setup_error.codenullable string

last_setup_error.decline_codenullable string

last_setup_error.doc_urlnullable string

last_setup_error.messagenullable string

last_setup_error.network_advice_codenullable string

last_setup_error.network_decline_codenullable string

last_setup_error.paramnullable string

last_setup_error.payment_methodnullable object

last_setup_error.payment_method.idstring

last_setup_error.payment_method.objectstring

last_setup_error.payment_method.acss_debitnullable object

last_setup_error.payment_method.acss_debit.bank_namenullable string

last_setup_error.payment_method.acss_debit.fingerprintnullable string

last_setup_error.payment_method.acss_debit.institution_numbernullable string

last_setup_error.payment_method.acss_debit.last4nullable string

last_setup_error.payment_method.acss_debit.transit_numbernullable string

last_setup_error.payment_method.affirmnullable object

last_setup_error.payment_method.afterpay_clearpaynullable object

last_setup_error.payment_method.alipaynullable object

last_setup_error.payment_method.allow_redisplaynullable enum

last_setup_error.payment_method.almanullable object

last_setup_error.payment_method.amazon_paynullable object

last_setup_error.payment_method.au_becs_debitnullable object

last_setup_error.payment_method.au_becs_debit.bsb_numbernullable string

last_setup_error.payment_method.au_becs_debit.fingerprintnullable string

last_setup_error.payment_method.au_becs_debit.last4nullable string

last_setup_error.payment_method.bacs_debitnullable object

last_setup_error.payment_method.bacs_debit.fingerprintnullable string

last_setup_error.payment_method.bacs_debit.last4nullable string

last_setup_error.payment_method.bacs_debit.sort_codenullable string

last_setup_error.payment_method.bancontactnullable object

last_setup_error.payment_method.billienullable object

last_setup_error.payment_method.billing_detailsobject

last_setup_error.payment_method.billing_details.addressnullable object

last_setup_error.payment_method.billing_details.address.citynullable string

last_setup_error.payment_method.billing_details.address.countrynullable string

last_setup_error.payment_method.billing_details.address.line1nullable string

last_setup_error.payment_method.billing_details.address.line2nullable string

last_setup_error.payment_method.billing_details.address.postal_codenullable string

last_setup_error.payment_method.billing_details.address.statenullable string

last_setup_error.payment_method.billing_details.emailnullable string

last_setup_error.payment_method.billing_details.namenullable string

last_setup_error.payment_method.billing_details.phonenullable string

last_setup_error.payment_method.billing_details.tax_idnullable string

last_setup_error.payment_method.bliknullable object

last_setup_error.payment_method.boletonullable object

last_setup_error.payment_method.boleto.tax_idstring

last_setup_error.payment_method.cardnullable object

last_setup_error.payment_method.card.brandstring

last_setup_error.payment_method.card.checksnullable object

last_setup_error.payment_method.card.checks.address_line1_checknullable string

last_setup_error.payment_method.card.checks.address_postal_code_checknullable string

last_setup_error.payment_method.card.checks.cvc_checknullable string

last_setup_error.payment_method.card.countrynullable string

last_setup_error.payment_method.card.display_brandnullable string

last_setup_error.payment_method.card.exp_monthinteger

last_setup_error.payment_method.card.exp_yearinteger

last_setup_error.payment_method.card.fingerprintnullable string

last_setup_error.payment_method.card.fundingstring

last_setup_error.payment_method.card.generated_fromnullable object

last_setup_error.payment_method.card.generated_from.chargenullable string

last_setup_error.payment_method.card.generated_from.payment_method_detailsnullable object

last_setup_error.payment_method.card.generated_from.payment_method_details.card_presentnullable object

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.amount_authorizednullable integer

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.brandnullable string

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.brand_productnullable string

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.capture_beforenullable timestamp

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.cardholder_namenullable string

last_setup_error.payment_method.card.generated_from.payment_method_details.card_present.countrynullable string