Skip to main content
Schema2020-08-27object

api_errors

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

APIErrors

object
charge string
optional

For card errors, the ID of the failed charge.

code string
optional

For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.

decline_code string
optional

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.

doc_url string
optional

A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.

message string
optional

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

param string
optional

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 object
optional

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 u…

payment_method PaymentMethod object
optional

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

payment_method_type string
optional

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 object
optional

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 ma…

source
optional

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

type string
required

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