Skip to content

Stripe: Setup attempts schemas

10 Stripe schemas with complete fields and constraints.

← Setup attempts operations · All schemas

List all Setup Attempts — response body — data item

FieldTypePresenceDescription and constraints
$objectRootA SetupAttempt describes one attempted confirmation of a SetupIntent,
whether that confirmation is successful or unsuccessful. You can use
SetupAttempts to inspect details of a specific attempt at setting up a
payment method using a SetupIntent.
applicationJSONOptional
application (anyOf 1)JSONAlternativeThe value of [application](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.
application (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
application (anyOf 1) (anyOf 2)ModelAlternativeExpand PostApplicationFeesIdRefund — response body — application / object: application
application (anyOf 2)nullAlternative
attach_to_selfbooleanOptionalIf 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.
createdJSONRequired within parent
created (anyOf 1)integerAlternativeTime at which the object was created. Measured in seconds since the Unix epoch.
Format: unix-time
created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
customerJSONOptional
customer (anyOf 1)JSONAlternativeThe value of [customer](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.
customer (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
customer (anyOf 1) (anyOf 2)ModelAlternativeExpand Create a customer — response body
customer (anyOf 1) (anyOf 3)ModelAlternativeExpand Delete a customer — response body
customer (anyOf 2)nullAlternative
customer_accountJSONOptional
customer_account (anyOf 1)stringAlternativeThe value of [customer_account](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer_account) on the SetupIntent at the time of this confirmation.
Maximum length: 5000
customer_account (anyOf 2)nullAlternative
flow_directionsJSONOptional
flow_directions (anyOf 1)arrayAlternativeIndicates 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)[]stringEach itemKnown values: inbound, outbound
flow_directions (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the object.
Maximum length: 5000
livemodebooleanRequired within parentIf the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringRequired within parentString representing the object's type. Objects of the same type share the same value.
Known values: setup_attempt
on_behalf_ofJSONOptional
on_behalf_of (anyOf 1)JSONAlternativeThe value of [on_behalf_of](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.
on_behalf_of (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
on_behalf_of (anyOf 1) (anyOf 2)ModelAlternativeExpand Create an account — response body
on_behalf_of (anyOf 2)nullAlternative
payment_methodJSONRequired within parentID of the payment method used with this SetupAttempt.
payment_method (anyOf 1)stringAlternativeMaximum length: 5000
payment_method (anyOf 2)ModelAlternativeExpand Create a Payment Method — response body
payment_method_detailsModelRequired within parentExpand List all Setup Attempts — response body — data item payment method details
setup_errorJSONOptional
setup_error (anyOf 1)JSONAlternativeThe error encountered during this attempt to confirm the SetupIntent, if any.
setup_error (anyOf 1) (anyOf 1)ModelAlternativeExpand Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error
setup_error (anyOf 2)nullAlternative
setup_intentJSONRequired within parentID of the SetupIntent that this attempt belongs to.
setup_intent (anyOf 1)stringAlternativeMaximum length: 5000
setup_intent (anyOf 2)ModelAlternativeExpand Cancel a Setup Intent — response body
statusstringRequired within parentStatus of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.
Maximum length: 5000
usagestringRequired within parentThe value of [usage](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_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, Create a Payment Method — response body, List all Setup Attempts — response body — data item payment method details, Cancel a Setup Intent — response body

List all Setup Attempts — response body — data item payment method details

FieldTypePresenceDescription and constraints
$objectRoot
acss_debitModelOptionalExpand Create a Payment Method — response body — zip
amazon_payModelOptionalExpand Create a Payment Method — response body — zip
au_becs_debitModelOptionalExpand Create a Payment Method — response body — zip
bacs_debitModelOptionalExpand Create a Payment Method — response body — zip
bancontactModelOptionalExpand List all Setup Attempts — response body — data item payment method details bancontact
blikModelOptionalExpand Create a Payment Method — response body — blik
boletoModelOptionalExpand Create a Payment Method — response body — zip
cardModelOptionalExpand List all Setup Attempts — response body — data item payment method details card
card_presentModelOptionalExpand List all Setup Attempts — response body — data item payment method details card present
cashappModelOptionalExpand Create a Payment Method — response body — zip
idealModelOptionalExpand List all Setup Attempts — response body — data item payment method details ideal
kakao_payModelOptionalExpand Create a Payment Method — response body — zip
klarnaModelOptionalExpand Create a Payment Method — response body — zip
kr_cardModelOptionalExpand Create a Payment Method — response body — zip
linkModelOptionalExpand Create a Payment Method — response body — zip
naver_payModelOptionalExpand List all Setup Attempts — response body — data item payment method details naver pay
nz_bank_accountModelOptionalExpand Create a Payment Method — response body — zip
paypalModelOptionalExpand Create a Payment Method — response body — zip
paytoModelOptionalExpand Create a Payment Method — response body — zip
pixModelOptionalExpand Create a Payment Method — response body — pix
revolut_payModelOptionalExpand Create a Payment Method — response body — zip
satispayModelOptionalExpand Create a Payment Method — response body — zip
sepa_debitModelOptionalExpand Create a Payment Method — response body — zip
sofortModelOptionalExpand List all Setup Attempts — response body — data item payment method details sofort
twintModelOptionalExpand Create a Payment Method — response body — zip
typestringRequired within parentThe type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method.
Maximum length: 5000
upiModelOptionalExpand Create a Payment Method — response body — zip
us_bank_accountModelOptionalExpand Create a Payment Method — response body — zip

Referenced models: Create a Payment Method — response body — zip, Create a Payment Method — response body — blik, Create a Payment Method — response body — pix, List all Setup Attempts — response body — data item payment method details bancontact, List all Setup Attempts — response body — data item payment method details card, List all Setup Attempts — response body — data item payment method details card present, List all Setup Attempts — response body — data item payment method details ideal, List all Setup Attempts — response body — data item payment method details naver pay, List all Setup Attempts — response body — data item payment method details sofort

List all Setup Attempts — response body — data item payment method details bancontact

FieldTypePresenceDescription and constraints
$objectRoot
bank_codeJSONOptional
bank_code (anyOf 1)stringAlternativeBank code of bank associated with the bank account.
Maximum length: 5000
bank_code (anyOf 2)nullAlternative
bank_nameJSONOptional
bank_name (anyOf 1)stringAlternativeName of the bank associated with the bank account.
Maximum length: 5000
bank_name (anyOf 2)nullAlternative
bicJSONOptional
bic (anyOf 1)stringAlternativeBank Identifier Code of the bank associated with the bank account.
Maximum length: 5000
bic (anyOf 2)nullAlternative
generated_sepa_debitJSONOptional
generated_sepa_debit (anyOf 1)JSONAlternativeThe ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
generated_sepa_debit (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
generated_sepa_debit (anyOf 1) (anyOf 2)ModelAlternativeExpand Create a Payment Method — response body
generated_sepa_debit (anyOf 2)nullAlternative
generated_sepa_debit_mandateJSONOptional
generated_sepa_debit_mandate (anyOf 1)JSONAlternativeThe mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
generated_sepa_debit_mandate (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
generated_sepa_debit_mandate (anyOf 1) (anyOf 2)ModelAlternativeExpand Retrieve a Mandate — response body
generated_sepa_debit_mandate (anyOf 2)nullAlternative
iban_last4JSONOptional
iban_last4 (anyOf 1)stringAlternativeLast four characters of the IBAN.
Maximum length: 5000
iban_last4 (anyOf 2)nullAlternative
preferred_languageJSONOptional
preferred_language (anyOf 1)stringAlternativePreferred language of the Bancontact authorization page that the customer is redirected to.
Can be one of `en`, `de`, `fr`, or `nl`
Known values: de, en, fr, nl
preferred_language (anyOf 2)nullAlternative
verified_nameJSONOptional
verified_name (anyOf 1)stringAlternativeOwner's verified full name. Values are verified or provided by Bancontact directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
Maximum length: 5000
verified_name (anyOf 2)nullAlternative

Referenced models: Retrieve a Mandate — response body, Create a Payment Method — response body

List all Setup Attempts — response body — data item payment method details card

FieldTypePresenceDescription and constraints
$objectRoot
brandJSONOptional
brand (anyOf 1)stringAlternativeCard brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
Maximum length: 5000
brand (anyOf 2)nullAlternative
checksJSONOptional
checks (anyOf 1)JSONAlternativeCheck results by Card networks on Card address and CVC at the time of authorization
checks (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Payment Method — response body — card checks Checks on Card address and CVC if provided address line1 check, address postal code check, cvc check
checks (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternativeTwo-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.
Maximum length: 5000
country (anyOf 2)nullAlternative
exp_monthJSONOptional
exp_month (anyOf 1)JSONAlternative
exp_month (anyOf 1) (anyOf 1)integerAlternativeTwo-digit number representing the card's expiration month.
exp_month (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exp_month (anyOf 2)nullAlternative
exp_yearJSONOptional
exp_year (anyOf 1)JSONAlternative
exp_year (anyOf 1) (anyOf 1)integerAlternativeFour-digit number representing the card's expiration year.
exp_year (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
exp_year (anyOf 2)nullAlternative
fingerprintJSONOptional
fingerprint (anyOf 1)stringAlternativeUniquely 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.*
Maximum length: 5000
fingerprint (anyOf 2)nullAlternative
fundingJSONOptional
funding (anyOf 1)stringAlternativeCard funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
Maximum length: 5000
funding (anyOf 2)nullAlternative
last4JSONOptional
last4 (anyOf 1)stringAlternativeThe last four digits of the card.
Maximum length: 5000
last4 (anyOf 2)nullAlternative
networkJSONOptional
network (anyOf 1)stringAlternativeIdentifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`.
Maximum length: 5000
network (anyOf 2)nullAlternative
three_d_secureJSONOptional
three_d_secure (anyOf 1)JSONAlternativePopulated if this authorization used 3D Secure authentication.
three_d_secure (anyOf 1) (anyOf 1)ModelAlternativeExpand List all Setup Attempts — response body — data item payment method details card three d secure value authentication flow, electronic commerce indicator, result, result reason, transaction id, version
three_d_secure (anyOf 2)nullAlternative
walletJSONOptional
wallet (anyOf 1)JSONAlternativeIf this Card is part of a card wallet, this contains the details of the card wallet.
wallet (anyOf 1) (anyOf 1)ModelAlternativeExpand List all SetupAttempts — response body — data / item / payment_method_details / card / wallet / value / type: apple pay, google pay, link
wallet (anyOf 2)nullAlternative

Referenced models: Create a Payment Method — response body — card checks Checks on Card address and CVC if provided address line1 check, address postal code check, cvc check, List all SetupAttempts — response body — data / item / payment_method_details / card / wallet / value / type: apple pay, google pay, link, List all Setup Attempts — response body — data item payment method details card three d secure value authentication flow, electronic commerce indicator, result, result reason, transaction id, version

List all Setup Attempts — response body — data item payment method details card present

FieldTypePresenceDescription and constraints
$objectRoot
generated_cardJSONOptional
generated_card (anyOf 1)JSONAlternativeThe ID of the Card PaymentMethod which was generated by this SetupAttempt.
generated_card (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
generated_card (anyOf 1) (anyOf 2)ModelAlternativeExpand Create a Payment Method — response body
generated_card (anyOf 2)nullAlternative
offlineJSONOptional
offline (anyOf 1)JSONAlternativeDetails about payments collected offline.
offline (anyOf 1) (anyOf 1)ModelAlternativeExpand Create a Payment Method — response body — card present offline Details about payment methods collected offline stored at, type
offline (anyOf 2)nullAlternative

Referenced models: Create a Payment Method — response body, Create a Payment Method — response body — card present offline Details about payment methods collected offline stored at, type

List all Setup Attempts — response body — data item payment method details card three d secure value authentication flow, electronic commerce indicator, result, result reason, transaction id, version

FieldTypePresenceDescription and constraints
$objectRoot
authentication_flowJSONOptional
authentication_flow (anyOf 1)stringAlternativeFor authenticated transactions: how the customer was authenticated by
the issuing bank.
Known values: challenge, frictionless
authentication_flow (anyOf 2)nullAlternative
electronic_commerce_indicatorJSONOptional
electronic_commerce_indicator (anyOf 1)stringAlternativeThe Electronic Commerce Indicator (ECI). A protocol-level field
indicating what degree of authentication was performed.
Known values: 01, 02, 05, 06, 07
electronic_commerce_indicator (anyOf 2)nullAlternative
resultJSONOptional
result (anyOf 1)stringAlternativeIndicates the outcome of 3D Secure authentication.
Known values: attempt_acknowledged, authenticated, data_share_only, exempted, failed, not_supported, processing_error
result (anyOf 2)nullAlternative
result_reasonJSONOptional
result_reason (anyOf 1)stringAlternativeAdditional information about why 3D Secure succeeded or failed based
on the `result`.
Known values: abandoned, bypassed, canceled, card_not_enrolled, network_not_supported, protocol_error, rejected
result_reason (anyOf 2)nullAlternative
transaction_idJSONOptional
transaction_id (anyOf 1)stringAlternativeThe 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID
(dsTransId) for this payment.
Maximum length: 5000
transaction_id (anyOf 2)nullAlternative
versionJSONOptional
version (anyOf 1)stringAlternativeThe version of 3D Secure that was used.
Known values: 1.0.2, 2.1.0, 2.2.0, 2.3.0, 2.3.1
version (anyOf 2)nullAlternative

List all Setup Attempts — response body — data item payment method details ideal

FieldTypePresenceDescription and constraints
$objectRoot
bankJSONOptional
bank (anyOf 1)stringAlternativeThe customer's bank. Can be 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`, or `yoursafe`.
Known values: 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
bank (anyOf 2)nullAlternative
bicJSONOptional
bic (anyOf 1)stringAlternativeThe Bank Identifier Code of the customer's bank.
Known values: ABNANL2A, ADYBNL2A, ASNBNL21, BITSNL2A, BUNQNL2A, BUUTNL2A, FNOMNL22, FVLBNL22, HANDNL2A, INGBNL2A, KNABNL2H, MLLENL2A, MOYONL21, NNBANL2G, NTSBDEB1, RABONL2U, RBRBNL21, REVOIE23, REVOLT21, SNSBNL2A, TRIONL2U
bic (anyOf 2)nullAlternative
generated_sepa_debitJSONOptional
generated_sepa_debit (anyOf 1)JSONAlternativeThe ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
generated_sepa_debit (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
generated_sepa_debit (anyOf 1) (anyOf 2)ModelAlternativeExpand Create a Payment Method — response body
generated_sepa_debit (anyOf 2)nullAlternative
generated_sepa_debit_mandateJSONOptional
generated_sepa_debit_mandate (anyOf 1)JSONAlternativeThe mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
generated_sepa_debit_mandate (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
generated_sepa_debit_mandate (anyOf 1) (anyOf 2)ModelAlternativeExpand Retrieve a Mandate — response body
generated_sepa_debit_mandate (anyOf 2)nullAlternative
iban_last4JSONOptional
iban_last4 (anyOf 1)stringAlternativeLast four characters of the IBAN.
Maximum length: 5000
iban_last4 (anyOf 2)nullAlternative
verified_nameJSONOptional
verified_name (anyOf 1)stringAlternativeOwner's verified full name. Values are verified or provided by iDEAL directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
Maximum length: 5000
verified_name (anyOf 2)nullAlternative

Referenced models: Retrieve a Mandate — response body, Create a Payment Method — response body

List all Setup Attempts — response body — data item payment method details naver pay

FieldTypePresenceDescription and constraints
$objectRoot
buyer_idstringOptionalUniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
Maximum length: 5000

List all Setup Attempts — response body — data item payment method details sofort

FieldTypePresenceDescription and constraints
$objectRoot
bank_codeJSONOptional
bank_code (anyOf 1)stringAlternativeBank code of bank associated with the bank account.
Maximum length: 5000
bank_code (anyOf 2)nullAlternative
bank_nameJSONOptional
bank_name (anyOf 1)stringAlternativeName of the bank associated with the bank account.
Maximum length: 5000
bank_name (anyOf 2)nullAlternative
bicJSONOptional
bic (anyOf 1)stringAlternativeBank Identifier Code of the bank associated with the bank account.
Maximum length: 5000
bic (anyOf 2)nullAlternative
generated_sepa_debitJSONOptional
generated_sepa_debit (anyOf 1)JSONAlternativeThe ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
generated_sepa_debit (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
generated_sepa_debit (anyOf 1) (anyOf 2)ModelAlternativeExpand Create a Payment Method — response body
generated_sepa_debit (anyOf 2)nullAlternative
generated_sepa_debit_mandateJSONOptional
generated_sepa_debit_mandate (anyOf 1)JSONAlternativeThe mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.
generated_sepa_debit_mandate (anyOf 1) (anyOf 1)stringAlternativeMaximum length: 5000
generated_sepa_debit_mandate (anyOf 1) (anyOf 2)ModelAlternativeExpand Retrieve a Mandate — response body
generated_sepa_debit_mandate (anyOf 2)nullAlternative
iban_last4JSONOptional
iban_last4 (anyOf 1)stringAlternativeLast four characters of the IBAN.
Maximum length: 5000
iban_last4 (anyOf 2)nullAlternative
preferred_languageJSONOptional
preferred_language (anyOf 1)stringAlternativePreferred language of the Sofort authorization page that the customer is redirected to.
Can be one of `en`, `de`, `fr`, or `nl`
Known values: de, en, fr, nl
preferred_language (anyOf 2)nullAlternative
verified_nameJSONOptional
verified_name (anyOf 1)stringAlternativeOwner's verified full name. Values are verified or provided by Sofort directly
(if supported) at the time of authorization or settlement. They cannot be set or mutated.
Maximum length: 5000
verified_name (anyOf 2)nullAlternative

Referenced models: Retrieve a Mandate — response body, Create a Payment Method — response body

List all SetupAttempts — response body — data / item / payment_method_details / card / wallet / value / type: apple pay, google pay, link

FieldTypePresenceDescription and constraints
$objectRoot
apple_payModelOptionalExpand Create a Payment Method — response body — zip
google_payModelOptionalExpand Create a Payment Method — response body — zip
typestringRequired within parentThe type of the card wallet, one of `apple_pay`, `google_pay`, 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.
Known values: apple_pay, google_pay, link

Referenced models: Create a Payment Method — response body — zip

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.