GetAccounts
<p>Returns a list of accounts connected to your platform via <a href="/docs/connect">Connect</a>. If you’re not a platform, the list is empty.</p>
/v1/accounts- Source
openapi/spec3.json- Commit
d70de345383d- Active snapshot
da69df7e6e11
Request
Authorization
Read-onlyCredentials are never accepted or stored on this documentation page.
Send credentials in the Authorization request header using the Basic scheme.
Basic HTTP authentication. Allowed headers-- Authorization: Basic <api_key> | Authorization: Basic <base64 hash of `api_key:`>
- Request header
- Authorization
- Scheme
- basic
Send the token in the Authorization request header using the Bearer scheme.
Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>
- Request header
- Authorization
- Scheme
- bearer
- Bearer format
- auth-scheme
Query Parameters
- created queryoptional
- ending_before stringoptional
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
- expand array[string]optional
Specifies which fields in the response should be expanded.
- limit integeroptional
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_after stringoptional
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
Body Params
optionalResponses
Successful response.
data array[Account object]required
items Account objectThis is an object representing a Stripe account. You can retrieve it to see
properties on the account like its current e-mail address or if the account is
enabled yet to make live charges.
Some properties, marked below, are available only to platforms that want to
[create and manage Express or Custom accounts](https://stripe.com/docs/connect/accounts).
This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current e-mail address or if the account is enabled yet to make live charges. Some properties, marked below, are available only to platforms that want to [create and manage Express or Custom accounts](https://stripe.com/docs/connect/accounts).
Business information about the account.
The business type.
capabilities AccountCapabilities objectoptional
The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges.
The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.
The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges.
The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.
The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.
The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.
The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards
The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.
The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency.
The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.
The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.
The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.
The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.
The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.
The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency.
The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.
The status of the legacy payments capability of the account.
The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.
The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.
The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.
The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.
The status of the tax reporting 1099-K (US) capability of the account.
The status of the tax reporting 1099-MISC (US) capability of the account.
The status of the transfers capability of the account, or whether your platform can transfer funds to the account.
Whether the account can create live charges.
company LegalEntityCompany objectoptional
The Kana variation of the company's primary address (Japan only).
The Kanji variation of the company's primary address (Japan only).
Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided).
Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided.
The company's legal name.
The Kana variation of the company's legal name (Japan only).
The Kanji variation of the company's legal name (Japan only).
Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together).
This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
The company's phone number (used for verification).
The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details.
Whether the company's business ID number was provided.
The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
Whether the company's business VAT number was provided.
Information on the verification state of the company.
controller AccountUnificationAccountController objectoptional
`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null.
The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.
The account's country.
Time at which the object was created. Measured in seconds since the Unix epoch.
Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).
Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.
An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.
external_accounts ExternalAccountList objectoptionalExternal accounts (bank accounts and debit cards) currently attached to this account
External accounts (bank accounts and debit cards) currently attached to this account
The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.
True if this list has another page of items after this one that can be fetched.
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
The URL where this list can be accessed.
future_requirements AccountFutureRequirements objectoptional
Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning.
Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account.
Fields that are `currently_due` and need to be collected again because validation or verification failed.
Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well.
Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`.
Unique identifier for the object.
individual Person objectoptionalThis is an object representing a person associated with a Stripe account.
A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.
See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps.
Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information).
This is an object representing a person associated with a Stripe account. A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps. Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information).
The account the person is associated with.
Time at which the object was created. Measured in seconds since the Unix epoch.
The person's email address.
The person's first name.
The Kana variation of the person's first name (Japan only).
The Kanji variation of the person's first name (Japan only).
A list of alternate names or aliases that the person is known by.
The person's gender (International regulations require either "male" or "female").
Unique identifier for the object.
Whether the person's `id_number` was provided.
The person's last name.
The Kana variation of the person's last name (Japan only).
The Kanji variation of the person's last name (Japan only).
The person's maiden name.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
The country where the person is a national.
String representing the object's type. Objects of the same type share the same value.
The person's phone number.
Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
Whether the last four digits of the person's Social Security number have been provided (U.S. only).
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
String representing the object's type. Objects of the same type share the same value.
Whether Stripe can send payouts to this account.
requirements AccountRequirements objectoptional
Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected.
Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`.
Fields that are `currently_due` and need to be collected again because validation or verification failed.
Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account.
Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`.
Options for customizing how the account functions within Stripe.
tos_acceptance AccountTOSAcceptance objectoptional
The Unix timestamp marking when the account representative accepted their service agreement
The IP address from which the account representative accepted their service agreement
The user's service agreement type
The user agent of the browser from which the account representative accepted their service agreement
The Stripe account type. Can be `standard`, `express`, or `custom`.
True if this list has another page of items after this one that can be fetched.
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
The URL where this list can be accessed.
Error response.
error APIErrors objectrequired
For card errors, the ID of the failed charge.
For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.
A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
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.
payment_intent PaymentIntent objectoptionalA PaymentIntent guides you through the process of collecting a payment from your customer.
We recommend that you create exactly one PaymentIntent for each order or
customer session in your system. You can reference the PaymentIntent later to
see the history of payment attempts for a particular session.
A PaymentIntent transitions through
[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
throughout its lifetime as it interfaces with Stripe.js to perform
authentication flows and ultimately creates at most one successful charge.
Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).
A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session. A PaymentIntent transitions through [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses) throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge. Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).
Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (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](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
Amount that can be captured from this PaymentIntent.
Amount that was collected by this PaymentIntent.
ID of the Connect application that created the PaymentIntent.
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)
Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch.
Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`).
Controls when the funds will be captured from the customer's account.
charges PaymentFlowsPaymentIntentResourceChargeList objectoptionalCharges that were created by this PaymentIntent, if any.
Charges that were created by this PaymentIntent, if any.
This list only contains the latest charge, even if there were previously multiple unsuccessful charges. To view all previous charges for a PaymentIntent, you can filter the charges list using the `payment_intent` [parameter](https://stripe.com/docs/api/charges/list#list_charges-payment_intent).
True if this list has another page of items after this one that can be fetched.
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
The URL where this list can be accessed.
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, embedded in URLs, 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](https://stripe.com/docs/payments/accept-a-payment?integration=elements) and learn about how `client_secret` should be handled.
Time at which the object was created. Measured in seconds since the Unix epoch.
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
ID of the Customer this PaymentIntent belongs to, if one exists. Payment methods attached to other Customers cannot be used with this PaymentIntent. If present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
An arbitrary string attached to the object. Often useful for displaying to users.
Unique identifier for the object.
ID of the invoice that created this PaymentIntent, if it exists.
The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).
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.
String representing the object's type. Objects of the same type share the same value.
The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
ID of the payment method used in this PaymentIntent.
Payment-method-specific configuration for this PaymentIntent.
The list of payment method types (e.g. card) that this PaymentIntent is allowed to use.
If present, this property tells you about the processing state of the payment.
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](https://dashboard.stripe.com/account/emails).
ID of the review associated with this PaymentIntent, if any.
Indicates that you intend to make future payments with this PaymentIntent's payment method. Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication).
Shipping information for this PaymentIntent.
For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.
Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
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](https://stripe.com/docs/payments/intents#intent-statuses).
The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
payment_method PaymentMethod objectoptionalPaymentMethod objects represent your customer's payment instruments.
They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to
Customer objects to store instrument details for future payments.
Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
PaymentMethod objects represent your customer's payment instruments. They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to Customer objects to store instrument details for future payments. Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
acss_debit payment_method_acss_debit objectoptional
Name of the bank associated with the bank account.
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Institution number of the bank account.
Last four digits of the bank account number.
Transit number of the bank account.
au_becs_debit payment_method_au_becs_debit objectoptional
Six-digit number identifying bank and branch associated with this bank account.
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Last four digits of the bank account number.
bacs_debit payment_method_bacs_debit objectoptional
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Last four digits of the bank account number.
Sort code of the bank account. (e.g., `10-20-30`)
billing_details billing_details objectrequired
Billing address.
Email address.
Full name.
Billing phone number (including extension).
boleto payment_method_boleto objectoptional
Uniquely identifies the customer tax id (CNPJ or CPF)
card payment_method_card objectoptional
Card brand. Can be `amex`, `diners`, `discover`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
Checks on Card address and CVC if provided.
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.
Two-digit number representing the card's expiration month.
Four-digit number representing the card's expiration year.
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. *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.
Details of the original PaymentMethod that created this object.
The last four digits of the card.
Contains information about card networks that can be used to process the payment.
Contains details on how this Card maybe be used for 3D Secure authentication.
If this Card is part of a card wallet, this contains the details of the card wallet.
Time at which the object was created. Measured in seconds since the Unix epoch.
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.
eps payment_method_eps objectoptional
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`, `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`.
fpx payment_method_fpx objectoptional
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`, or `pb_enterprise`.
Unique identifier for the object.
ideal payment_method_ideal objectoptional
The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, or `van_lanschot`.
The Bank Identifier Code of the customer's bank, if the bank was provided.
klarna payment_method_klarna objectoptional
The customer's date of birth, if provided.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
String representing the object's type. Objects of the same type share the same value.
p24 payment_method_p24 objectoptional
The customer's bank, if provided.
sepa_debit payment_method_sepa_debit objectoptional
Bank code of bank associated with the bank account.
Branch code of bank associated with the bank account.
Two-letter ISO code representing the country the bank account is located in.
Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
Information about the object that generated this PaymentMethod.
Last four characters of the IBAN.
sofort payment_method_sofort objectoptional
Two-letter ISO code representing the country the bank account is located in.
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.
If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
setup_intent SetupIntent objectoptionalA SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
Create a SetupIntent as soon as you're ready to collect your customer's payment credentials.
Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.
The SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides
you through the setup process.
Successful SetupIntents result in payment credentials that are optimized for future payments.
For example, cardholders in [certain regions](/guides/strong-customer-authentication) may need to be run through
[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection
in order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).
If the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,
it will automatically attach the resulting payment method to that Customer.
We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.
By using SetupIntents, you ensure that your customers experience the minimum set of required friction,
even as regulations change over time.
Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents).
A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. Create a SetupIntent as soon as you're ready to collect your customer's payment credentials. Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid. The SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides you through the setup process. Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in [certain regions](/guides/strong-customer-authentication) may need to be run through [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection in order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents). If the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success, it will automatically attach the resulting payment method to that Customer. We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods. By using SetupIntents, you ensure that your customers experience the minimum set of required friction, even as regulations change over time. Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents).
ID of the Connect application that created the SetupIntent.
Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`.
The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, embedded in URLs, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.
Time at which the object was created. Measured in seconds since the Unix epoch.
ID of the Customer this SetupIntent belongs to, if one exists. If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.
An arbitrary string attached to the object. Often useful for displaying to users.
Unique identifier for the object.
The error encountered in the previous SetupIntent confirmation.
The most recent SetupAttempt for this SetupIntent.
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
ID of the multi use Mandate generated by the SetupIntent.
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
If present, this property tells you what actions you need to take in order for your customer to continue payment setup.
String representing the object's type. Objects of the same type share the same value.
The account (if any) for which the setup is intended.
ID of the payment method used with this SetupIntent.
Payment-method-specific configuration for this SetupIntent.
The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.
ID of the single_use Mandate generated by the SetupIntent.
[Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`.
Indicates how the payment method is intended to be used in the future. Use `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`.
The source object for errors returned on a request involving a source.
The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`