The PaymentIntent object 

Attributes

• idstringretrievable with publishable key

  Unique identifier for the object.

• amountintegerretrievable with publishable key

  Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or equivalent in charge currency. The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

• automatic_payment_methodsnullable objectretrievable with publishable key

  Settings to configure compatible payment methods from the Stripe Dashboard

  Hide child attributes

  • automatic_payment_methods.allow_redirectsnullable enum

    Controls whether this PaymentIntent will accept redirect-based payment methods.

    Redirect-based payment methods may require your customer to be redirected to a payment method’s app or site for authentication or additional steps. To confirm this PaymentIntent, you may be required to provide a return_url to redirect customers back to your site after they authenticate or complete the payment.

    Possible enum values

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

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

  • automatic_payment_methods.enabledboolean

    Automatically calculates compatible payment methods

• client_secretnullable stringretrievable with publishable key

  The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key.

  The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

  Refer to our docs to accept a payment and learn about how client_secret should be handled.

• currencyenumretrievable with publishable key

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• customernullable stringExpandable

  ID of the Customer this PaymentIntent belongs to, if one exists.

  Payment methods attached to other Customers cannot be used with this PaymentIntent.

  If setup_future_usage is set and this PaymentIntent’s payment method is not card_present, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is card_present and isn’t a digital wallet, then a generated_card payment method representing the card is created and attached to the Customer instead.

• descriptionnullable stringretrievable with publishable key

  An arbitrary string attached to the object. Often useful for displaying to users.

• last_payment_errornullable objectretrievable with publishable key

  The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.

  Hide child attributes

  • last_payment_error.advice_codenullable string

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

  • last_payment_error.chargenullable string

    For card errors, the ID of the failed charge.

  • last_payment_error.codenullable string

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

  • last_payment_error.decline_codenullable string

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

  • last_payment_error.doc_urlnullable string

    A URL to more information about the error code reported.

  • last_payment_error.messagenullable string

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

  • last_payment_error.network_advice_codenullable string

    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.

  • last_payment_error.network_decline_codenullable string

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

  • last_payment_error.paramnullable string

    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

  • last_payment_error.payment_methodnullable object

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

    Hide child attributes

    • last_payment_error.payment_method.idstring

      Unique identifier for the object.

    • last_payment_error.payment_method.objectstring

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

    • last_payment_error.payment_method.acss_debitnullable object

      If this is an acss_debit PaymentMethod, this hash contains details about the ACSS Debit payment method.

      Hide child attributes

      • last_payment_error.payment_method.acss_debit.bank_namenullable string

        Name of the bank associated with the bank account.

      • last_payment_error.payment_method.acss_debit.fingerprintnullable string

        Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

      • last_payment_error.payment_method.acss_debit.institution_numbernullable string

        Institution number of the bank account.

      • last_payment_error.payment_method.acss_debit.last4nullable string

        Last four digits of the bank account number.

      • last_payment_error.payment_method.acss_debit.transit_numbernullable string

        Transit number of the bank account.

    • last_payment_error.payment_method.affirmnullable object

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

    • last_payment_error.payment_method.afterpay_clearpaynullable object

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

    • last_payment_error.payment_method.alipaynullable object

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

    • last_payment_error.payment_method.allow_redisplaynullable enum

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

      Possible enum values

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

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

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

    • last_payment_error.payment_method.almanullable object

      If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.

    • last_payment_error.payment_method.amazon_paynullable object

      If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.

    • last_payment_error.payment_method.au_becs_debitnullable object

      If this is an au_becs_debit PaymentMethod, this hash contains details about the bank account.

      Hide child attributes

      • last_payment_error.payment_method.au_becs_debit.bsb_numbernullable string

        Six-digit number identifying bank and branch associated with this bank account.

      • last_payment_error.payment_method.au_becs_debit.fingerprintnullable string

        Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

      • last_payment_error.payment_method.au_becs_debit.last4nullable string

        Last four digits of the bank account number.

    • last_payment_error.payment_method.bacs_debitnullable object

      If this is a bacs_debit PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.

      Hide child attributes

      • last_payment_error.payment_method.bacs_debit.fingerprintnullable string

        Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

      • last_payment_error.payment_method.bacs_debit.last4nullable string

        Last four digits of the bank account number.

      • last_payment_error.payment_method.bacs_debit.sort_codenullable string

        Sort code of the bank account. (e.g., 10-20-30)

    • last_payment_error.payment_method.bancontactnullable object

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

    • last_payment_error.payment_method.billienullable object

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

    • last_payment_error.payment_method.billing_detailsobject

      Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

      Hide child attributes

      • last_payment_error.payment_method.billing_details.addressnullable object

        Billing address.

        Hide child attributes

        • last_payment_error.payment_method.billing_details.address.citynullable string

          City, district, suburb, town, or village.

        • last_payment_error.payment_method.billing_details.address.countrynullable string

          Two-letter country code (ISO 3166-1 alpha-2).

        • last_payment_error.payment_method.billing_details.address.line1nullable string

          Address line 1 (e.g., street, PO Box, or company name).

        • last_payment_error.payment_method.billing_details.address.line2nullable string

          Address line 2 (e.g., apartment, suite, unit, or building).

        • last_payment_error.payment_method.billing_details.address.postal_codenullable string

          ZIP or postal code.

        • last_payment_error.payment_method.billing_details.address.statenullable string

          State, county, province, or region.

      • last_payment_error.payment_method.billing_details.emailnullable string

        Email address.

      • last_payment_error.payment_method.billing_details.namenullable string

        Full name.

      • last_payment_error.payment_method.billing_details.phonenullable string

        Billing phone number (including extension).

      • last_payment_error.payment_method.billing_details.tax_idnullable string

        Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers.

    • last_payment_error.payment_method.bliknullable object

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

    • last_payment_error.payment_method.boletonullable object

      If this is a boleto PaymentMethod, this hash contains details about the Boleto payment method.

      Hide child attributes

      • last_payment_error.payment_method.boleto.tax_idstring

        Uniquely identifies the customer tax id (CNPJ or CPF)

    • last_payment_error.payment_method.cardnullable object

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

      Hide child attributes

      • last_payment_error.payment_method.card.brandstring

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

      • last_payment_error.payment_method.card.checksnullable object

        Checks on Card address and CVC if provided.

        Hide child attributes

        • last_payment_error.payment_method.card.checks.address_line1_checknullable string

          If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked.

        • last_payment_error.payment_method.card.checks.address_postal_code_checknullable string

          If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked.

        • last_payment_error.payment_method.card.checks.cvc_checknullable string

          If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked.

      • last_payment_error.payment_method.card.countrynullable string

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

      • last_payment_error.payment_method.card.display_brandnullable string

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

      • last_payment_error.payment_method.card.exp_monthinteger

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

      • last_payment_error.payment_method.card.exp_yearinteger

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

      • last_payment_error.payment_method.card.fingerprintnullable string

        Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

        As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

      • last_payment_error.payment_method.card.fundingstring

        Card funding type. Can be credit, debit, prepaid, or unknown.

      • last_payment_error.payment_method.card.generated_fromnullable object

        Details of the original PaymentMethod that created this object.

        Hide child attributes

        • last_payment_error.payment_method.card.generated_from.chargenullable string

          The charge that created this object.

        • last_payment_error.payment_method.card.generated_from.payment_method_detailsnullable object

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

          Hide child attributes

          • last_payment_error.payment_method.card.generated_from.payment_method_details.card_presentnullable object

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

            Hide child attributes

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.amount_authorizednullable integer

              The authorized amount

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.brandnullable string

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

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.brand_productnullable string

              The product code that identifies the specific program or product associated with a card.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.capture_beforenullable timestamp

              When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.cardholder_namenullable string

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

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.countrynullable string

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

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.descriptionnullable string

              A high-level description of the type of cards issued in this range.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.emv_auth_datanullable string

              Authorization response cryptogram.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.exp_monthinteger

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

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.exp_yearinteger

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

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.fingerprintnullable string

              Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

              As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.fundingnullable string

              Card funding type. Can be credit, debit, prepaid, or unknown.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.generated_cardnullable string

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

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.incremental_authorization_supportedboolean

              Whether this PaymentIntent is eligible for incremental authorizations. Request support using request_incremental_authorization_support.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.issuernullable string

              The name of the card’s issuing bank.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.last4nullable string

              The last four digits of the card.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.networknullable string

              Identifies which network this charge was processed on. Can be amex, cartes_bancaires, diners, discover, eftpos_au, interac, jcb, link, mastercard, unionpay, visa, or unknown.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.network_transaction_idnullable string

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

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.offlinenullable object

              Details about payments collected offline.

              Hide child attributes

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.offline.stored_atnullable timestamp

                Time at which the payment was collected while offline

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.offline.typenullable enum

                The method used to process this payment method offline. Only deferred is allowed.

                Possible enum values

                deferred

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.overcapture_supportedboolean

              Defines whether the authorized amount can be over-captured or not

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.preferred_localesnullable array of strings

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

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.read_methodnullable enum

              How card details were read in this transaction.

              Possible enum values

              contact_emv Inserting a chip card into the card reader.

              contactless_emv Tapping a contactless-enabled chip card or mobile wallet.

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

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

              magnetic_stripe_track2 Swiping a card using the magnetic stripe reader.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.receiptnullable object

              A collection of fields required to be displayed on receipts. Only required for EMV transactions.

              Hide child attributes

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.account_typenullable enum

                The type of account being debited or credited

                Possible enum values

                checking A checking account, as when using a debit card

                credit A credit account, as when using a credit card

                prepaid A prepaid account, as when using a debit gift card

                unknown An unknown account

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.application_cryptogramnullable string

                The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers.

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.application_preferred_namenullable string

                The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card’s chip.

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.authorization_codenullable string

                Identifier for this transaction.

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.authorization_response_codenullable string

                EMV tag 8A. A code returned by the card issuer.

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.cardholder_verification_methodnullable string

                Describes the method used by the cardholder to verify ownership of the card. One of the following: approval, failure, none, offline_pin, offline_pin_and_signature, online_pin, or signature.

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.dedicated_file_namenullable string

                Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84.

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.terminal_verification_resultsnullable string

                A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95.

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.receipt.transaction_status_informationnullable string

                An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B.

            • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.walletnullable object

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

              Hide child attributes

              • last_payment_error.payment_method.card.generated_from.payment_method_details.card_present.wallet.typeenum

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

                Possible enum values

                apple_pay Apple Pay is a mobile payment service by Apple.

                google_pay Google Pay is a mobile payment service by Google.

                samsung_pay Samsung Pay is a mobile payment service by Samsung Electronics.

                unknown The wallet provider is unknown.

          • last_payment_error.payment_method.card.generated_from.payment_method_details.typestring

            The type of payment method transaction-specific details from the transaction that generated this card payment method. Always card_present.

        • last_payment_error.payment_method.card.generated_from.setup_attemptnullable stringExpandable

          The ID of the SetupAttempt that generated this PaymentMethod, if any.

      • last_payment_error.payment_method.card.last4string

        The last four digits of the card.

      • last_payment_error.payment_method.card.networksnullable object

        Contains information about card networks that can be used to process the payment.

        Hide child attributes

        • last_payment_error.payment_method.card.networks.availablearray of strings

          All networks available for selection via payment_method_options.card.network.

        • last_payment_error.payment_method.card.networks.preferrednullable string

          The preferred network for co-branded cards. Can be cartes_bancaires, mastercard, visa or invalid_preference if requested network is not valid for the card.

      • last_payment_error.payment_method.card.regulated_statusnullable enum

        Status of a card based on the card issuer.

        Possible enum values

        regulated The card falls under a regulated account range.

        unregulated The card does not fall under a regulated account range.

      • last_payment_error.payment_method.card.three_d_secure_usagenullable object

        Contains details on how this Card may be used for 3D Secure authentication.

        Hide child attributes

        • last_payment_error.payment_method.card.three_d_secure_usage.supportedboolean

          Whether 3D Secure is supported on this card.

      • last_payment_error.payment_method.card.walletnullable object

        If this Card is part of a card wallet, this contains the details of the card wallet.

        Hide child attributes

        • last_payment_error.payment_method.card.wallet.amex_express_checkoutnullable object

          If this is a amex_express_checkout card wallet, this hash contains details about the wallet.

        • last_payment_error.payment_method.card.wallet.apple_paynullable object

          If this is a apple_pay card wallet, this hash contains details about the wallet.

        • last_payment_error.payment_method.card.wallet.dynamic_last4nullable string

          (For tokenized numbers only.) The last four digits of the device account number.

        • last_payment_error.payment_method.card.wallet.google_paynullable object

          If this is a google_pay card wallet, this hash contains details about the wallet.

        • last_payment_error.payment_method.card.wallet.linknullable object

          If this is a link card wallet, this hash contains details about the wallet.

        • last_payment_error.payment_method.card.wallet.masterpassnullable object

          If this is a masterpass card wallet, this hash contains details about the wallet.

          Hide child attributes

          • last_payment_error.payment_method.card.wallet.masterpass.billing_addressnullable object

            Owner’s verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

            Hide child attributes

            • last_payment_error.payment_method.card.wallet.masterpass.billing_address.citynullable string

              City, district, suburb, town, or village.

            • last_payment_error.payment_method.card.wallet.masterpass.billing_address.countrynullable string

              Two-letter country code (ISO 3166-1 alpha-2).

            • last_payment_error.payment_method.card.wallet.masterpass.billing_address.line1nullable string

              Address line 1 (e.g., street, PO Box, or company name).

            • last_payment_error.payment_method.card.wallet.masterpass.billing_address.line2nullable string

              Address line 2 (e.g., apartment, suite, unit, or building).

            • last_payment_error.payment_method.card.wallet.masterpass.billing_address.postal_codenullable string

              ZIP or postal code.

            • last_payment_error.payment_method.card.wallet.masterpass.billing_address.statenullable string

              State, county, province, or region.

          • last_payment_error.payment_method.card.wallet.masterpass.emailnullable string

            Owner’s verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

          • last_payment_error.payment_method.card.wallet.masterpass.namenullable string

            Owner’s verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

          • last_payment_error.payment_method.card.wallet.masterpass.shipping_addressnullable object

            Owner’s verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

            Hide child attributes

            • last_payment_error.payment_method.card.wallet.masterpass.shipping_address.citynullable string

              City, district, suburb, town, or village.

            • last_payment_error.payment_method.card.wallet.masterpass.shipping_address.countrynullable string

              Two-letter country code (ISO 3166-1 alpha-2).

            • last_payment_error.payment_method.card.wallet.masterpass.shipping_address.line1nullable string

              Address line 1 (e.g., street, PO Box, or company name).

            • last_payment_error.payment_method.card.wallet.masterpass.shipping_address.line2nullable string

              Address line 2 (e.g., apartment, suite, unit, or building).

            • last_payment_error.payment_method.card.wallet.masterpass.shipping_address.postal_codenullable string

              ZIP or postal code.

            • last_payment_error.payment_method.card.wallet.masterpass.shipping_address.statenullable string

              State, county, province, or region.

        • last_payment_error.payment_method.card.wallet.samsung_paynullable object

          If this is a samsung_pay card wallet, this hash contains details about the wallet.

        • last_payment_error.payment_method.card.wallet.typeenum

          The type of the card wallet, one of amex_express_checkout, apple_pay, google_pay, masterpass, samsung_pay, visa_checkout, or link. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type.

          Possible enum values

          amex_express_checkout

          apple_pay

          google_pay

          link

          masterpass

          samsung_pay

          visa_checkout

        • last_payment_error.payment_method.card.wallet.visa_checkoutnullable object

          If this is a visa_checkout card wallet, this hash contains details about the wallet.

          Hide child attributes

          • last_payment_error.payment_method.card.wallet.visa_checkout.billing_addressnullable object

            Owner’s verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

            Hide child attributes

            • last_payment_error.payment_method.card.wallet.visa_checkout.billing_address.citynullable string

              City, district, suburb, town, or village.

            • last_payment_error.payment_method.card.wallet.visa_checkout.billing_address.countrynullable string

              Two-letter country code (ISO 3166-1 alpha-2).

            • last_payment_error.payment_method.card.wallet.visa_checkout.billing_address.line1nullable string

              Address line 1 (e.g., street, PO Box, or company name).

            • last_payment_error.payment_method.card.wallet.visa_checkout.billing_address.line2nullable string

              Address line 2 (e.g., apartment, suite, unit, or building).

            • last_payment_error.payment_method.card.wallet.visa_checkout.billing_address.postal_codenullable string

              ZIP or postal code.

            • last_payment_error.payment_method.card.wallet.visa_checkout.billing_address.statenullable string

              State, county, province, or region.

          • last_payment_error.payment_method.card.wallet.visa_checkout.emailnullable string

            Owner’s verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

          • last_payment_error.payment_method.card.wallet.visa_checkout.namenullable string

            Owner’s verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

          • last_payment_error.payment_method.card.wallet.visa_checkout.shipping_addressnullable object

            Owner’s verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

            Hide child attributes

            • last_payment_error.payment_method.card.wallet.visa_checkout.shipping_address.citynullable string

              City, district, suburb, town, or village.

            • last_payment_error.payment_method.card.wallet.visa_checkout.shipping_address.countrynullable string

              Two-letter country code (ISO 3166-1 alpha-2).

            • last_payment_error.payment_method.card.wallet.visa_checkout.shipping_address.line1nullable string

              Address line 1 (e.g., street, PO Box, or company name).

            • last_payment_error.payment_method.card.wallet.visa_checkout.shipping_address.line2nullable string

              Address line 2 (e.g., apartment, suite, unit, or building).

            • last_payment_error.payment_method.card.wallet.visa_checkout.shipping_address.postal_codenullable string

              ZIP or postal code.

            • last_payment_error.payment_method.card.wallet.visa_checkout.shipping_address.statenullable string

              State, county, province, or region.

    • last_payment_error.payment_method.card_presentnullable object

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

      Hide child attributes

      • last_payment_error.payment_method.card_present.brandnullable string

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

      • last_payment_error.payment_method.card_present.brand_productnullable string

        The product code that identifies the specific program or product associated with a card.

      • last_payment_error.payment_method.card_present.cardholder_namenullable string

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

      • last_payment_error.payment_method.card_present.countrynullable string

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

      • last_payment_error.payment_method.card_present.descriptionnullable string

        A high-level description of the type of cards issued in this range.

      • last_payment_error.payment_method.card_present.exp_monthinteger

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

      • last_payment_error.payment_method.card_present.exp_yearinteger

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

      • last_payment_error.payment_method.card_present.fingerprintnullable string

        Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

        As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

      • last_payment_error.payment_method.card_present.fundingnullable string

        Card funding type. Can be credit, debit, prepaid, or unknown.

      • last_payment_error.payment_method.card_present.issuernullable string

        The name of the card’s issuing bank.

      • last_payment_error.payment_method.card_present.last4nullable string

        The last four digits of the card.

      • last_payment_error.payment_method.card_present.networksnullable object

        Contains information about card networks that can be used to process the payment.

        Hide child attributes

        • last_payment_error.payment_method.card_present.networks.availablearray of strings

          All networks available for selection via payment_method_options.card.network.

        • last_payment_error.payment_method.card_present.networks.preferrednullable string

          The preferred network for the card.

      • last_payment_error.payment_method.card_present.offlinenullable object

        Details about payment methods collected offline.

        Hide child attributes

        • last_payment_error.payment_method.card_present.offline.stored_atnullable timestamp

          Time at which the payment was collected while offline

        • last_payment_error.payment_method.card_present.offline.typenullable enum

          The method used to process this payment method offline. Only deferred is allowed.

          Possible enum values

          deferred

      • last_payment_error.payment_method.card_present.preferred_localesnullable array of strings

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

      • last_payment_error.payment_method.card_present.read_methodnullable enum

        How card details were read in this transaction.

        Possible enum values

        contact_emv Inserting a chip card into the card reader.

        contactless_emv Tapping a contactless-enabled chip card or mobile wallet.

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

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

        magnetic_stripe_track2 Swiping a card using the magnetic stripe reader.

      • last_payment_error.payment_method.card_present.walletnullable object

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

        Hide child attributes

        • last_payment_error.payment_method.card_present.wallet.typeenum

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

          Possible enum values

          apple_pay Apple Pay is a mobile payment service by Apple.

          google_pay Google Pay is a mobile payment service by Google.

          samsung_pay Samsung Pay is a mobile payment service by Samsung Electronics.

          unknown The wallet provider is unknown.

    • last_payment_error.payment_method.cashappnullable object

      If this is a cashapp PaymentMethod, this hash contains details about the Cash App Pay payment method.

      Hide child attributes

      • last_payment_error.payment_method.cashapp.buyer_idnullable string

        A unique and immutable identifier assigned by Cash App to every buyer.

      • last_payment_error.payment_method.cashapp.cashtagnullable string

        A public identifier for buyers using Cash App.

    • last_payment_error.payment_method.createdtimestamp

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

    • last_payment_error.payment_method.cryptonullable object

      If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method.

    • last_payment_error.payment_method.customernullable stringExpandable

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

    • last_payment_error.payment_method.customer_balancenullable object

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

    • last_payment_error.payment_method.epsnullable object

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

      Hide child attributes

      • last_payment_error.payment_method.eps.banknullable enum

        The customer’s bank. Should be one of arzte_und_apotheker_bank, austrian_anadi_bank_ag, bank_austria, bankhaus_carl_spangler, bankhaus_schelhammer_und_schattera_ag, bawag_psk_ag, bks_bank_ag, brull_kallmus_bank_ag, btv_vier_lander_bank, capital_bank_grawe_gruppe_ag, deutsche_bank_ag, dolomitenbank, easybank_ag, erste_bank_und_sparkassen, hypo_alpeadriabank_international_ag, hypo_noe_lb_fur_niederosterreich_u_wien, hypo_oberosterreich_salzburg_steiermark, hypo_tirol_bank_ag, hypo_vorarlberg_bank_ag, hypo_bank_burgenland_aktiengesellschaft, marchfelder_bank, oberbank_ag, raiffeisen_bankengruppe_osterreich, schoellerbank_ag, sparda_bank_wien, volksbank_gruppe, volkskreditbank_ag, or vr_bank_braunau.

        Possible enum values

        arzte_und_apotheker_bank

        austrian_anadi_bank_ag

        bank_austria

        bankhaus_carl_spangler

        bankhaus_schelhammer_und_schattera_ag

        bawag_psk_ag

        bks_bank_ag

        brull_kallmus_bank_ag

        btv_vier_lander_bank

        capital_bank_grawe_gruppe_ag

        Show 18 more

    • last_payment_error.payment_method.fpxnullable object

      If this is an fpx PaymentMethod, this hash contains details about the FPX payment method.

      Hide child attributes

      • last_payment_error.payment_method.fpx.bankenum

        The customer’s bank, if provided. Can be one of affin_bank, agrobank, alliance_bank, ambank, bank_islam, bank_muamalat, bank_rakyat, bsn, cimb, hong_leong_bank, hsbc, kfh, maybank2u, ocbc, public_bank, rhb, standard_chartered, uob, deutsche_bank, maybank2e, pb_enterprise, or bank_of_china.

        Possible enum values

        affin_bank

        agrobank

        alliance_bank

        ambank

        bank_islam

        bank_muamalat

        bank_of_china

        bank_rakyat

        bsn

        cimb

        Show 12 more

    • last_payment_error.payment_method.giropaynullable object

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

    • last_payment_error.payment_method.grabpaynullable object

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

    • last_payment_error.payment_method.idealnullable object

      If this is an ideal PaymentMethod, this hash contains details about the iDEAL payment method.

      Hide child attributes

      • last_payment_error.payment_method.ideal.banknullable enum

        The customer’s bank, if provided. Can be one of abn_amro, asn_bank, bunq, buut, handelsbanken, ing, knab, moneyou, n26, nn, rabobank, regiobank, revolut, sns_bank, triodos_bank, van_lanschot, or yoursafe.

        Possible enum values

        abn_amro

        asn_bank

        bunq

        buut

        handelsbanken

        ing

        knab

        moneyou

        n26

        nn

        Show 7 more

      • last_payment_error.payment_method.ideal.bicnullable enum

        The Bank Identifier Code of the customer’s bank, if the bank was provided.

        Possible enum values

        ABNANL2A

        ASNBNL21

        BITSNL2A

        BUNQNL2A

        BUUTNL2A

        FVLBNL22

        HANDNL2A

        INGBNL2A

        KNABNL2H

        MOYONL21

        Show 8 more

    • last_payment_error.payment_method.interac_presentnullable objectPreview feature

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

      Hide child attributes

      • last_payment_error.payment_method.interac_present.brandnullable string

        Card brand. Can be interac, mastercard or visa.

      • last_payment_error.payment_method.interac_present.cardholder_namenullable string

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

      • last_payment_error.payment_method.interac_present.countrynullable string

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

      • last_payment_error.payment_method.interac_present.descriptionnullable string

        A high-level description of the type of cards issued in this range.

      • last_payment_error.payment_method.interac_present.exp_monthinteger

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

      • last_payment_error.payment_method.interac_present.exp_yearinteger

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

      • last_payment_error.payment_method.interac_present.fingerprintnullable string

        Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

        As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

      • last_payment_error.payment_method.interac_present.fundingnullable string

        Card funding type. Can be credit, debit, prepaid, or unknown.

      • last_payment_error.payment_method.interac_present.issuernullable string

        The name of the card’s issuing bank.

      • last_payment_error.payment_method.interac_present.last4nullable string

        The last four digits of the card.

      • last_payment_error.payment_method.interac_present.networksnullable object

        Contains information about card networks that can be used to process the payment.

        Hide child attributes

        • last_payment_error.payment_method.interac_present.networks.availablearray of strings

          All networks available for selection via payment_method_options.card.network.

        • last_payment_error.payment_method.interac_present.networks.preferrednullable string

          The preferred network for the card.

      • last_payment_error.payment_method.interac_present.preferred_localesnullable array of strings

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

      • last_payment_error.payment_method.interac_present.read_methodnullable enum

        How card details were read in this transaction.

        Possible enum values

        contact_emv Inserting a chip card into the card reader.

        contactless_emv Tapping a contactless-enabled chip card or mobile wallet.

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

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

        magnetic_stripe_track2 Swiping a card using the magnetic stripe reader.

    • last_payment_error.payment_method.kakao_paynullable object

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

    • last_payment_error.payment_method.klarnanullable object

      If this is a klarna PaymentMethod, this hash contains details about the Klarna payment method.

      Hide child attributes

      • last_payment_error.payment_method.klarna.dobnullable objectExpandable

        The customer’s date of birth, if provided.

        Hide child attributes

        • last_payment_error.payment_method.klarna.dob.daynullable integer

          The day of birth, between 1 and 31.

        • last_payment_error.payment_method.klarna.dob.monthnullable integer

          The month of birth, between 1 and 12.

        • last_payment_error.payment_method.klarna.dob.yearnullable integer

          The four-digit year of birth.

    • last_payment_error.payment_method.konbininullable object

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

    • last_payment_error.payment_method.kr_cardnullable object

      If this is a kr_card PaymentMethod, this hash contains details about the Korean Card payment method.

      Hide child attributes

      • last_payment_error.payment_method.kr_card.brandnullable enum

        The local credit or debit card brand.

        Possible enum values

        bc BC

        citi Citi

        hana Hana

        hyundai Hyundai

        jeju Jeju

        jeonbuk Jeonbuk

        kakaobank Kakao Bank

        kbank KBank

        kdbbank KDB Bank

        kookmin Kookmin

        Show 12 more

      • last_payment_error.payment_method.kr_card.last4nullable string

        The last four digits of the card. This may not be present for American Express cards.

    • last_payment_error.payment_method.linknullable object

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

      Hide child attributes

      • last_payment_error.payment_method.link.emailnullable string

        Account owner’s email address.

    • last_payment_error.payment_method.livemodeboolean

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

    • last_payment_error.payment_method.metadatanullable object

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

    • last_payment_error.payment_method.mobilepaynullable object

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

    • last_payment_error.payment_method.multibanconullable object

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

    • last_payment_error.payment_method.naver_paynullable object

      If this is a naver_pay PaymentMethod, this hash contains details about the Naver Pay payment method.

      Hide child attributes

      • last_payment_error.payment_method.naver_pay.buyer_idnullable string

        Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.

      • last_payment_error.payment_method.naver_pay.fundingenum

        Whether to fund this transaction with Naver Pay points or a card.

        Possible enum values

        card Use a card to fund this transaction.

        points Use Naver Pay points to fund this transaction.

    • last_payment_error.payment_method.nz_bank_accountnullable object

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

      Hide child attributes

      • last_payment_error.payment_method.nz_bank_account.account_holder_namenullable string

        The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details.

      • last_payment_error.payment_method.nz_bank_account.bank_codestring

        The numeric code for the bank account’s bank.

      • last_payment_error.payment_method.nz_bank_account.bank_namestring

        The name of the bank.

      • last_payment_error.payment_method.nz_bank_account.branch_codestring

        The numeric code for the bank account’s bank branch.

      • last_payment_error.payment_method.nz_bank_account.last4string

        Last four digits of the bank account number.

      • last_payment_error.payment_method.nz_bank_account.suffixnullable string

        The suffix of the bank account number.

    • last_payment_error.payment_method.oxxonullable object

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

    • last_payment_error.payment_method.p24nullable object

      If this is a p24 PaymentMethod, this hash contains details about the P24 payment method.

      Hide child attributes

      • last_payment_error.payment_method.p24.banknullable enum

        The customer’s bank, if provided.

    • last_payment_error.payment_method.pay_by_banknullable object

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

    • last_payment_error.payment_method.payconullable object

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

    • last_payment_error.payment_method.paynownullable object

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

    • last_payment_error.payment_method.paypalnullable object

      If this is a paypal PaymentMethod, this hash contains details about the PayPal payment method.

      Hide child attributes

      • last_payment_error.payment_method.paypal.countrynullable string

        Two-letter ISO code representing the buyer’s country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

      • last_payment_error.payment_method.paypal.payer_emailnullable string

        Owner’s email. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.

      • last_payment_error.payment_method.paypal.payer_idnullable string

        PayPal account PayerID. This identifier uniquely identifies the PayPal customer.

    • last_payment_error.payment_method.pixnullable object

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

    • last_payment_error.payment_method.promptpaynullable object

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

    • last_payment_error.payment_method.radar_optionsnullable object

      Options to configure Radar. See Radar Session for more information.

      Hide child attributes

      • last_payment_error.payment_method.radar_options.sessionnullable string

        A Radar Session is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.

    • last_payment_error.payment_method.revolut_paynullable object

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

    • last_payment_error.payment_method.samsung_paynullable object

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

    • last_payment_error.payment_method.satispaynullable object

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

    • last_payment_error.payment_method.sepa_debitnullable object

      If this is a sepa_debit PaymentMethod, this hash contains details about the SEPA debit bank account.

      Hide child attributes

      • last_payment_error.payment_method.sepa_debit.bank_codenullable string

        Bank code of bank associated with the bank account.

      • last_payment_error.payment_method.sepa_debit.branch_codenullable string

        Branch code of bank associated with the bank account.

      • last_payment_error.payment_method.sepa_debit.countrynullable string

        Two-letter ISO code representing the country the bank account is located in.

      • last_payment_error.payment_method.sepa_debit.fingerprintnullable string

        Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

      • last_payment_error.payment_method.sepa_debit.generated_fromnullable object

        Information about the object that generated this PaymentMethod.

        Hide child attributes

        • last_payment_error.payment_method.sepa_debit.generated_from.chargenullable stringExpandable

          The ID of the Charge that generated this PaymentMethod, if any.

        • last_payment_error.payment_method.sepa_debit.generated_from.setup_attemptnullable stringExpandable

          The ID of the SetupAttempt that generated this PaymentMethod, if any.

      • last_payment_error.payment_method.sepa_debit.last4nullable string

        Last four characters of the IBAN.

    • last_payment_error.payment_method.sofortnullable object

      If this is a sofort PaymentMethod, this hash contains details about the SOFORT payment method.

      Hide child attributes

      • last_payment_error.payment_method.sofort.countrynullable string

        Two-letter ISO code representing the country the bank account is located in.

    • last_payment_error.payment_method.swishnullable object

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

    • last_payment_error.payment_method.twintnullable object

      If this is a TWINT PaymentMethod, this hash contains details about the TWINT payment method.

    • last_payment_error.payment_method.typeenum

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

      Possible enum values

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

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

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

      alipay Alipay is a digital wallet payment method used in China.

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

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

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

      bacs_debit Bacs Direct Debit is used to debit UK bank accounts.

      bancontact Bancontact is a bank redirect payment method used in Belgium.

      billie Billie is a payment method.

      Show 40 more

    • last_payment_error.payment_method.us_bank_accountnullable object

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

      Hide child attributes

      • last_payment_error.payment_method.us_bank_account.account_holder_typenullable enum

        Account holder type: individual or company.

        Possible enum values

        company Account belongs to a company

        individual Account belongs to an individual

      • last_payment_error.payment_method.us_bank_account.account_typenullable enum

        Account type: checkings or savings. Defaults to checking if omitted.

        Possible enum values

        checking Bank account type is checking

        savings Bank account type is savings

      • last_payment_error.payment_method.us_bank_account.bank_namenullable string

        The name of the bank.

      • last_payment_error.payment_method.us_bank_account.financial_connections_accountnullable string

        The ID of the Financial Connections Account used to create the payment method.

      • last_payment_error.payment_method.us_bank_account.fingerprintnullable string

        Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

      • last_payment_error.payment_method.us_bank_account.last4nullable string

        Last four digits of the bank account number.

      • last_payment_error.payment_method.us_bank_account.networksnullable object

        Contains information about US bank account networks that can be used.

        Hide child attributes

        • last_payment_error.payment_method.us_bank_account.networks.preferrednullable string

          The preferred network.

        • last_payment_error.payment_method.us_bank_account.networks.supportedarray of enums

          All supported networks.

          Possible enum values

          ach

          us_domestic_wire

      • last_payment_error.payment_method.us_bank_account.routing_numbernullable string

        Routing number of the bank account.

      • last_payment_error.payment_method.us_bank_account.status_detailsnullable object

        Contains information about the future reusability of this PaymentMethod.

        Hide child attributes

        • last_payment_error.payment_method.us_bank_account.status_details.blockednullable object

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

          Hide child attributes

          • last_payment_error.payment_method.us_bank_account.status_details.blocked.network_codenullable enum

            The ACH network code that resulted in this block.

            Possible enum values

            R02 Account Closed

            R03 No Account, Unable to Locate Account

            R04 Invalid Account Number Structure

            R05 Unauthorized Debit to Consumer Account Using Corporate SEC Code

            R07 Authorization Revoked By Consumer

            R08 Payment Stopped

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

            R11 Customer Advises Entry Not in Accordance with the Terms of Authorization

            R16 Account Frozen, Entry Returned Per OFAC Instructions

            R20 Non-Transaction Account

            Show 2 more

          • last_payment_error.payment_method.us_bank_account.status_details.blocked.reasonnullable enum

            The reason why this PaymentMethod’s fingerprint has been blocked

            Possible enum values

            bank_account_closed Bank account has been closed.

            bank_account_frozen Bank account has been frozen.

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

            bank_account_restricted Bank account does not support debits.

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

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

    • last_payment_error.payment_method.wechat_paynullable object

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

    • last_payment_error.payment_method.zipnullable object

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

  • last_payment_error.payment_method_typenullable string

    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

  • last_payment_error.sourcenullable object

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

    Hide child attributes

    • last_payment_error.source.idstring

      Unique identifier for the object.

    • last_payment_error.source.objectstring

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

    • last_payment_error.source.accountnullable stringExpandableAvailable conditionally

      The account this card belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an External Account where controller.is_controller is true.

    • last_payment_error.source.address_citynullable string

      City/District/Suburb/Town/Village.

    • last_payment_error.source.address_countrynullable string

      Billing address country, if provided when creating card.

    • last_payment_error.source.address_line1nullable string

      Address line 1 (Street address/PO Box/Company name).

    • last_payment_error.source.address_line1_checknullable string

      If address_line1 was provided, results of the check: pass, fail, unavailable, or unchecked.

    • last_payment_error.source.address_line2nullable string

      Address line 2 (Apartment/Suite/Unit/Building).

    • last_payment_error.source.address_statenullable string

      State/County/Province/Region.

    • last_payment_error.source.address_zipnullable string

      ZIP or postal code.

    • last_payment_error.source.address_zip_checknullable string

      If address_zip was provided, results of the check: pass, fail, unavailable, or unchecked.

    • last_payment_error.source.allow_redisplaynullable enum

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

      Possible enum values

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

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

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

    • last_payment_error.source.available_payout_methodsnullable array of enums

      A set of available payout methods for this card. Only values from this set should be passed as the method when creating a payout.

      Possible enum values

      instant

      standard

    • last_payment_error.source.brandstring

      Card brand. Can be American Express, Diners Club, Discover, Eftpos Australia, Girocard, JCB, MasterCard, UnionPay, Visa, or Unknown.

    • last_payment_error.source.countrynullable string

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

    • last_payment_error.source.currencynullable enumAvailable conditionally

      Three-letter ISO code for currency in lowercase. Must be a supported currency. Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an External Account where controller.is_controller is true.

    • last_payment_error.source.customernullable stringExpandable

      The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.

    • last_payment_error.source.cvc_checknullable string

      If a CVC was provided, results of the check: pass, fail, unavailable, or unchecked. A result of unchecked indicates that CVC was provided but hasn’t been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

    • last_payment_error.source.dynamic_last4nullable string

      (For tokenized numbers only.) The last four digits of the device account number.

    • last_payment_error.source.exp_monthinteger

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

    • last_payment_error.source.exp_yearinteger

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

    • last_payment_error.source.fingerprintnullable string

      Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

      As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card—one for India and one for the rest of the world.

    • last_payment_error.source.fundingstring

      Card funding type. Can be credit, debit, prepaid, or unknown.

    • last_payment_error.source.iinnullable string

      Issuer identification number of the card.

    • last_payment_error.source.last4string

      The last four digits of the card.

    • last_payment_error.source.metadatanullable object

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

    • last_payment_error.source.namenullable string

      Cardholder name.

    • last_payment_error.source.regulated_statusnullable enum

      Status of a card based on the card issuer.

      Possible enum values

      regulated The card falls under a regulated account range.

      unregulated The card does not fall under a regulated account range.

    • last_payment_error.source.tokenization_methodnullable string

      If the card number is tokenized, this is the method that was used. Can be android_pay (includes Google Pay), apple_pay, masterpass, visa_checkout, or null.

    • last_payment_error.source.walletnullable objectPreview feature

      If this Card is part of a card wallet, this contains the details of the card wallet.

      Hide child attributes

      • last_payment_error.source.wallet.apple_paynullable object

        If this is a apple_pay card wallet, this hash contains details about the wallet.

      • last_payment_error.source.wallet.typeenum

        The type of the card wallet, one of apple_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.

        Possible enum values

        apple_pay

        link

  • last_payment_error.typeenum

    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

    Possible enum values

    api_error

    card_error

    idempotency_error

    invalid_request_error

• latest_chargenullable stringExpandable

  ID of the latest Charge object created by this PaymentIntent. This property is null until PaymentIntent confirmation is attempted.

• metadataobject

  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. Learn more about storing information in metadata.

• next_actionnullable objectretrievable with publishable key

  If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source.

  Hide child attributes

  • next_action.alipay_handle_redirectnullable object

    Contains instructions for authenticating a payment by redirecting your customer to Alipay App or website.

    Hide child attributes

    • next_action.alipay_handle_redirect.native_datanullable string

      The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App.

    • next_action.alipay_handle_redirect.native_urlnullable string

      The native URL you must redirect your customer to in order to authenticate the payment in an iOS App.

    • next_action.alipay_handle_redirect.return_urlnullable string

      If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.

    • next_action.alipay_handle_redirect.urlnullable string

      The URL you must redirect your customer to in order to authenticate the payment.

  • next_action.boleto_display_detailsnullable object

    Contains Boleto details necessary for the customer to complete the payment.

    Hide child attributes

    • next_action.boleto_display_details.expires_atnullable timestamp

      The timestamp after which the boleto expires.

    • next_action.boleto_display_details.hosted_voucher_urlnullable string

      The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher.

    • next_action.boleto_display_details.numbernullable string

      The boleto number.

    • next_action.boleto_display_details.pdfnullable string

      The URL to the downloadable boleto voucher PDF.

  • next_action.card_await_notificationnullable object

    Contains instructions for processing off session recurring payments with Indian issued cards.

    Hide child attributes

    • next_action.card_await_notification.charge_attempt_atnullable timestamp

      The time that payment will be attempted. If customer approval is required, they need to provide approval before this time.

    • next_action.card_await_notification.customer_approval_requirednullable boolean

      For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.

  • next_action.cashapp_handle_redirect_or_display_qr_codenullable object

    The field that contains Cash App Pay QR code info

    Hide child attributes

    • next_action.cashapp_handle_redirect_or_display_qr_code.hosted_instructions_urlstring

      The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration.

    • next_action.cashapp_handle_redirect_or_display_qr_code.mobile_auth_urlstring

      The url for mobile redirect based auth

    • next_action.cashapp_handle_redirect_or_display_qr_code.qr_codeobject

      The field that contains CashApp QR code info

      Hide child attributes

      • next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.expires_attimestamp

        The date (unix timestamp) when the QR code expires.

      • next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.image_url_pngstring

        The image_url_png string used to render QR code

      • next_action.cashapp_handle_redirect_or_display_qr_code.qr_code.image_url_svgstring

        The image_url_svg string used to render QR code

  • next_action.display_bank_transfer_instructionsnullable object

    Contains the bank transfer details necessary for the customer to complete the payment.

    Hide child attributes

    • next_action.display_bank_transfer_instructions.amount_remainingnullable integer

      The remaining amount that needs to be transferred to complete the payment.

    • next_action.display_bank_transfer_instructions.currencynullable enum

      Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • next_action.display_bank_transfer_instructions.financial_addressesnullable array of objects

      A list of financial addresses that can be used to fund the customer balance

      Hide child attributes

      • next_action.display_bank_transfer_instructions.financial_addresses.abanullable object

        An account and routing number US FinancialAddress

        Hide child attributes

        • next_action.display_bank_transfer_instructions.financial_addresses.aba.account_holder_addressobject

          The account holder’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.account_holder_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.account_holder_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.account_holder_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.account_holder_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.account_holder_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.account_holder_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.aba.account_holder_namestring

          The account holder name

        • next_action.display_bank_transfer_instructions.financial_addresses.aba.account_numberstring

          The ABA account number

        • next_action.display_bank_transfer_instructions.financial_addresses.aba.account_typestring

          The account type

        • next_action.display_bank_transfer_instructions.financial_addresses.aba.bank_addressobject

          The bank’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.bank_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.bank_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.bank_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.bank_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.bank_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.aba.bank_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.aba.bank_namestring

          The bank name

        • next_action.display_bank_transfer_instructions.financial_addresses.aba.routing_numberstring

          The ABA routing number

      • next_action.display_bank_transfer_instructions.financial_addresses.ibannullable object

        An IBAN-based FinancialAddress

        Hide child attributes

        • next_action.display_bank_transfer_instructions.financial_addresses.iban.account_holder_addressobject

          The account holder’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.account_holder_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.account_holder_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.account_holder_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.account_holder_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.account_holder_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.account_holder_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.iban.account_holder_namestring

          The name of the person or business that owns the bank account

        • next_action.display_bank_transfer_instructions.financial_addresses.iban.bank_addressobject

          The bank’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.bank_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.bank_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.bank_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.bank_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.bank_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.iban.bank_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.iban.bicstring

          The BIC/SWIFT code of the account.

        • next_action.display_bank_transfer_instructions.financial_addresses.iban.countrystring

          Two-letter country code (ISO 3166-1 alpha-2).

        • next_action.display_bank_transfer_instructions.financial_addresses.iban.ibanstring

          The IBAN of the account.

      • next_action.display_bank_transfer_instructions.financial_addresses.sort_codenullable object

        An account number and sort code-based FinancialAddress

        Hide child attributes

        • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.account_holder_addressobject

          The account holder’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.account_holder_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.account_holder_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.account_holder_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.account_holder_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.account_holder_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.account_holder_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.account_holder_namestring

          The name of the person or business that owns the bank account

        • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.account_numberstring

          The account number

        • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.bank_addressobject

          The bank’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.bank_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.bank_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.bank_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.bank_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.bank_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.bank_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.sort_code.sort_codestring

          The six-digit sort code

      • next_action.display_bank_transfer_instructions.financial_addresses.speinullable object

        A SPEI-based FinancialAddress

        Hide child attributes

        • next_action.display_bank_transfer_instructions.financial_addresses.spei.account_holder_addressobject

          The account holder’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.account_holder_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.account_holder_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.account_holder_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.account_holder_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.account_holder_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.account_holder_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.spei.account_holder_namestring

          The account holder name

        • next_action.display_bank_transfer_instructions.financial_addresses.spei.bank_addressobject

          The bank’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.bank_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.bank_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.bank_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.bank_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.bank_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.spei.bank_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.spei.bank_codestring

          The three-digit bank code

        • next_action.display_bank_transfer_instructions.financial_addresses.spei.bank_namestring

          The short banking institution name

        • next_action.display_bank_transfer_instructions.financial_addresses.spei.clabestring

          The CLABE number

      • next_action.display_bank_transfer_instructions.financial_addresses.supported_networksnullable array of enums

        The payment networks supported by this FinancialAddress

      • next_action.display_bank_transfer_instructions.financial_addresses.swiftnullable object

        An account and swift code FinancialAddress

        Hide child attributes

        • next_action.display_bank_transfer_instructions.financial_addresses.swift.account_holder_addressobject

          The account holder’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.account_holder_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.account_holder_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.account_holder_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.account_holder_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.account_holder_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.account_holder_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.swift.account_holder_namestring

          The account holder name

        • next_action.display_bank_transfer_instructions.financial_addresses.swift.account_numberstring

          The account number

        • next_action.display_bank_transfer_instructions.financial_addresses.swift.account_typestring

          The account type

        • next_action.display_bank_transfer_instructions.financial_addresses.swift.bank_addressobject

          The bank’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.bank_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.bank_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.bank_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.bank_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.bank_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.swift.bank_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.swift.bank_namestring

          The bank name

        • next_action.display_bank_transfer_instructions.financial_addresses.swift.swift_codestring

          The SWIFT code

      • next_action.display_bank_transfer_instructions.financial_addresses.typeenum

        The type of financial address

      • next_action.display_bank_transfer_instructions.financial_addresses.zenginnullable object

        A Zengin-based FinancialAddress

        Hide child attributes

        • next_action.display_bank_transfer_instructions.financial_addresses.zengin.account_holder_addressobject

          The account holder’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.account_holder_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.account_holder_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.account_holder_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.account_holder_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.account_holder_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.account_holder_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.zengin.account_holder_namenullable string

          The account holder name

        • next_action.display_bank_transfer_instructions.financial_addresses.zengin.account_numbernullable string

          The account number

        • next_action.display_bank_transfer_instructions.financial_addresses.zengin.account_typenullable string

          The bank account type. In Japan, this can only be futsu or toza.

        • next_action.display_bank_transfer_instructions.financial_addresses.zengin.bank_addressobject

          The bank’s physical address

          Hide child attributes

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.bank_address.citynullable string

            City, district, suburb, town, or village.

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.bank_address.countrynullable string

            Two-letter country code (ISO 3166-1 alpha-2).

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.bank_address.line1nullable string

            Address line 1 (e.g., street, PO Box, or company name).

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.bank_address.line2nullable string

            Address line 2 (e.g., apartment, suite, unit, or building).

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.bank_address.postal_codenullable string

            ZIP or postal code.

          • next_action.display_bank_transfer_instructions.financial_addresses.zengin.bank_address.statenullable string

            State, county, province, or region.

        • next_action.display_bank_transfer_instructions.financial_addresses.zengin.bank_codenullable string

          The bank code of the account

        • next_action.display_bank_transfer_instructions.financial_addresses.zengin.bank_namenullable string

          The bank name of the account

        • next_action.display_bank_transfer_instructions.financial_addresses.zengin.branch_codenullable string

          The branch code of the account

        • next_action.display_bank_transfer_instructions.financial_addresses.zengin.branch_namenullable string

          The branch name of the account

    • next_action.display_bank_transfer_instructions.hosted_instructions_urlnullable string

      A link to a hosted page that guides your customer through completing the transfer.

    • next_action.display_bank_transfer_instructions.referencenullable string

      A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer.

    • next_action.display_bank_transfer_instructions.typeenum

      Type of bank transfer

      Possible enum values

      eu_bank_transfer A bank transfer of type eu_bank_transfer

      gb_bank_transfer A bank transfer of type gb_bank_transfer

      jp_bank_transfer A bank transfer of type jp_bank_transfer

      mx_bank_transfer A bank transfer of type mx_bank_transfer

      us_bank_transfer A bank transfer of type us_bank_transfer

  • next_action.konbini_display_detailsnullable object

    Contains Konbini details necessary for the customer to complete the payment.

    Hide child attributes

    • next_action.konbini_display_details.expires_attimestamp

      The timestamp at which the pending Konbini payment expires.

    • next_action.konbini_display_details.hosted_voucher_urlnullable string

      The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher.

    • next_action.konbini_display_details.storesobject

      Payment instruction details grouped by convenience store chain.

      Hide child attributes

      • next_action.konbini_display_details.stores.familymartnullable object

        FamilyMart instruction details.

        Hide child attributes

        • next_action.konbini_display_details.stores.familymart.confirmation_numbernullable string

          The confirmation number.

        • next_action.konbini_display_details.stores.familymart.payment_codestring

          The payment code.

      • next_action.konbini_display_details.stores.lawsonnullable object

        Lawson instruction details.

        Hide child attributes

        • next_action.konbini_display_details.stores.lawson.confirmation_numbernullable string

          The confirmation number.

        • next_action.konbini_display_details.stores.lawson.payment_codestring

          The payment code.

      • next_action.konbini_display_details.stores.ministopnullable object

        Ministop instruction details.

        Hide child attributes

        • next_action.konbini_display_details.stores.ministop.confirmation_numbernullable string

          The confirmation number.

        • next_action.konbini_display_details.stores.ministop.payment_codestring

          The payment code.

      • next_action.konbini_display_details.stores.seicomartnullable object

        Seicomart instruction details.

        Hide child attributes

        • next_action.konbini_display_details.stores.seicomart.confirmation_numbernullable string

          The confirmation number.

        • next_action.konbini_display_details.stores.seicomart.payment_codestring

          The payment code.

  • next_action.multibanco_display_detailsnullable object

    Contains Multibanco details necessary for the customer to complete the payment.

    Hide child attributes

    • next_action.multibanco_display_details.entitynullable string

      Entity number associated with this Multibanco payment.

    • next_action.multibanco_display_details.expires_atnullable timestamp

      The timestamp at which the Multibanco voucher expires.

    • next_action.multibanco_display_details.hosted_voucher_urlnullable string

      The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher.

    • next_action.multibanco_display_details.referencenullable string

      Reference number associated with this Multibanco payment.

  • next_action.oxxo_display_detailsnullable object

    Contains OXXO details necessary for the customer to complete the payment.

    Hide child attributes

    • next_action.oxxo_display_details.expires_afternullable timestamp

      The timestamp after which the OXXO voucher expires.

    • next_action.oxxo_display_details.hosted_voucher_urlnullable string

      The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher.

    • next_action.oxxo_display_details.numbernullable string

      OXXO reference number.

  • next_action.paynow_display_qr_codenullable object

    The field that contains PayNow QR code info

    Hide child attributes

    • next_action.paynow_display_qr_code.datastring

      The raw data string used to generate QR code, it should be used together with QR code library.

    • next_action.paynow_display_qr_code.hosted_instructions_urlnullable string

      The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code.

    • next_action.paynow_display_qr_code.image_url_pngstring

      The image_url_png string used to render QR code

    • next_action.paynow_display_qr_code.image_url_svgstring

      The image_url_svg string used to render QR code

  • next_action.pix_display_qr_codenullable objectPreview feature

    The field that contains Pix QR code info

    Hide child attributes

    • next_action.pix_display_qr_code.datastringPreview feature

      The raw data string used to generate QR code, it should be used together with QR code library.

    • next_action.pix_display_qr_code.expires_atintegerPreview feature

      The date (unix timestamp) when the PIX expires.

    • next_action.pix_display_qr_code.hosted_instructions_urlstringPreview feature

      The URL to the hosted pix instructions page, which allows customers to view the pix QR code.

    • next_action.pix_display_qr_code.image_url_pngstringPreview feature

      The image_url_png string used to render png QR code

    • next_action.pix_display_qr_code.image_url_svgstringPreview feature

      The image_url_svg string used to render svg QR code

  • next_action.promptpay_display_qr_codenullable object

    The field that contains PromptPay QR code info

    Hide child attributes

    • next_action.promptpay_display_qr_code.datastring

      The raw data string used to generate QR code, it should be used together with QR code library.

    • next_action.promptpay_display_qr_code.hosted_instructions_urlstring

      The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code.

    • next_action.promptpay_display_qr_code.image_url_pngstring

      The PNG path used to render the QR code, can be used as the source in an HTML img tag

    • next_action.promptpay_display_qr_code.image_url_svgstring

      The SVG path used to render the QR code, can be used as the source in an HTML img tag

  • next_action.redirect_to_urlnullable object

    Contains instructions for authenticating a payment by redirecting your customer to another page or application.

    Hide child attributes

    • next_action.redirect_to_url.return_urlnullable string

      If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion.

    • next_action.redirect_to_url.urlnullable string

      The URL you must redirect your customer to in order to authenticate the payment.

  • next_action.swish_handle_redirect_or_display_qr_codenullable object

    The field that contains Swish QR code and mobile redirect info

    Hide child attributes

    • next_action.swish_handle_redirect_or_display_qr_code.hosted_instructions_urlstring

      The URL to the hosted Swish instructions page, which allows customers to view the QR code.

    • next_action.swish_handle_redirect_or_display_qr_code.qr_codeobject

      The field that contains Swish QR code info

      Hide child attributes

      • next_action.swish_handle_redirect_or_display_qr_code.qr_code.datastring

        The raw data string used to generate QR code, it should be used together with QR code library.

      • next_action.swish_handle_redirect_or_display_qr_code.qr_code.image_url_pngstring

        The image_url_png string used to render QR code

      • next_action.swish_handle_redirect_or_display_qr_code.qr_code.image_url_svgstring

        The image_url_svg string used to render QR code

  • next_action.typestring

    Type of the next action to perform. Refer to the other child attributes under next_action for available values. Examples include: redirect_to_url, use_stripe_sdk, alipay_handle_redirect, oxxo_display_details, or verify_with_microdeposits.

  • next_action.use_stripe_sdknullable object

    When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js.

  • next_action.verify_with_microdepositsnullable object

    Contains details describing microdeposits verification flow.

    Hide child attributes

    • next_action.verify_with_microdeposits.arrival_datetimestamp

      The timestamp when the microdeposits are expected to land.

    • next_action.verify_with_microdeposits.hosted_verification_urlstring

      The URL for the hosted verification page, which allows customers to verify their bank account.

    • next_action.verify_with_microdeposits.microdeposit_typenullable enum

      The type of the microdeposit sent to the customer. Used to distinguish between different verification methods.

  • next_action.wechat_pay_display_qr_codenullable object

    The field that contains WeChat Pay QR code info

    Hide child attributes

    • next_action.wechat_pay_display_qr_code.datastring

      The data being used to generate QR code

    • next_action.wechat_pay_display_qr_code.hosted_instructions_urlstring

      The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code.

    • next_action.wechat_pay_display_qr_code.image_data_urlstring

      The base64 image data for a pre-generated QR code

    • next_action.wechat_pay_display_qr_code.image_url_pngstring

      The image_url_png string used to render QR code

    • next_action.wechat_pay_display_qr_code.image_url_svgstring

      The image_url_svg string used to render QR code

  • next_action.wechat_pay_redirect_to_android_appnullable object

    Info required for android app to app redirect

    Hide child attributes

    • next_action.wechat_pay_redirect_to_android_app.app_idstring

      app_id is the APP ID registered on WeChat open platform

    • next_action.wechat_pay_redirect_to_android_app.nonce_strstring

      nonce_str is a random string

    • next_action.wechat_pay_redirect_to_android_app.packagestring

      package is static value

    • next_action.wechat_pay_redirect_to_android_app.partner_idstring

      an unique merchant ID assigned by WeChat Pay

    • next_action.wechat_pay_redirect_to_android_app.prepay_idstring

      an unique trading ID assigned by WeChat Pay

    • next_action.wechat_pay_redirect_to_android_app.signstring

      A signature

    • next_action.wechat_pay_redirect_to_android_app.timestampstring

      Specifies the current time in epoch format

  • next_action.wechat_pay_redirect_to_ios_appnullable object

    Info required for iOS app to app redirect

    Hide child attributes

    • next_action.wechat_pay_redirect_to_ios_app.native_urlstring

      An universal link that redirect to WeChat Pay app

• payment_methodnullable stringExpandableretrievable with publishable key

  ID of the payment method used in this PaymentIntent.

• receipt_emailnullable stringretrievable with publishable key

  Email address that the receipt for the resulting payment will be sent to. If receipt_email is specified for a payment in live mode, a receipt will be sent regardless of your email settings.

• setup_future_usagenullable enumretrievable with publishable key

  Indicates that you intend to make future payments with this PaymentIntent’s payment method.

  If you provide a Customer with the PaymentIntent, you can use this parameter to attach the payment method to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don’t provide a Customer, you can still attach the payment method to a Customer after the transaction completes.

  If the payment method is card_present and isn’t a digital wallet, Stripe creates and attaches a generated_card payment method representing the card to the Customer instead.

  When processing card payments, Stripe uses setup_future_usage to help you comply with regional legislation and network rules, such as SCA.

  Possible enum values

  off_session Use off_session if your customer may or may not be present in your checkout flow.

  on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

• shippingnullable objectretrievable with publishable key

  Shipping information for this PaymentIntent.

  Hide child attributes

  • shipping.addressobject

    Shipping address.

    Hide child attributes

    • shipping.address.citynullable string

      City, district, suburb, town, or village.

    • shipping.address.countrynullable string

      Two-letter country code (ISO 3166-1 alpha-2).

    • shipping.address.line1nullable string

      Address line 1 (e.g., street, PO Box, or company name).

    • shipping.address.line2nullable string

      Address line 2 (e.g., apartment, suite, unit, or building).

    • shipping.address.postal_codenullable string

      ZIP or postal code.

    • shipping.address.statenullable string

      State, county, province, or region.

  • shipping.carriernullable string

    The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

  • shipping.namestring

    Recipient name.

  • shipping.phonenullable string

    Recipient phone (including extension).

  • shipping.tracking_numbernullable string

    The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

• statement_descriptornullable string

  Text that appears on the customer’s statement as the statement descriptor for a non-card charge. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

  Setting this value for a card charge returns an error. For card charges, set the statement_descriptor_suffix instead.

• statement_descriptor_suffixnullable string

  Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement.

• statusenumretrievable with publishable key

  Status of this PaymentIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, or succeeded. Read more about each PaymentIntent status.

  Possible enum values

  canceled

  processing

  requires_action

  requires_capture

  requires_confirmation

  requires_payment_method

  succeeded