com.onlinepayments

Class ApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.onlinepayments.ApiException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthorizationException, DeclinedTransactionException, IdempotenceException, PaymentPlatformException, ReferenceException, ValidationException

public class ApiException
extends RuntimeException

Represents an error response from the Online Payments platform which contains an ID and a list of errors.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApiException(int statusCode, String responseBody, String errorId, List<APIError> errors)
ApiException(String message, int statusCode, String responseBody, String errorId, List<APIError> errors)

Method Summary

Modifier and Type	Method and Description
String	getErrorId()
List<APIError>	getErrors()
String	getResponseBody()
int	getStatusCode()
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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiException

public ApiException(int statusCode,
                    String responseBody,
                    String errorId,
                    List<APIError> errors)

ApiException

public ApiException(String message,
                    int statusCode,
                    String responseBody,
                    String errorId,
                    List<APIError> errors)

Method Detail

getStatusCode

public int getStatusCode()

Returns:

The HTTP status code that was returned by the Online Payments platform.

getResponseBody

public String getResponseBody()

Returns:

The raw response body that was returned by the Online Payments platform.

getErrorId

public String getErrorId()

Returns:

The error ID received from the Online Payments platform if available.

getErrors

public List<APIError> getErrors()

Returns:

The error list received from the Online Payments platform if available. Never null.

toString

public String toString()

Overrides:

toString in class Throwable