StripeAPI.Types.ApiErrors

charge: For card errors, the ID of the failed charge.

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

decline_code: 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.

Constraints:

• Maximum length of 5000

doc_url: A URL to more information about the error code reported.

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 40000

param: 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.

Constraints:

• Maximum length of 5000

payment_intent: 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 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.

payment_method: PaymentMethod objects represent your customer's payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

payment_method_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.

Constraints:

• Maximum length of 5000

setup_intent: 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 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 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 may need to be run through Strong Customer Authentication at the time of payment method collection in order to streamline later off-session payments. If the SetupIntent is used with a Customer, upon success, it will automatically attach the resulting payment method to that Customer. We recommend using SetupIntents or 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.

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

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

account: The ID of the account that the bank account is associated with.

account_holder_name: The name of the person or business that owns the bank account.

Constraints:

• Maximum length of 5000

account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.

Constraints:

• Maximum length of 5000

account_type: The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.

Constraints:

• Maximum length of 5000

ach_credit_transfer

ach_debit

acss_debit

address_city: City/District/Suburb/Town/Village.

Constraints:

• Maximum length of 5000

address_country: Billing address country, if provided when creating card.

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

address_state: State/County/Province/Region.

Constraints:

• Maximum length of 5000

address_zip: ZIP or postal code.

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

alipay

amount: A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.

au_becs_debit

available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.

bancontact

bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

Constraints:

• Maximum length of 5000

brand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.

Constraints:

• Maximum length of 5000

card

card_present

client_secret: The client secret of the source. Used for client-side retrieval using a publishable key.

Constraints:

• Maximum length of 5000

code_verification:

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

Constraints:

• Maximum length of 5000

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

currency: Three-letter ISO code for the currency paid out to the bank account.

customer: The ID of the customer that the bank account is associated with.

cvc_check: 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.

Constraints:

• Maximum length of 5000

default_for_currency: Whether this bank account is the default external account for its currency.

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

Constraints:

• Maximum length of 5000

eps

exp_month: Two-digit number representing the card's expiration month.

exp_year: Four-digit number representing the card's expiration year.

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

Constraints:

• Maximum length of 5000

flow: The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

giropay

id: Unique identifier for the object.

Constraints:

• Maximum length of 5000

ideal

klarna

last4: The last four digits of the bank account number.

Constraints:

• Maximum length of 5000

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

metadata: 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.

multibanco

name: Cardholder name.

Constraints:

• Maximum length of 5000

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

owner: Information about the owner of the payment instrument that may be used or required by particular source types.

p24

receiver:

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

redirect:

routing_number: The routing transit number for the bank account.

Constraints:

• Maximum length of 5000

sepa_debit

sofort

source_order:

statement_descriptor: Extra information about a source. This will appear on your customer's statement every time you charge the source.

Constraints:

• Maximum length of 5000

status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

Constraints:

• Maximum length of 5000

three_d_secure

tokenization_method: 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.

Constraints:

• Maximum length of 5000

type: The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.

usage: Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

Constraints:

• Maximum length of 5000

wechat

address: Owner's address.

email: Owner's email address.

Constraints:

• Maximum length of 5000

name: Owner's full name.

Constraints:

• Maximum length of 5000

phone: Owner's phone number (including extension).

Constraints:

• Maximum length of 5000

verified_address: Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

verified_email: Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constraints:

• Maximum length of 5000

verified_name: Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constraints:

• Maximum length of 5000

verified_phone: Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constraints:

• Maximum length of 5000

city: City, district, suburb, town, or village.

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

postal_code: ZIP or postal code.

Constraints:

• Maximum length of 5000

state: State, county, province, or region.

Constraints:

• Maximum length of 5000

city: City, district, suburb, town, or village.

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

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

Constraints:

• Maximum length of 5000

postal_code: ZIP or postal code.

Constraints:

• Maximum length of 5000

state: State, county, province, or region.

Constraints:

• Maximum length of 5000