com.stripe.stripeterminal.api

Class ApiError

com.stripe.stripeterminal.api.ApiError

public class ApiError

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

See Also:

Errors

Field Summary

Fields

Modifier and Type	Field and Description
static com.stripe.stripeterminal.api.ApiError.Companion	Companion Deprecated.

Method Summary

Modifier and Type	Method and Description
ApiError	copy(com.stripe.stripeterminal.api.InnerError error) An ApiError is an object representing a Stripe API error object.
boolean	equals(java.lang.Object p)
java.lang.String	getCharge() For card errors, the ID of the failed charge
java.lang.String	getCode() The code specific to this error type
java.lang.String	getDeclineCode() If this error results from a declined card (type = CARD_ERROR), this field will provide more details
java.lang.String	getDocUrl() A URL to learn more about the error reported
java.lang.String	getMessage() A human-readable message providing more details about the error
java.lang.String	getParam() If the error is parameter-specific, this returns the parameter related to the error
ApiErrorType	getType() The type of error returned
int	hashCode()
java.lang.String	toString()

Field Detail

Companion

public static com.stripe.stripeterminal.api.ApiError.Companion Companion

Deprecated.

Method Detail

getCharge

@Nullable
public java.lang.String getCharge()

For card errors, the ID of the failed charge

getCode

@Nullable
public java.lang.String getCode()

The code specific to this error type

getDeclineCode

@Nullable
public java.lang.String getDeclineCode()

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

getDocUrl

@Nullable
public java.lang.String getDocUrl()

A URL to learn more about the error reported

getMessage

@NotNull
public java.lang.String getMessage()

A human-readable message providing more details about the error

getType

@Nullable
public ApiErrorType getType()

The type of error returned

getParam

@Nullable
public java.lang.String getParam()

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

copy

@NotNull
public ApiError copy(@NotNull
                              com.stripe.stripeterminal.api.InnerError error)

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

See Also:

Errors

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)