com.stripe.model

Class StripeError

java.lang.Object

com.stripe.model.StripeObject

com.stripe.model.StripeError

public class StripeError
extends StripeObject

Field Summary

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor and Description
StripeError()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.lang.String	getCharge() For card errors, the ID of the failed charge.
java.lang.String	getCode() For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
java.lang.String	getDeclineCode() 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.
java.lang.String	getDocUrl() A URL to more information about the [error code](https://stripe.com/docs/error-codes) 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, the parameter related to the error.
PaymentIntent	getPaymentIntent()
PaymentMethod	getPaymentMethod()
SetupIntent	getSetupIntent()
PaymentSource	getSource()
java.lang.String	getType() The type of error returned.
int	hashCode()
void	setCharge(java.lang.String charge) For card errors, the ID of the failed charge.
void	setCode(java.lang.String code) For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.
void	setDeclineCode(java.lang.String declineCode) 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.
void	setDocUrl(java.lang.String docUrl) A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.
void	setMessage(java.lang.String message) A human-readable message providing more details about the error.
void	setParam(java.lang.String param) If the error is parameter-specific, the parameter related to the error.
void	setPaymentIntent(PaymentIntent paymentIntent)
void	setPaymentMethod(PaymentMethod paymentMethod)
void	setSetupIntent(SetupIntent setupIntent)
void	setSource(PaymentSource source)
void	setType(java.lang.String type) The type of error returned.

Methods inherited from class com.stripe.model.StripeObject

equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StripeError

public StripeError()

Method Detail

getCharge

public java.lang.String getCharge()

For card errors, the ID of the failed charge.

getCode

public java.lang.String getCode()

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

getDeclineCode

public java.lang.String getDeclineCode()

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.

getDocUrl

public java.lang.String getDocUrl()

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

getMessage

public java.lang.String getMessage()

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

getParam

public java.lang.String getParam()

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.

getPaymentIntent

public PaymentIntent getPaymentIntent()

getPaymentMethod

public PaymentMethod getPaymentMethod()

getSetupIntent

public SetupIntent getSetupIntent()

getSource

public PaymentSource getSource()

getType

public java.lang.String getType()

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

setCharge

public void setCharge(java.lang.String charge)

For card errors, the ID of the failed charge.

setCode

public void setCode(java.lang.String code)

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

setDeclineCode

public void setDeclineCode(java.lang.String declineCode)

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.

setDocUrl

public void setDocUrl(java.lang.String docUrl)

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

setMessage

public void setMessage(java.lang.String message)

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

setParam

public void setParam(java.lang.String 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.

setPaymentIntent

public void setPaymentIntent(PaymentIntent paymentIntent)

setPaymentMethod

public void setPaymentMethod(PaymentMethod paymentMethod)

setSetupIntent

public void setSetupIntent(SetupIntent setupIntent)

setSource

public void setSource(PaymentSource source)

setType

public void setType(java.lang.String type)

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

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object