Package com.stripe.model

Class StripeError

    • Constructor Summary

      Constructors 
      Constructor Description
      StripeError()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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](/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](/docs/declines#issuer-declines) if they provide one.
      java.lang.String getDocUrl()
      A URL to more information about the [error code](/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()
      The PaymentIntent object for errors returned on a request involving a PaymentIntent.
      PaymentMethod getPaymentMethod()
      The PaymentMethod object for errors returned on a request involving a PaymentMethod.
      ExternalAccount getSource()
      The source object for errors returned on a request involving a source.
      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](/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](/docs/declines#issuer-declines) if they provide one.
      void setDocUrl​(java.lang.String docUrl)
      A URL to more information about the [error code](/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)
      The PaymentIntent object for errors returned on a request involving a PaymentIntent.
      void setPaymentMethod​(PaymentMethod paymentMethod)
      The PaymentMethod object for errors returned on a request involving a PaymentMethod.
      void setSource​(ExternalAccount source)
      The source object for errors returned on a request involving a source.
      void setType​(java.lang.String type)
      The type of error returned.

      • 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](/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](/docs/declines#issuer-declines) if they provide one.

      • getDocUrl

        public java.lang.String getDocUrl()
        A URL to more information about the [error code](/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()
        The PaymentIntent object for errors returned on a request involving a PaymentIntent.

      • getPaymentMethod

        public PaymentMethod getPaymentMethod()
        The PaymentMethod object for errors returned on a request involving a PaymentMethod.

      • getSource

        public ExternalAccount getSource()
        The source object for errors returned on a request involving a source.

      • 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](/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](/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](/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)
        The PaymentIntent object for errors returned on a request involving a PaymentIntent.

      • setPaymentMethod

        public void setPaymentMethod​(PaymentMethod paymentMethod)
        The PaymentMethod object for errors returned on a request involving a PaymentMethod.

      • setSource

        public void setSource​(ExternalAccount source)
        The source object for errors returned on a request involving a 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