ApiError

@JsonClass(generateAdapter = false)
data class ApiError(error: InnerError) : Parcelable

An ApiError is an object representing a Stripe API error object.

For more information, see the official Stripe docs: Errors

Use of this SDK is subject to the Stripe Terminal Terms: https://stripe.com/terminal/legal

Constructors

Link copied to clipboard
fun ApiError(error: InnerError)

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard
val charge: String?

For card errors, the ID of the failed charge

Link copied to clipboard
val code: String?

The code specific to this error type

Link copied to clipboard
val declineCode: String?

If this error results from a declined card (type = CARD_ERROR), this field will provide more details

Link copied to clipboard
val docUrl: String?

A URL to learn more about the error reported

Link copied to clipboard
val message: String

A human-readable message providing more details about the error

Link copied to clipboard
val param: String?

If the error is parameter-specific, this returns the parameter related to the error

Link copied to clipboard
val paymentIntent: PaymentIntent?

If the error is related to a PaymentIntent, this returns the payment intent.

Link copied to clipboard
val type: ApiErrorType?

The type of error returned