GoCardlessApiException (gocardless-pro 3.7.0 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - com.gocardless.GoCardlessException
      - com.gocardless.errors.GoCardlessApiException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GoCardlessInternalException, InvalidApiUsageException, InvalidStateException, ValidationFailedException
```
public class GoCardlessApiException
extends GoCardlessException
```
Base class for exceptions that are thrown as a result of error responses from the API.

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getCode()` Returns the HTTP status code.
`java.lang.String`	`getDocumentationUrl()` Returns the URL to the documentation describing the error.
`java.lang.String`	`getErrorMessage()` Returns a human-readable description of the error.
`java.util.List<ApiError>`	`getErrors()` Returns a list of errors.
`java.lang.String`	`getRequestId()` Returns the ID of the request.
`ErrorType`	`getType()` Returns the type of the error.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Returns a human-readable description of the error.
  - getType
```
public ErrorType getType()
```
    Returns the type of the error.
  - getDocumentationUrl
```
public java.lang.String getDocumentationUrl()
```
    Returns the URL to the documentation describing the error.
  - getRequestId
```
public java.lang.String getRequestId()
```
    Returns the ID of the request. This can be used to help the support team find your error quickly.
  - getCode
```
public int getCode()
```
    Returns the HTTP status code.
  - getErrors
```
public java.util.List<ApiError> getErrors()
```
    Returns a list of errors.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Throwable

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method