The SetupAttempt object
Attributes
id(string) Unique identifier for the object.object(string) String representing the object’s type. Objects of the same type share the same value.application(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The value of application on the SetupIntent at the time of this confirmation.attach_to_self(boolean, nullable) 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(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.customer(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The value of customer on the SetupIntent at the time of this confirmation.customer_account(string, nullable) The value of customer_account on the SetupIntent at the time of this confirmation.flow_directions(array of enums, nullable) Indicates the directions of money movement for which this payment method is intended to be used.Include
inboundif you intend to use the payment method as the origin to pull funds from. Includeoutboundif 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:inboundoutbound
livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.on_behalf_of(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The value of on_behalf_of on the SetupIntent at the time of this confirmation.payment_method(string, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the payment method used with this SetupAttempt.payment_method_details(object) Details about the payment method at the time of SetupIntent confirmation.payment_method_details.acss_debit(object) If this is aacss_debitpayment method, this hash contains confirmation-specific information for theacss_debitpayment method.payment_method_details.amazon_pay(object) If this is aamazon_paypayment method, this hash contains confirmation-specific information for theamazon_paypayment method.payment_method_details.au_becs_debit(object) If this is aau_becs_debitpayment method, this hash contains confirmation-specific information for theau_becs_debitpayment method.payment_method_details.bacs_debit(object) If this is abacs_debitpayment method, this hash contains confirmation-specific information for thebacs_debitpayment method.payment_method_details.bancontact(object) If this is abancontactpayment method, this hash contains confirmation-specific information for thebancontactpayment method.payment_method_details.bancontact.bank_code(string, nullable) Bank code of bank associated with the bank account.payment_method_details.bancontact.bank_name(string, nullable) Name of the bank associated with the bank account.payment_method_details.bancontact.bic(string, nullable) Bank Identifier Code of the bank associated with the bank account.payment_method_details.bancontact.generated_sepa_debit(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.payment_method_details.bancontact.generated_sepa_debit_mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.payment_method_details.bancontact.iban_last4(string, nullable) Last four characters of the IBAN.payment_method_details.bancontact.preferred_language(enum, nullable) Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one ofen,de,fr, ornlPossible enum values:deenfrnl
payment_method_details.bancontact.verified_name(string, nullable) 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.
payment_method_details.boleto(object) If this is aboletopayment method, this hash contains confirmation-specific information for theboletopayment method.payment_method_details.card(object) If this is acardpayment method, this hash contains confirmation-specific information for thecardpayment method.payment_method_details.card.brand(string, nullable) Card brand. Can beamex,cartes_bancaires,diners,discover,eftpos_au,jcb,link,mastercard,unionpay,visaorunknown.payment_method_details.card.checks(object, nullable) Check results by Card networks on Card address and CVC at the time of authorizationpayment_method_details.card.checks.address_line1_check(string, nullable) If a address line1 was provided, results of the check, one ofpass,fail,unavailable, orunchecked.payment_method_details.card.checks.address_postal_code_check(string, nullable) If a address postal code was provided, results of the check, one ofpass,fail,unavailable, orunchecked.payment_method_details.card.checks.cvc_check(string, nullable) If a CVC was provided, results of the check, one ofpass,fail,unavailable, orunchecked.
payment_method_details.card.country(string, nullable) 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.payment_method_details.card.exp_month(integer, nullable) Two-digit number representing the card’s expiration month.payment_method_details.card.exp_year(integer, nullable) Four-digit number representing the card’s expiration year.payment_method_details.card.fingerprint(string, nullable) 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.
payment_method_details.card.funding(string, nullable) Card funding type. Can becredit,debit,prepaid, orunknown.payment_method_details.card.last4(string, nullable) The last four digits of the card.payment_method_details.card.network(string, nullable) Identifies which network this charge was processed on. Can beamex,cartes_bancaires,diners,discover,eftpos_au,interac,jcb,link,mastercard,unionpay,visa, orunknown.payment_method_details.card.three_d_secure(object, nullable) Populated if this authorization used 3D Secure authentication.payment_method_details.card.three_d_secure.authentication_flow(enum, nullable) For authenticated transactions: how the customer was authenticated by the issuing bank. Possible enum values:challengeThe issuing bank authenticated the customer by presenting a traditional challenge window.frictionlessThe issuing bank authenticated the customer via the 3DS2 frictionless flow.
payment_method_details.card.three_d_secure.electronic_commerce_indicator(enum, nullable) The Electronic Commerce Indicator (ECI). A protocol-level field indicating what degree of authentication was performed. Possible enum values:01Mastercard variant: Attempt acknowledged.02Mastercard variant: Fully authenticated.05Fully authenticated. The customer likely proved their identity to the issuing bank.06Attempt acknowledged. The customer, or the entire issuing bank, is not set up for 3D Secure. Or the issuing bank is experiencing an outage.Mastercard variant: Acquirer SCA exemption.
07Mastercard variant: Fully authenticated recurring transaction.
payment_method_details.card.three_d_secure.result(enum, nullable) Indicates the outcome of 3D Secure authentication. Possible enum values:attempt_acknowledgedThe issuing bank does not support 3D Secure, has not set up 3D Secure for the card, or is experiencing an outage. No authentication was performed, but the card network has provided proof of the attempt.In most cases the attempt qualifies for liability shift and it is safe to make a charge.
authenticated3D Secure authentication succeeded.exemptedA 3D Secure exemption has been applied to this transaction. Exemption may be requested for a number of reasons including merchant initiation, low value, or low risk.failedThe customer failed 3D Secure authentication.not_supported3D Secure authentication cannot be run on this card. Liability will generally not be shifted to the issuer.processing_errorThe issuing bank’s 3D Secure system is temporarily unavailable and the card network is unable to provide proof of the attempt. Liability will generally not be shifted to the issuer.
payment_method_details.card.three_d_secure.result_reason(enum, nullable) Additional information about why 3D Secure succeeded or failed based on theresult. Possible enum values:abandonedForfailed. The transaction timed out: the cardholder dropped off before completing authentication.bypassedForprocessing_error. Stripe bypassed 3D Secure because the issuing bank’s web-facing server was returning errors or timeouts to customers in the challenge window.canceledForfailed. The cardholder canceled authentication (where possible to identify).card_not_enrolledFornot_supported. The issuing bank does not support 3D Secure or has not set up 3D Secure for the card, and the card network did not provide proof of the attempt.This occurs when running 3D Secure on certain kinds of prepaid cards and in rare cases where the issuing bank is exempt from the requirement to support 3D Secure.
network_not_supportedFornot_supported. Stripe does not support 3D Secure on this card network.protocol_errorForprocessing_error. An invalid message was received from the card network or issuing bank. (Includes “downgrades” and similar errors).rejectedForfailed. The cardholder was redirected back from the issuing bank without completing authentication.
payment_method_details.card.three_d_secure.transaction_id(string, nullable) The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID (dsTransId) for this payment.payment_method_details.card.three_d_secure.version(enum, nullable) The version of 3D Secure that was used.
payment_method_details.card.wallet(object, nullable) If this Card is part of a card wallet, this contains the details of the card wallet.payment_method_details.card.wallet.apple_pay(object, nullable) If this is aapple_paycard wallet, this hash contains details about the wallet.payment_method_details.card.wallet.apple_pay.type(enum) Type of the apple_pay transaction, one ofapple_payorapple_pay_later. Possible enum values:apple_payapple_pay_later
payment_method_details.card.wallet.google_pay(object, nullable) If this is agoogle_paycard wallet, this hash contains details about the wallet.payment_method_details.card.wallet.type(enum) The type of the card wallet, one ofapple_pay,google_pay, orlink. 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:apple_paygoogle_paylink
payment_method_details.card_present(object) If this is acard_presentpayment method, this hash contains confirmation-specific information for thecard_presentpayment method.payment_method_details.card_present.generated_card(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The ID of the Card PaymentMethod which was generated by this SetupAttempt.payment_method_details.card_present.offline(object, nullable) Details about payments collected offline.payment_method_details.card_present.offline.stored_at(timestamp, nullable) Time at which the payment was collected while offlinepayment_method_details.card_present.offline.type(enum, nullable) The method used to process this payment method offline. Only deferred is allowed. Possible enum values:deferred
payment_method_details.cashapp(object) If this is acashapppayment method, this hash contains confirmation-specific information for thecashapppayment method.payment_method_details.ideal(object) If this is aidealpayment method, this hash contains confirmation-specific information for theidealpayment method.payment_method_details.ideal.bank(enum, nullable) The customer’s bank. Can be one ofabn_amro,adyen,asn_bank,bunq,buut,finom,handelsbanken,ing,knab,mollie,moneyou,n26,nn,rabobank,regiobank,revolut,sns_bank,triodos_bank,van_lanschot, oryoursafe. Possible enum values:abn_amroadyenasn_bankbunqbuutfinomhandelsbankeningknabmolliemoneyoun26nnrabobankregiobankrevolutsns_banktriodos_bankvan_lanschotyoursafe
payment_method_details.ideal.bic(enum, nullable) The Bank Identifier Code of the customer’s bank. Possible enum values:ABNANL2AADYBNL2AASNBNL21BITSNL2ABUNQNL2ABUUTNL2AFNOMNL22FVLBNL22HANDNL2AINGBNL2AKNABNL2HMLLENL2AMOYONL21NNBANL2GNTSBDEB1RABONL2URBRBNL21REVOIE23REVOLT21SNSBNL2ATRIONL2U
payment_method_details.ideal.generated_sepa_debit(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.payment_method_details.ideal.generated_sepa_debit_mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.payment_method_details.ideal.iban_last4(string, nullable) Last four characters of the IBAN.payment_method_details.ideal.verified_name(string, nullable) 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.
payment_method_details.kakao_pay(object) If this is akakao_paypayment method, this hash contains confirmation-specific information for thekakao_paypayment method.payment_method_details.klarna(object) If this is aklarnapayment method, this hash contains confirmation-specific information for theklarnapayment method.payment_method_details.kr_card(object) If this is akr_cardpayment method, this hash contains confirmation-specific information for thekr_cardpayment method.payment_method_details.link(object) If this is alinkpayment method, this hash contains confirmation-specific information for thelinkpayment method.payment_method_details.naver_pay(object) If this is anaver_paypayment method, this hash contains confirmation-specific information for thenaver_paypayment method.payment_method_details.naver_pay.buyer_id(string, nullable) Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
payment_method_details.nz_bank_account(object) If this is anz_bank_accountpayment method, this hash contains confirmation-specific information for thenz_bank_accountpayment method.payment_method_details.paypal(object) If this is apaypalpayment method, this hash contains confirmation-specific information for thepaypalpayment method.payment_method_details.payto(object) If this is apaytopayment method, this hash contains confirmation-specific information for thepaytopayment method.payment_method_details.pix(object) If this is apixpayment method, this hash contains confirmation-specific information for thepixpayment method.payment_method_details.revolut_pay(object) If this is arevolut_paypayment method, this hash contains confirmation-specific information for therevolut_paypayment method.payment_method_details.sepa_debit(object) If this is asepa_debitpayment method, this hash contains confirmation-specific information for thesepa_debitpayment method.payment_method_details.sofort(object) If this is asofortpayment method, this hash contains confirmation-specific information for thesofortpayment method.payment_method_details.sofort.bank_code(string, nullable) Bank code of bank associated with the bank account.payment_method_details.sofort.bank_name(string, nullable) Name of the bank associated with the bank account.payment_method_details.sofort.bic(string, nullable) Bank Identifier Code of the bank associated with the bank account.payment_method_details.sofort.generated_sepa_debit(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.payment_method_details.sofort.generated_sepa_debit_mandate(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt.payment_method_details.sofort.iban_last4(string, nullable) Last four characters of the IBAN.payment_method_details.sofort.preferred_language(enum, nullable) Preferred language of the Sofort authorization page that the customer is redirected to. Can be one ofen,de,fr, ornlPossible enum values:deenfrnl
payment_method_details.sofort.verified_name(string, nullable) 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.
payment_method_details.twint(object) If this is atwintpayment method, this hash contains confirmation-specific information for thetwintpayment method.payment_method_details.type(string) The type of the payment method used in the SetupIntent (e.g.,card). An additional hash is included onpayment_method_detailswith a name matching this value. It contains confirmation-specific information for the payment method.payment_method_details.upi(object) If this is aupipayment method, this hash contains confirmation-specific information for theupipayment method.payment_method_details.us_bank_account(object) If this is aus_bank_accountpayment method, this hash contains confirmation-specific information for theus_bank_accountpayment method.
setup_error(object, nullable) The error encountered during this attempt to confirm the SetupIntent, if any.setup_error.advice_code(string, nullable) For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.setup_error.code(string, nullable) For some errors that could be handled programmatically, a short string indicating the error code reported.setup_error.decline_code(string, nullable) 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.setup_error.doc_url(string, nullable) A URL to more information about the error code reported.setup_error.message(string, nullable) A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.setup_error.network_advice_code(string, nullable) 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.setup_error.network_decline_code(string, nullable) For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.setup_error.param(string, nullable) 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.setup_error.payment_method(object, nullable) The PaymentMethod object for errors returned on a request involving a PaymentMethod.setup_error.payment_method.id(string) Unique identifier for the object.setup_error.payment_method.object(string) String representing the object’s type. Objects of the same type share the same value.setup_error.payment_method.acss_debit(object, nullable) If this is anacss_debitPaymentMethod, this hash contains details about the ACSS Debit payment method.setup_error.payment_method.acss_debit.bank_name(string, nullable) Name of the bank associated with the bank account.setup_error.payment_method.acss_debit.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.setup_error.payment_method.acss_debit.institution_number(string, nullable) Institution number of the bank account.setup_error.payment_method.acss_debit.last4(string, nullable) Last four digits of the bank account number.setup_error.payment_method.acss_debit.transit_number(string, nullable) Transit number of the bank account.
setup_error.payment_method.affirm(object, nullable) If this is anaffirmPaymentMethod, this hash contains details about the Affirm payment method.setup_error.payment_method.afterpay_clearpay(object, nullable) If this is anAfterpayClearpayPaymentMethod, this hash contains details about the AfterpayClearpay payment method.setup_error.payment_method.alipay(object, nullable) If this is anAlipayPaymentMethod, this hash contains details about the Alipay payment method.setup_error.payment_method.allow_redisplay(enum, nullable) 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:alwaysUsealwaysto indicate that this payment method can always be shown to a customer in a checkout flow.limitedUselimitedto 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.unspecifiedThis is the default value for payment methods whereallow_redisplaywasn’t set.
setup_error.payment_method.alma(object, nullable) If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.setup_error.payment_method.amazon_pay(object, nullable) If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.setup_error.payment_method.au_becs_debit(object, nullable) If this is anau_becs_debitPaymentMethod, this hash contains details about the bank account.setup_error.payment_method.au_becs_debit.bsb_number(string, nullable) Six-digit number identifying bank and branch associated with this bank account.setup_error.payment_method.au_becs_debit.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.setup_error.payment_method.au_becs_debit.last4(string, nullable) Last four digits of the bank account number.
setup_error.payment_method.bacs_debit(object, nullable) If this is abacs_debitPaymentMethod, this hash contains details about the Bacs Direct Debit bank account.setup_error.payment_method.bacs_debit.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.setup_error.payment_method.bacs_debit.last4(string, nullable) Last four digits of the bank account number.setup_error.payment_method.bacs_debit.sort_code(string, nullable) Sort code of the bank account. (e.g.,10-20-30)
setup_error.payment_method.bancontact(object, nullable) If this is abancontactPaymentMethod, this hash contains details about the Bancontact payment method.setup_error.payment_method.billie(object, nullable) If this is abilliePaymentMethod, this hash contains details about the Billie payment method.setup_error.payment_method.billing_details(object) Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.setup_error.payment_method.billing_details.address(object, nullable) Billing address.setup_error.payment_method.billing_details.address.city(string, nullable) City, district, suburb, town, or village.setup_error.payment_method.billing_details.address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).setup_error.payment_method.billing_details.address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.setup_error.payment_method.billing_details.address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.setup_error.payment_method.billing_details.address.postal_code(string, nullable) ZIP or postal code.setup_error.payment_method.billing_details.address.state(string, nullable) State, county, province, or region (ISO 3166-2).
setup_error.payment_method.billing_details.email(string, nullable) Email address.setup_error.payment_method.billing_details.name(string, nullable) Full name.setup_error.payment_method.billing_details.phone(string, nullable) Billing phone number (including extension).setup_error.payment_method.billing_details.tax_id(string, nullable) Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.
setup_error.payment_method.blik(object, nullable) If this is ablikPaymentMethod, this hash contains details about the BLIK payment method.setup_error.payment_method.boleto(object, nullable) If this is aboletoPaymentMethod, this hash contains details about the Boleto payment method.setup_error.payment_method.boleto.tax_id(string) Uniquely identifies the customer tax id (CNPJ or CPF)
setup_error.payment_method.card(object, nullable) If this is acardPaymentMethod, this hash contains the user’s card details.setup_error.payment_method.card.brand(string) Card brand. Can beamex,cartes_bancaires,diners,discover,eftpos_au,jcb,link,mastercard,unionpay,visaorunknown.setup_error.payment_method.card.checks(object, nullable) Checks on Card address and CVC if provided.setup_error.payment_method.card.checks.address_line1_check(string, nullable) If a address line1 was provided, results of the check, one ofpass,fail,unavailable, orunchecked.setup_error.payment_method.card.checks.address_postal_code_check(string, nullable) If a address postal code was provided, results of the check, one ofpass,fail,unavailable, orunchecked.setup_error.payment_method.card.checks.cvc_check(string, nullable) If a CVC was provided, results of the check, one ofpass,fail,unavailable, orunchecked.
setup_error.payment_method.card.country(string, nullable) 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.setup_error.payment_method.card.display_brand(string, nullable) The brand to use when displaying the card, this accounts for customer’s brand choice on dual-branded cards. Can beamerican_express,cartes_bancaires,diners_club,discover,eftpos_australia,interac,jcb,mastercard,union_pay,visa, orotherand may contain more values in the future.setup_error.payment_method.card.exp_month(integer) Two-digit number representing the card’s expiration month.setup_error.payment_method.card.exp_year(integer) Four-digit number representing the card’s expiration year.setup_error.payment_method.card.fingerprint(string, nullable) 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.
setup_error.payment_method.card.funding(string) Card funding type. Can becredit,debit,prepaid, orunknown.setup_error.payment_method.card.generated_from(object, nullable) Details of the original PaymentMethod that created this object.setup_error.payment_method.card.generated_from.charge(string, nullable) The charge that created this object.setup_error.payment_method.card.generated_from.payment_method_details(object, nullable) Transaction-specific details of the payment method used in the payment.setup_error.payment_method.card.generated_from.payment_method_details.card_present(object, nullable) This hash contains the snapshot of thecard_presenttransaction-specific details which generated thiscardpayment method.setup_error.payment_method.card.generated_from.payment_method_details.card_present.amount_authorized(integer, nullable) The authorized amountsetup_error.payment_method.card.generated_from.payment_method_details.card_present.brand(string, nullable) Card brand. Can beamex,cartes_bancaires,diners,discover,eftpos_au,jcb,link,mastercard,unionpay,visaorunknown.setup_error.payment_method.card.generated_from.payment_method_details.card_present.brand_product(string, nullable) The product code that identifies the specific program or product associated with a card.setup_error.payment_method.card.generated_from.payment_method_details.card_present.capture_before(timestamp, nullable) When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.setup_error.payment_method.card.generated_from.payment_method_details.card_present.cardholder_name(string, nullable) 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.setup_error.payment_method.card.generated_from.payment_method_details.card_present.country(string, nullable) 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.setup_error.payment_method.card.generated_from.payment_method_details.card_present.description(string, nullable) A high-level description of the type of cards issued in this range.setup_error.payment_method.card.generated_from.payment_method_details.card_present.emv_auth_data(string, nullable) Authorization response cryptogram.setup_error.payment_method.card.generated_from.payment_method_details.card_present.exp_month(integer) Two-digit number representing the card’s expiration month.setup_error.payment_method.card.generated_from.payment_method_details.card_present.exp_year(integer) Four-digit number representing the card’s expiration year.setup_error.payment_method.card.generated_from.payment_method_details.card_present.fingerprint(string, nullable) 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.
setup_error.payment_method.card.generated_from.payment_method_details.card_present.funding(string, nullable) Card funding type. Can becredit,debit,prepaid, orunknown.setup_error.payment_method.card.generated_from.payment_method_details.card_present.generated_card(string, nullable) 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.setup_error.payment_method.card.generated_from.payment_method_details.card_present.incremental_authorization_supported(boolean) Whether this PaymentIntent is eligible for incremental authorizations. Request support using request_incremental_authorization_support.setup_error.payment_method.card.generated_from.payment_method_details.card_present.issuer(string, nullable) The name of the card’s issuing bank.setup_error.payment_method.card.generated_from.payment_method_details.card_present.last4(string, nullable) The last four digits of the card.setup_error.payment_method.card.generated_from.payment_method_details.card_present.location(string, nullable) ID of the location that this transaction’s reader is assigned to.setup_error.payment_method.card.generated_from.payment_method_details.card_present.network(string, nullable) Identifies which network this charge was processed on. Can beamex,cartes_bancaires,diners,discover,eftpos_au,interac,jcb,link,mastercard,unionpay,visa, orunknown.setup_error.payment_method.card.generated_from.payment_method_details.card_present.network_transaction_id(string, nullable) 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.setup_error.payment_method.card.generated_from.payment_method_details.card_present.offline(object, nullable) Details about payments collected offline.setup_error.payment_method.card.generated_from.payment_method_details.card_present.offline.stored_at(timestamp, nullable) Time at which the payment was collected while offlinesetup_error.payment_method.card.generated_from.payment_method_details.card_present.offline.type(enum, nullable) The method used to process this payment method offline. Only deferred is allowed. Possible enum values:deferred
setup_error.payment_method.card.generated_from.payment_method_details.card_present.overcapture_supported(boolean) Defines whether the authorized amount can be over-captured or notsetup_error.payment_method.card.generated_from.payment_method_details.card_present.preferred_locales(array of strings, nullable) 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.setup_error.payment_method.card.generated_from.payment_method_details.card_present.read_method(enum, nullable) How card details were read in this transaction. Possible enum values:contact_emvInserting a chip card into the card reader.contactless_emvTapping a contactless-enabled chip card or mobile wallet.contactless_magstripe_modeOlder standard for contactless payments that emulated a magnetic stripe read.magnetic_stripe_fallbackWhen inserting a chip card fails three times in a row, fallback to a magnetic stripe read.magnetic_stripe_track2Swiping a card using the magnetic stripe reader.
setup_error.payment_method.card.generated_from.payment_method_details.card_present.reader(string, nullable) ID of the reader this transaction was made on.setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt(object, nullable) A collection of fields required to be displayed on receipts. Only required for EMV transactions.setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.account_type(enum, nullable) The type of account being debited or credited Possible enum values:checkingA checking account, as when using a debit cardcreditA credit account, as when using a credit cardprepaidA prepaid account, as when using a debit gift cardunknownAn unknown account
setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.application_cryptogram(string, nullable) The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.application_preferred_name(string, nullable) 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.setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.authorization_code(string, nullable) Identifier for this transaction.setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.authorization_response_code(string, nullable) EMV tag 8A. A code returned by the card issuer.setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.cardholder_verification_method(string, nullable) 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, orsignature.setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.dedicated_file_name(string, nullable) Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.terminal_verification_results(string, nullable) 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.setup_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.transaction_status_information(string, nullable) An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.
setup_error.payment_method.card.generated_from.payment_method_details.card_present.wallet(object, nullable) If a mobile wallet was presented in the transaction, this contains the details of the mobile wallet.setup_error.payment_method.card.generated_from.payment_method_details.card_present.wallet.type(enum) The type of mobile wallet, one ofapple_pay,google_pay,samsung_pay, orunknown. Possible enum values:apple_payApple Pay is a mobile payment service by Apple.google_payGoogle Pay is a mobile payment service by Google.samsung_paySamsung Pay is a mobile payment service by Samsung Electronics.unknownThe wallet provider is unknown.
setup_error.payment_method.card.generated_from.payment_method_details.type(string) The type of payment method transaction-specific details from the transaction that generated thiscardpayment method. Alwayscard_present.
setup_error.payment_method.card.generated_from.setup_attempt(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The ID of the SetupAttempt that generated this PaymentMethod, if any.
setup_error.payment_method.card.last4(string) The last four digits of the card.setup_error.payment_method.card.networks(object, nullable) Contains information about card networks that can be used to process the payment.setup_error.payment_method.card.networks.available(array of strings) All networks available for selection via payment_method_options.card.network.setup_error.payment_method.card.networks.preferred(string, nullable) The preferred network for co-branded cards. Can becartes_bancaires,mastercard,visaorinvalid_preferenceif requested network is not valid for the card.
setup_error.payment_method.card.regulated_status(enum, nullable) Status of a card based on the card issuer. Possible enum values:regulatedThe card falls under a regulated account range.unregulatedThe card does not fall under a regulated account range.
setup_error.payment_method.card.three_d_secure_usage(object, nullable) Contains details on how this Card may be used for 3D Secure authentication.setup_error.payment_method.card.three_d_secure_usage.supported(boolean) Whether 3D Secure is supported on this card.
setup_error.payment_method.card.wallet(object, nullable) If this Card is part of a card wallet, this contains the details of the card wallet.setup_error.payment_method.card.wallet.amex_express_checkout(object, nullable) If this is aamex_express_checkoutcard wallet, this hash contains details about the wallet.setup_error.payment_method.card.wallet.apple_pay(object, nullable) If this is aapple_paycard wallet, this hash contains details about the wallet.setup_error.payment_method.card.wallet.dynamic_last4(string, nullable) (For tokenized numbers only.) The last four digits of the device account number.setup_error.payment_method.card.wallet.google_pay(object, nullable) If this is agoogle_paycard wallet, this hash contains details about the wallet.setup_error.payment_method.card.wallet.link(object, nullable) If this is alinkcard wallet, this hash contains details about the wallet.setup_error.payment_method.card.wallet.masterpass(object, nullable) If this is amasterpasscard wallet, this hash contains details about the wallet.setup_error.payment_method.card.wallet.masterpass.billing_address(object, nullable) 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.setup_error.payment_method.card.wallet.masterpass.billing_address.city(string, nullable) City, district, suburb, town, or village.setup_error.payment_method.card.wallet.masterpass.billing_address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).setup_error.payment_method.card.wallet.masterpass.billing_address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.setup_error.payment_method.card.wallet.masterpass.billing_address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.setup_error.payment_method.card.wallet.masterpass.billing_address.postal_code(string, nullable) ZIP or postal code.setup_error.payment_method.card.wallet.masterpass.billing_address.state(string, nullable) State, county, province, or region (ISO 3166-2).
setup_error.payment_method.card.wallet.masterpass.email(string, nullable) 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.setup_error.payment_method.card.wallet.masterpass.name(string, nullable) 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.setup_error.payment_method.card.wallet.masterpass.shipping_address(object, nullable) 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.setup_error.payment_method.card.wallet.masterpass.shipping_address.city(string, nullable) City, district, suburb, town, or village.setup_error.payment_method.card.wallet.masterpass.shipping_address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).setup_error.payment_method.card.wallet.masterpass.shipping_address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.setup_error.payment_method.card.wallet.masterpass.shipping_address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.setup_error.payment_method.card.wallet.masterpass.shipping_address.postal_code(string, nullable) ZIP or postal code.setup_error.payment_method.card.wallet.masterpass.shipping_address.state(string, nullable) State, county, province, or region (ISO 3166-2).
setup_error.payment_method.card.wallet.samsung_pay(object, nullable) If this is asamsung_paycard wallet, this hash contains details about the wallet.setup_error.payment_method.card.wallet.type(enum) The type of the card wallet, one ofamex_express_checkout,apple_pay,google_pay,masterpass,samsung_pay,visa_checkout, orlink. 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_checkoutapple_paygoogle_paylinkmasterpasssamsung_payvisa_checkout
setup_error.payment_method.card.wallet.visa_checkout(object, nullable) If this is avisa_checkoutcard wallet, this hash contains details about the wallet.setup_error.payment_method.card.wallet.visa_checkout.billing_address(object, nullable) 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.setup_error.payment_method.card.wallet.visa_checkout.billing_address.city(string, nullable) City, district, suburb, town, or village.setup_error.payment_method.card.wallet.visa_checkout.billing_address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).setup_error.payment_method.card.wallet.visa_checkout.billing_address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.setup_error.payment_method.card.wallet.visa_checkout.billing_address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.setup_error.payment_method.card.wallet.visa_checkout.billing_address.postal_code(string, nullable) ZIP or postal code.setup_error.payment_method.card.wallet.visa_checkout.billing_address.state(string, nullable) State, county, province, or region (ISO 3166-2).
setup_error.payment_method.card.wallet.visa_checkout.email(string, nullable) 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.setup_error.payment_method.card.wallet.visa_checkout.name(string, nullable) 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.setup_error.payment_method.card.wallet.visa_checkout.shipping_address(object, nullable) 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.setup_error.payment_method.card.wallet.visa_checkout.shipping_address.city(string, nullable) City, district, suburb, town, or village.setup_error.payment_method.card.wallet.visa_checkout.shipping_address.country(string, nullable) Two-letter country code (ISO 3166-1 alpha-2).setup_error.payment_method.card.wallet.visa_checkout.shipping_address.line1(string, nullable) Address line 1, such as the street, PO Box, or company name.setup_error.payment_method.card.wallet.visa_checkout.shipping_address.line2(string, nullable) Address line 2, such as the apartment, suite, unit, or building.setup_error.payment_method.card.wallet.visa_checkout.shipping_address.postal_code(string, nullable) ZIP or postal code.setup_error.payment_method.card.wallet.visa_checkout.shipping_address.state(string, nullable) State, county, province, or region (ISO 3166-2).
setup_error.payment_method.card_present(object, nullable) If this is acard_presentPaymentMethod, this hash contains details about the Card Present payment method.setup_error.payment_method.card_present.brand(string, nullable) Card brand. Can beamex,cartes_bancaires,diners,discover,eftpos_au,jcb,link,mastercard,unionpay,visaorunknown.setup_error.payment_method.card_present.brand_product(string, nullable) The product code that identifies the specific program or product associated with a card.setup_error.payment_method.card_present.cardholder_name(string, nullable) 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.setup_error.payment_method.card_present.country(string, nullable) 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.setup_error.payment_method.card_present.description(string, nullable) A high-level description of the type of cards issued in this range.setup_error.payment_method.card_present.exp_month(integer) Two-digit number representing the card’s expiration month.setup_error.payment_method.card_present.exp_year(integer) Four-digit number representing the card’s expiration year.setup_error.payment_method.card_present.fingerprint(string, nullable) 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.
setup_error.payment_method.card_present.funding(string, nullable) Card funding type. Can becredit,debit,prepaid, orunknown.setup_error.payment_method.card_present.issuer(string, nullable) The name of the card’s issuing bank.setup_error.payment_method.card_present.last4(string, nullable) The last four digits of the card.setup_error.payment_method.card_present.networks(object, nullable) Contains information about card networks that can be used to process the payment.setup_error.payment_method.card_present.networks.available(array of strings) All networks available for selection via payment_method_options.card.network.setup_error.payment_method.card_present.networks.preferred(string, nullable) The preferred network for the card.
setup_error.payment_method.card_present.offline(object, nullable) Details about payment methods collected offline.setup_error.payment_method.card_present.offline.stored_at(timestamp, nullable) Time at which the payment was collected while offlinesetup_error.payment_method.card_present.offline.type(enum, nullable) The method used to process this payment method offline. Only deferred is allowed. Possible enum values:deferred
setup_error.payment_method.card_present.preferred_locales(array of strings, nullable) 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.setup_error.payment_method.card_present.read_method(enum, nullable) How card details were read in this transaction. Possible enum values:contact_emvInserting a chip card into the card reader.contactless_emvTapping a contactless-enabled chip card or mobile wallet.contactless_magstripe_modeOlder standard for contactless payments that emulated a magnetic stripe read.magnetic_stripe_fallbackWhen inserting a chip card fails three times in a row, fallback to a magnetic stripe read.magnetic_stripe_track2Swiping a card using the magnetic stripe reader.
setup_error.payment_method.card_present.wallet(object, nullable) If a mobile wallet was presented in the transaction, this contains the details of the mobile wallet.setup_error.payment_method.card_present.wallet.type(enum) The type of mobile wallet, one ofapple_pay,google_pay,samsung_pay, orunknown. Possible enum values:apple_payApple Pay is a mobile payment service by Apple.google_payGoogle Pay is a mobile payment service by Google.samsung_paySamsung Pay is a mobile payment service by Samsung Electronics.unknownThe wallet provider is unknown.
setup_error.payment_method.cashapp(object, nullable) If this is acashappPaymentMethod, this hash contains details about the Cash App Pay payment method.setup_error.payment_method.cashapp.buyer_id(string, nullable) A unique and immutable identifier assigned by Cash App to every buyer.setup_error.payment_method.cashapp.cashtag(string, nullable) A public identifier for buyers using Cash App.
setup_error.payment_method.created(timestamp) Time at which the object was created. Measured in seconds since the Unix epoch.setup_error.payment_method.crypto(object, nullable) If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.setup_error.payment_method.custom(object, nullable) If this is acustomPaymentMethod, this hash contains details about the Custom payment method.setup_error.payment_method.custom.display_name(string, nullable) Display name of the Dashboard-only CustomPaymentMethodType.setup_error.payment_method.custom.logo(object, nullable) Contains information about the Dashboard-only CustomPaymentMethodType logo.setup_error.payment_method.custom.logo.content_type(string, nullable) Content type of the Dashboard-only CustomPaymentMethodType logo.setup_error.payment_method.custom.logo.url(string) URL of the Dashboard-only CustomPaymentMethodType logo.
setup_error.payment_method.custom.type(string) ID of the Dashboard-only CustomPaymentMethodType. Not expandable.
setup_error.payment_method.customer(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) 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.setup_error.payment_method.customer_balance(object, nullable) If this is acustomer_balancePaymentMethod, this hash contains details about the CustomerBalance payment method.setup_error.payment_method.eps(object, nullable) If this is anepsPaymentMethod, this hash contains details about the EPS payment method.setup_error.payment_method.eps.bank(enum, nullable) The customer’s bank. Should be one ofarzte_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, orvr_bank_braunau. Possible enum values:arzte_und_apotheker_bankaustrian_anadi_bank_agbank_austriabankhaus_carl_spanglerbankhaus_schelhammer_und_schattera_agbawag_psk_agbks_bank_agbrull_kallmus_bank_agbtv_vier_lander_bankcapital_bank_grawe_gruppe_agdeutsche_bank_agdolomitenbankeasybank_agerste_bank_und_sparkassenhypo_alpeadriabank_international_aghypo_bank_burgenland_aktiengesellschafthypo_noe_lb_fur_niederosterreich_u_wienhypo_oberosterreich_salzburg_steiermarkhypo_tirol_bank_aghypo_vorarlberg_bank_agmarchfelder_bankoberbank_agraiffeisen_bankengruppe_osterreichschoellerbank_agsparda_bank_wienvolksbank_gruppevolkskreditbank_agvr_bank_braunau
setup_error.payment_method.fpx(object, nullable) If this is anfpxPaymentMethod, this hash contains details about the FPX payment method.setup_error.payment_method.fpx.bank(enum) The customer’s bank, if provided. Can be one ofaffin_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, orbank_of_china. Possible enum values:affin_bankagrobankalliance_bankambankbank_islambank_muamalatbank_of_chinabank_rakyatbsncimbdeutsche_bankhong_leong_bankhsbckfhmaybank2emaybank2uocbcpb_enterprisepublic_bankrhbstandard_chartereduob
setup_error.payment_method.giropay(object, nullable) If this is agiropayPaymentMethod, this hash contains details about the Giropay payment method.setup_error.payment_method.grabpay(object, nullable) If this is agrabpayPaymentMethod, this hash contains details about the GrabPay payment method.setup_error.payment_method.ideal(object, nullable) If this is anidealPaymentMethod, this hash contains details about the iDEAL payment method.setup_error.payment_method.ideal.bank(enum, nullable) The customer’s bank, if provided. Can be one ofabn_amro,adyen,asn_bank,bunq,buut,finom,handelsbanken,ing,knab,mollie,moneyou,n26,nn,rabobank,regiobank,revolut,sns_bank,triodos_bank,van_lanschot, oryoursafe. Possible enum values:abn_amroadyenasn_bankbunqbuutfinomhandelsbankeningknabmolliemoneyoun26nnrabobankregiobankrevolutsns_banktriodos_bankvan_lanschotyoursafe
setup_error.payment_method.ideal.bic(enum, nullable) The Bank Identifier Code of the customer’s bank, if the bank was provided. Possible enum values:ABNANL2AADYBNL2AASNBNL21BITSNL2ABUNQNL2ABUUTNL2AFNOMNL22FVLBNL22HANDNL2AINGBNL2AKNABNL2HMLLENL2AMOYONL21NNBANL2GNTSBDEB1RABONL2URBRBNL21REVOIE23REVOLT21SNSBNL2ATRIONL2U
setup_error.payment_method.interac_present(object, nullable) If this is aninterac_presentPaymentMethod, this hash contains details about the Interac Present payment method.setup_error.payment_method.interac_present.brand(string, nullable) Card brand. Can beinterac,mastercardorvisa.setup_error.payment_method.interac_present.cardholder_name(string, nullable) 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.setup_error.payment_method.interac_present.country(string, nullable) 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.setup_error.payment_method.interac_present.description(string, nullable) A high-level description of the type of cards issued in this range.setup_error.payment_method.interac_present.exp_month(integer) Two-digit number representing the card’s expiration month.setup_error.payment_method.interac_present.exp_year(integer) Four-digit number representing the card’s expiration year.setup_error.payment_method.interac_present.fingerprint(string, nullable) 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.
setup_error.payment_method.interac_present.funding(string, nullable) Card funding type. Can becredit,debit,prepaid, orunknown.setup_error.payment_method.interac_present.issuer(string, nullable) The name of the card’s issuing bank.setup_error.payment_method.interac_present.last4(string, nullable) The last four digits of the card.setup_error.payment_method.interac_present.networks(object, nullable) Contains information about card networks that can be used to process the payment.setup_error.payment_method.interac_present.networks.available(array of strings) All networks available for selection via payment_method_options.card.network.setup_error.payment_method.interac_present.networks.preferred(string, nullable) The preferred network for the card.
setup_error.payment_method.interac_present.preferred_locales(array of strings, nullable) 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.setup_error.payment_method.interac_present.read_method(enum, nullable) How card details were read in this transaction. Possible enum values:contact_emvInserting a chip card into the card reader.contactless_emvTapping a contactless-enabled chip card or mobile wallet.contactless_magstripe_modeOlder standard for contactless payments that emulated a magnetic stripe read.magnetic_stripe_fallbackWhen inserting a chip card fails three times in a row, fallback to a magnetic stripe read.magnetic_stripe_track2Swiping a card using the magnetic stripe reader.
setup_error.payment_method.kakao_pay(object, nullable) If this is akakao_payPaymentMethod, this hash contains details about the Kakao Pay payment method.setup_error.payment_method.klarna(object, nullable) If this is aklarnaPaymentMethod, this hash contains details about the Klarna payment method.setup_error.payment_method.klarna.dob(object, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The customer’s date of birth, if provided.setup_error.payment_method.klarna.dob.day(integer, nullable) The day of birth, between 1 and 31.setup_error.payment_method.klarna.dob.month(integer, nullable) The month of birth, between 1 and 12.setup_error.payment_method.klarna.dob.year(integer, nullable) The four-digit year of birth.
setup_error.payment_method.konbini(object, nullable) If this is akonbiniPaymentMethod, this hash contains details about the Konbini payment method.setup_error.payment_method.kr_card(object, nullable) If this is akr_cardPaymentMethod, this hash contains details about the Korean Card payment method.setup_error.payment_method.kr_card.brand(enum, nullable) The local credit or debit card brand. Possible enum values:bcBCcitiCitihanaHanahyundaiHyundaijejuJejujeonbukJeonbukkakaobankKakao BankkbankKBankkdbbankKDB BankkookminKookminkwangjuKwangjulotteLottemgMGnhNGpostPostsamsungSamsungsavingsbankSavings BankshinhanShinhanshinhyupShinhyupsuhyupSuhyuptossbankToss BankwooriWoori
setup_error.payment_method.kr_card.last4(string, nullable) The last four digits of the card. This may not be present for American Express cards.The maximum length is 4 characters.
setup_error.payment_method.link(object, nullable) If this is anLinkPaymentMethod, this hash contains details about the Link payment method.setup_error.payment_method.link.email(string, nullable) Account owner’s email address.
setup_error.payment_method.livemode(boolean) If the object exists in live mode, the value istrue. If the object exists in test mode, the value isfalse.setup_error.payment_method.mb_way(object, nullable) If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.setup_error.payment_method.metadata(object, nullable) 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.setup_error.payment_method.mobilepay(object, nullable) If this is amobilepayPaymentMethod, this hash contains details about the MobilePay payment method.setup_error.payment_method.multibanco(object, nullable) If this is amultibancoPaymentMethod, this hash contains details about the Multibanco payment method.setup_error.payment_method.naver_pay(object, nullable) If this is anaver_payPaymentMethod, this hash contains details about the Naver Pay payment method.setup_error.payment_method.naver_pay.buyer_id(string, nullable) Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.setup_error.payment_method.naver_pay.funding(enum) Whether to fund this transaction with Naver Pay points or a card. Possible enum values:cardUse a card to fund this transaction.pointsUse Naver Pay points to fund this transaction.
setup_error.payment_method.nz_bank_account(object, nullable) If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method.setup_error.payment_method.nz_bank_account.account_holder_name(string, nullable) 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.setup_error.payment_method.nz_bank_account.bank_code(string) The numeric code for the bank account’s bank.setup_error.payment_method.nz_bank_account.bank_name(string) The name of the bank.setup_error.payment_method.nz_bank_account.branch_code(string) The numeric code for the bank account’s bank branch.setup_error.payment_method.nz_bank_account.last4(string) Last four digits of the bank account number.setup_error.payment_method.nz_bank_account.suffix(string, nullable) The suffix of the bank account number.
setup_error.payment_method.oxxo(object, nullable) If this is anoxxoPaymentMethod, this hash contains details about the OXXO payment method.setup_error.payment_method.p24(object, nullable) If this is ap24PaymentMethod, this hash contains details about the P24 payment method.setup_error.payment_method.p24.bank(enum, nullable) The customer’s bank, if provided.
setup_error.payment_method.pay_by_bank(object, nullable) If this is apay_by_bankPaymentMethod, this hash contains details about the PayByBank payment method.setup_error.payment_method.payco(object, nullable) If this is apaycoPaymentMethod, this hash contains details about the PAYCO payment method.setup_error.payment_method.paynow(object, nullable) If this is apaynowPaymentMethod, this hash contains details about the PayNow payment method.setup_error.payment_method.paypal(object, nullable) If this is apaypalPaymentMethod, this hash contains details about the PayPal payment method.setup_error.payment_method.paypal.country(string, nullable) 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.setup_error.payment_method.paypal.payer_email(string, nullable) Owner’s email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.setup_error.payment_method.paypal.payer_id(string, nullable) PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
setup_error.payment_method.paypay(object, nullable) If this is apaypayPaymentMethod, this hash contains details about the PayPay payment method.setup_error.payment_method.payto(object, nullable) If this is apaytoPaymentMethod, this hash contains details about the PayTo payment method.setup_error.payment_method.payto.bsb_number(string, nullable) Bank-State-Branch number of the bank account.setup_error.payment_method.payto.last4(string, nullable) Last four digits of the bank account number.setup_error.payment_method.payto.pay_id(string, nullable) The PayID alias for the bank account.
setup_error.payment_method.pix(object, nullable) If this is apixPaymentMethod, this hash contains details about the Pix payment method.setup_error.payment_method.promptpay(object, nullable) If this is apromptpayPaymentMethod, this hash contains details about the PromptPay payment method.setup_error.payment_method.radar_options(object, nullable) Options to configure Radar. See Radar Session for more information.setup_error.payment_method.radar_options.session(string, nullable) A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
setup_error.payment_method.revolut_pay(object, nullable) If this is arevolut_payPaymentMethod, this hash contains details about the Revolut Pay payment method.setup_error.payment_method.samsung_pay(object, nullable) If this is asamsung_payPaymentMethod, this hash contains details about the SamsungPay payment method.setup_error.payment_method.satispay(object, nullable) If this is asatispayPaymentMethod, this hash contains details about the Satispay payment method.setup_error.payment_method.sepa_debit(object, nullable) If this is asepa_debitPaymentMethod, this hash contains details about the SEPA debit bank account.setup_error.payment_method.sepa_debit.bank_code(string, nullable) Bank code of bank associated with the bank account.setup_error.payment_method.sepa_debit.branch_code(string, nullable) Branch code of bank associated with the bank account.setup_error.payment_method.sepa_debit.country(string, nullable) Two-letter ISO code representing the country the bank account is located in.setup_error.payment_method.sepa_debit.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.setup_error.payment_method.sepa_debit.generated_from(object, nullable) Information about the object that generated this PaymentMethod.setup_error.payment_method.sepa_debit.generated_from.charge(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The ID of the Charge that generated this PaymentMethod, if any.setup_error.payment_method.sepa_debit.generated_from.setup_attempt(string, nullable, expandable (can be expanded into an object with theexpandrequest parameter)) The ID of the SetupAttempt that generated this PaymentMethod, if any.
setup_error.payment_method.sepa_debit.last4(string, nullable) Last four characters of the IBAN.
setup_error.payment_method.sofort(object, nullable) If this is asofortPaymentMethod, this hash contains details about the SOFORT payment method.setup_error.payment_method.sofort.country(string, nullable) Two-letter ISO code representing the country the bank account is located in.
setup_error.payment_method.sunbit(object, nullable) If this is a Sunbit PaymentMethod, this hash contains details about the Sunbit payment method.setup_error.payment_method.swish(object, nullable) If this is aswishPaymentMethod, this hash contains details about the Swish payment method.setup_error.payment_method.twint(object, nullable) If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.setup_error.payment_method.type(enum) 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_debitPre-authorized debit payments are used to debit Canadian bank accounts through the Automated Clearing Settlement System (ACSS).affirmAffirm is a buy now, pay later payment method in the US.afterpay_clearpayAfterpay / Clearpay is a buy now, pay later payment method used in Australia, Canada, France, New Zealand, Spain, the UK, and the US.alipayAlipay is a digital wallet payment method used in China.almaAlma is a Buy Now, Pay Later payment method that lets customers pay in 2, 3, or 4 installments.amazon_payAmazon Pay is a Wallet payment method that lets hundreds of millions of Amazon customers pay their way, every day.au_becs_debitBECS Direct Debit is used to debit Australian bank accounts through the Bulk Electronic Clearing System (BECS).bacs_debitBacs Direct Debit is used to debit UK bank accounts.bancontactBancontact is a bank redirect payment method used in Belgium.billieBillie is a payment method.blikBLIK is a single-use payment method common in Poland.boletoBoleto is a voucher-based payment method used in Brazil.cardCard payments are supported through many networks, card brands, and select Link funding sources.card_presentStripe Terminal is used to collect in-person card payments.cashappCash App Pay enables customers to frictionlessly authenticate payments in the Cash App using their stored balance or linked card.cryptoStablecoin payments enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask.customCustom payment methods are user-defined payment methods that Stripe doesn’t process. You can’t use them in PaymentIntents or SetupIntents.customer_balanceUses a customer’s cash balance for the payment.epsEPS is an Austria-based bank redirect payment method.fpxFPX is a Malaysia-based bank redirect payment method.giropaygiropay is a German bank redirect payment method.grabpayGrabPay is a digital wallet payment method used in Southeast Asia.idealiDEAL is a Netherlands-based bank redirect payment method.interac_presentStripe Terminal accepts Interac debit cards for in-person payments in Canada.kakao_payKakao Pay is a digital wallet payment method used in South Korea.klarnaKlarna is a global buy now, pay later payment method.konbiniKonbini is a cash-based voucher payment method used in Japan.kr_cardKorean cards enables customers to accept local credit and debit cards in South Korea.linkLink allows customers to pay with their saved payment details.mb_wayMB WAY is a payment method.mobilepayMobilePay is a Nordic card-passthrough wallet payment method where customers authorize the payment in the MobilePay application.multibancoMultibanco is a voucher payment methodnaver_payNaver Pay is a digital wallet payment method used in South Korea.nz_bank_accountNew Zealand BECS Direct Debit is used to debit New Zealand bank accounts through the Bulk Electronic Clearing System (BECS).oxxoOXXO is a cash-based voucher payment method used in Mexico.p24Przelewy24 is a bank redirect payment method used in Poland.pay_by_bankPay By Bank is an open banking payment method in the UK.paycoPAYCO is a digital wallet payment method used in South Korea.paynowPayNow is a QR code payment method used in Singapore.paypalPayPal is an online wallet and redirect payment method commonly used in Europe.paypayPayPay is a payment method.paytoPayTo is a real time payment methodpixPix is an instant bank transfer payment method in Brazil.promptpayPromptPay is an instant funds transfer service popular in Thailand.revolut_payRevolut Pay is a digital wallet payment method used in the United Kingdom.samsung_paySamsung Pay is a digital wallet payment method used in South Korea.satispaySatispay is a payment method.sepa_debitSEPA Direct Debit is used to debit bank accounts within the Single Euro Payments Area (SEPA) region.sofortSofort is a bank redirect payment method used in Europe.sunbitSunbit is a payment method.swishSwish is a Swedish wallet payment method where customers authorize the payment in the Swish application.twintTWINT is a single-use payment method used in Switzerland.upiUPI is an instant real-time payment system in India.us_bank_accountACH Direct Debit is used to debit US bank accounts through the Automated Clearing House (ACH) payments system.wechat_payWeChat Pay is a digital wallet payment method based in China.zipZip is a Buy now, pay later Payment Method
setup_error.payment_method.upi(object, nullable) If this is aupiPaymentMethod, this hash contains details about the UPI payment method.setup_error.payment_method.upi.vpa(string, nullable) Customer’s unique Virtual Payment Address
setup_error.payment_method.us_bank_account(object, nullable) If this is anus_bank_accountPaymentMethod, this hash contains details about the US bank account payment method.setup_error.payment_method.us_bank_account.account_holder_type(enum, nullable) Account holder type: individual or company. Possible enum values:companyAccount belongs to a companyindividualAccount belongs to an individual
setup_error.payment_method.us_bank_account.account_type(enum, nullable) Account type: checkings or savings. Defaults to checking if omitted. Possible enum values:checkingBank account type is checkingsavingsBank account type is savings
setup_error.payment_method.us_bank_account.bank_name(string, nullable) The name of the bank.setup_error.payment_method.us_bank_account.financial_connections_account(string, nullable) The ID of the Financial Connections Account used to create the payment method.setup_error.payment_method.us_bank_account.fingerprint(string, nullable) Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.setup_error.payment_method.us_bank_account.last4(string, nullable) Last four digits of the bank account number.setup_error.payment_method.us_bank_account.networks(object, nullable) Contains information about US bank account networks that can be used.setup_error.payment_method.us_bank_account.networks.preferred(string, nullable) The preferred network.setup_error.payment_method.us_bank_account.networks.supported(array of enums) All supported networks. Possible enum values:achus_domestic_wire
setup_error.payment_method.us_bank_account.routing_number(string, nullable) Routing number of the bank account.setup_error.payment_method.us_bank_account.status_details(object, nullable) Contains information about the future reusability of this PaymentMethod.setup_error.payment_method.us_bank_account.status_details.blocked(object, nullable) Contains more information about the underlying block. This field will only be rendered if the PaymentMethod is blocked.setup_error.payment_method.us_bank_account.status_details.blocked.network_code(enum, nullable) The ACH network code that resulted in this block. Possible enum values:R02Account ClosedR03No Account, Unable to Locate AccountR04Invalid Account Number StructureR05Unauthorized Debit to Consumer Account Using Corporate SEC CodeR07Authorization Revoked By ConsumerR08Payment StoppedR10Customer Advises Originator is Not Known to Receiver and/or Originator is Not Authorized by Receiver to Debit Receiver’s AccountR11Customer Advises Entry Not in Accordance with the Terms of AuthorizationR16Account Frozen, Entry Returned Per OFAC InstructionsR20Non-Transaction AccountR29Corporate Customer Advises Not AuthorizedR31Permissible Return Entry (CCD and CTX only)
setup_error.payment_method.us_bank_account.status_details.blocked.reason(enum, nullable) The reason why this PaymentMethod’s fingerprint has been blocked Possible enum values:bank_account_closedBank account has been closed.bank_account_frozenBank account has been frozen.bank_account_invalid_detailsBank account details are incorrect. Please check the account number, routing number, account holder name, and account type.bank_account_restrictedBank account does not support debits.bank_account_unusableBank account has been blocked by Stripe. Please contact Support.debit_not_authorizedCustomer has disputed a previous payment with their bank. If thenetwork_codeis R29, please confirm that Stripe’s Company IDs are allowlisted before attempting additional payments.tokenized_account_number_deactivatedBank account’s tokenized account number is invalid. Please use a different account.
setup_error.payment_method.wechat_pay(object, nullable) If this is anwechat_payPaymentMethod, this hash contains details about the wechat_pay payment method.setup_error.payment_method.zip(object, nullable) If this is azipPaymentMethod, this hash contains details about the Zip payment method.
setup_error.payment_method_type(string, nullable) 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.setup_error.type(enum) The type of error returned. One ofapi_error,card_error,idempotency_error, orinvalid_request_errorPossible enum values:api_errorcard_erroridempotency_errorinvalid_request_error
setup_intent(string, expandable (can be expanded into an object with theexpandrequest parameter)) ID of the SetupIntent that this attempt belongs to.status(string) Status of this SetupAttempt, one ofrequires_confirmation,requires_action,processing,succeeded,failed, orabandoned.usage(string) The value of usage on the SetupIntent at the time of this confirmation, one ofoff_sessionoron_session.
The SetupAttempt object
json
{
"id": "setatt_1ErTsH2eZvKYlo2CI7ukcoF7",
"object": "setup_attempt",
"application": null,
"created": 1562004309,
"customer": null,
"flow_directions": null,
"livemode": false,
"on_behalf_of": null,
"payment_method": "pm_1ErTsG2eZvKYlo2CH0DNen59",
"payment_method_details": {
"card": {
"three_d_secure": null
},
"type": "card"
},
"setup_error": null,
"setup_intent": "seti_1ErTsG2eZvKYlo2CKaT8MITz",
"status": "succeeded",
"usage": "off_session"
}