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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
application | JSON | Optional | |
application (anyOf 1) | JSON | Alternative | The 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) | string | Alternative | Maximum length: 5000 |
application (anyOf 1) (anyOf 2) | Model | Alternative | Expand PostApplicationFeesIdRefund — response body — application / object: application |
application (anyOf 2) | null | Alternative | |
attach_to_self | boolean | Optional | If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer. |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
customer | JSON | Optional | |
customer (anyOf 1) | JSON | Alternative | The 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) | string | Alternative | Maximum length: 5000 |
customer (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a customer — response body |
customer (anyOf 1) (anyOf 3) | Model | Alternative | Expand Delete a customer — response body |
customer (anyOf 2) | null | Alternative | |
customer_account | JSON | Optional | |
customer_account (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
flow_directions | JSON | Optional | |
flow_directions (anyOf 1) | array | Alternative | Indicates the directions of money movement for which this payment method is intended to be used. Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes. |
flow_directions (anyOf 1)[] | string | Each item | Known values: inbound, outbound |
flow_directions (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: setup_attempt |
on_behalf_of | JSON | Optional | |
on_behalf_of (anyOf 1) | JSON | Alternative | The 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) | string | Alternative | Maximum length: 5000 |
on_behalf_of (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create an account — response body |
on_behalf_of (anyOf 2) | null | Alternative | |
payment_method | JSON | Required within parent | ID of the payment method used with this SetupAttempt. |
payment_method (anyOf 1) | string | Alternative | Maximum length: 5000 |
payment_method (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
payment_method_details | Model | Required within parent | Expand List all Setup Attempts — response body — data item payment method details |
setup_error | JSON | Optional | |
setup_error (anyOf 1) | JSON | Alternative | The error encountered during this attempt to confirm the SetupIntent, if any. |
setup_error (anyOf 1) (anyOf 1) | Model | Alternative | Expand Cancel a SetupIntent — response body — last_setup_error / value / type: api error, card error, idempotency error, invalid request error |
setup_error (anyOf 2) | null | Alternative | |
setup_intent | JSON | Required within parent | ID of the SetupIntent that this attempt belongs to. |
setup_intent (anyOf 1) | string | Alternative | Maximum length: 5000 |
setup_intent (anyOf 2) | Model | Alternative | Expand Cancel a Setup Intent — response body |
status | string | Required within parent | Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. Maximum length: 5000 |
usage | string | Required within parent | The 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_code | JSON | Optional | |
bank_code (anyOf 1) | string | Alternative | Bank code of bank associated with the bank account. Maximum length: 5000 |
bank_code (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the bank associated with the bank account. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | Bank Identifier Code of the bank associated with the bank account. Maximum length: 5000 |
bic (anyOf 2) | null | Alternative | |
generated_sepa_debit | JSON | Optional | |
generated_sepa_debit (anyOf 1) | JSON | Alternative | The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. |
generated_sepa_debit (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
generated_sepa_debit (anyOf 2) | null | Alternative | |
generated_sepa_debit_mandate | JSON | Optional | |
generated_sepa_debit_mandate (anyOf 1) | JSON | Alternative | The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. |
generated_sepa_debit_mandate (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit_mandate (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
generated_sepa_debit_mandate (anyOf 2) | null | Alternative | |
iban_last4 | JSON | Optional | |
iban_last4 (anyOf 1) | string | Alternative | Last four characters of the IBAN. Maximum length: 5000 |
iban_last4 (anyOf 2) | null | Alternative | |
preferred_language | JSON | Optional | |
preferred_language (anyOf 1) | string | Alternative | Preferred 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) | null | Alternative | |
verified_name | JSON | Optional | |
verified_name (anyOf 1) | string | Alternative | Owner'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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brand | JSON | Optional | |
brand (anyOf 1) | string | Alternative | Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. Maximum length: 5000 |
brand (anyOf 2) | null | Alternative | |
checks | JSON | Optional | |
checks (anyOf 1) | JSON | Alternative | Check results by Card networks on Card address and CVC at the time of authorization |
checks (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
exp_month | JSON | Optional | |
exp_month (anyOf 1) | JSON | Alternative | |
exp_month (anyOf 1) (anyOf 1) | integer | Alternative | Two-digit number representing the card's expiration month. |
exp_month (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_month (anyOf 2) | null | Alternative | |
exp_year | JSON | Optional | |
exp_year (anyOf 1) | JSON | Alternative | |
exp_year (anyOf 1) (anyOf 1) | integer | Alternative | Four-digit number representing the card's expiration year. |
exp_year (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_year (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | 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.* Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
funding | JSON | Optional | |
funding (anyOf 1) | string | Alternative | Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. Maximum length: 5000 |
funding (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | The last four digits of the card. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
network | JSON | Optional | |
network (anyOf 1) | string | Alternative | 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`. Maximum length: 5000 |
network (anyOf 2) | null | Alternative | |
three_d_secure | JSON | Optional | |
three_d_secure (anyOf 1) | JSON | Alternative | Populated if this authorization used 3D Secure authentication. |
three_d_secure (anyOf 1) (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
wallet | JSON | Optional | |
wallet (anyOf 1) | JSON | Alternative | If this Card is part of a card wallet, this contains the details of the card wallet. |
wallet (anyOf 1) (anyOf 1) | Model | Alternative | Expand List all SetupAttempts — response body — data / item / payment_method_details / card / wallet / value / type: apple pay, google pay, link |
wallet (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
generated_card | JSON | Optional | |
generated_card (anyOf 1) | JSON | Alternative | The ID of the Card PaymentMethod which was generated by this SetupAttempt. |
generated_card (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_card (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
generated_card (anyOf 2) | null | Alternative | |
offline | JSON | Optional | |
offline (anyOf 1) | JSON | Alternative | Details about payments collected offline. |
offline (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Payment Method — response body — card present offline Details about payment methods collected offline stored at, type |
offline (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authentication_flow | JSON | Optional | |
authentication_flow (anyOf 1) | string | Alternative | For authenticated transactions: how the customer was authenticated by the issuing bank. Known values: challenge, frictionless |
authentication_flow (anyOf 2) | null | Alternative | |
electronic_commerce_indicator | JSON | Optional | |
electronic_commerce_indicator (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
result | JSON | Optional | |
result (anyOf 1) | string | Alternative | Indicates the outcome of 3D Secure authentication. Known values: attempt_acknowledged, authenticated, data_share_only, exempted, failed, not_supported, processing_error |
result (anyOf 2) | null | Alternative | |
result_reason | JSON | Optional | |
result_reason (anyOf 1) | string | Alternative | Additional 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) | null | Alternative | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID (dsTransId) for this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative | |
version | JSON | Optional | |
version (anyOf 1) | string | Alternative | The 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) | null | Alternative |
List all Setup Attempts — response body — data item payment method details ideal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank | JSON | Optional | |
bank (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
generated_sepa_debit | JSON | Optional | |
generated_sepa_debit (anyOf 1) | JSON | Alternative | The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. |
generated_sepa_debit (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
generated_sepa_debit (anyOf 2) | null | Alternative | |
generated_sepa_debit_mandate | JSON | Optional | |
generated_sepa_debit_mandate (anyOf 1) | JSON | Alternative | The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. |
generated_sepa_debit_mandate (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit_mandate (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
generated_sepa_debit_mandate (anyOf 2) | null | Alternative | |
iban_last4 | JSON | Optional | |
iban_last4 (anyOf 1) | string | Alternative | Last four characters of the IBAN. Maximum length: 5000 |
iban_last4 (anyOf 2) | null | Alternative | |
verified_name | JSON | Optional | |
verified_name (anyOf 1) | string | Alternative | Owner'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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
buyer_id | string | Optional | Uniquely 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_code | JSON | Optional | |
bank_code (anyOf 1) | string | Alternative | Bank code of bank associated with the bank account. Maximum length: 5000 |
bank_code (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the bank associated with the bank account. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | Bank Identifier Code of the bank associated with the bank account. Maximum length: 5000 |
bic (anyOf 2) | null | Alternative | |
generated_sepa_debit | JSON | Optional | |
generated_sepa_debit (anyOf 1) | JSON | Alternative | The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. |
generated_sepa_debit (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
generated_sepa_debit (anyOf 2) | null | Alternative | |
generated_sepa_debit_mandate | JSON | Optional | |
generated_sepa_debit_mandate (anyOf 1) | JSON | Alternative | The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. |
generated_sepa_debit_mandate (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit_mandate (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
generated_sepa_debit_mandate (anyOf 2) | null | Alternative | |
iban_last4 | JSON | Optional | |
iban_last4 (anyOf 1) | string | Alternative | Last four characters of the IBAN. Maximum length: 5000 |
iban_last4 (anyOf 2) | null | Alternative | |
preferred_language | JSON | Optional | |
preferred_language (anyOf 1) | string | Alternative | Preferred 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) | null | Alternative | |
verified_name | JSON | Optional | |
verified_name (anyOf 1) | string | Alternative | Owner'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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
apple_pay | Model | Optional | Expand Create a Payment Method — response body — zip |
google_pay | Model | Optional | Expand Create a Payment Method — response body — zip |
type | string | Required within parent | The 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