Package com.adyen.model

Class ApiError

java.lang.Object

com.adyen.model.ApiError

public class ApiError
extends Object

ServiceError

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_ADDITIONAL_DATA
static String	JSON_PROPERTY_ERROR_CODE
static String	JSON_PROPERTY_ERROR_TYPE
static String	JSON_PROPERTY_INVALID_FIELDS
static String	JSON_PROPERTY_MESSAGE
static String	JSON_PROPERTY_PSP_REFERENCE
static String	JSON_PROPERTY_STATUS

Constructor Summary

Constructors

Constructor	Description
ApiError()

Method Summary

Modifier and Type	Method	Description
ApiError	addInvalidFieldsItem(InvalidField invalidFieldsItem)
ApiError	additionalData(Map<String,String> additionalData)
boolean	equals(Object o)	Return true if this ServiceError object is equal to o.
ApiError	errorCode(String errorCode)
ApiError	errorType(String errorType)
static ApiError	fromJson(String jsonString)	Create an instance of ApiError given an JSON string
Map<String,String>	getAdditionalData()	Contains additional information about the payment.
String	getErrorCode()	The error code mapped to the error message.
String	getErrorType()	The category of the error.
List<InvalidField>	getInvalidFields()	Detailed explanation of each validation error, when applicable.
String	getMessage()	A short explanation of the issue.
String	getPspReference()	The PSP reference of the payment.
Integer	getStatus()	The HTTP response status.
int	hashCode()
ApiError	invalidFields(List<InvalidField> invalidFields)
ApiError	message(String message)
ApiError	pspReference(String pspReference)
ApiError	putAdditionalDataItem(String key, String additionalDataItem)
void	setAdditionalData(Map<String,String> additionalData)
void	setErrorCode(String errorCode)
void	setErrorType(String errorType)
void	setInvalidFields(List<InvalidField> invalidFields)
void	setMessage(String message)
void	setPspReference(String pspReference)
void	setStatus(Integer status)
ApiError	status(Integer status)
String	toJson()	Convert an instance of ApiError to an JSON string
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_INVALID_FIELDS

public static final String JSON_PROPERTY_INVALID_FIELDS

See Also:

Constant Field Values

JSON_PROPERTY_ADDITIONAL_DATA

public static final String JSON_PROPERTY_ADDITIONAL_DATA

See Also:

Constant Field Values

JSON_PROPERTY_ERROR_CODE

public static final String JSON_PROPERTY_ERROR_CODE

See Also:

Constant Field Values

JSON_PROPERTY_ERROR_TYPE

public static final String JSON_PROPERTY_ERROR_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_MESSAGE

public static final String JSON_PROPERTY_MESSAGE

See Also:

Constant Field Values

JSON_PROPERTY_PSP_REFERENCE

public static final String JSON_PROPERTY_PSP_REFERENCE

See Also:

Constant Field Values

JSON_PROPERTY_STATUS

public static final String JSON_PROPERTY_STATUS

See Also:

Constant Field Values

Constructor Detail

ApiError

public ApiError()

Method Detail

invalidFields

public ApiError invalidFields(List<InvalidField> invalidFields)

addInvalidFieldsItem

public ApiError addInvalidFieldsItem(InvalidField invalidFieldsItem)

getInvalidFields

public List<InvalidField> getInvalidFields()

Detailed explanation of each validation error, when applicable.

Returns:

invalidFields

setInvalidFields

public void setInvalidFields(List<InvalidField> invalidFields)

additionalData

public ApiError additionalData(Map<String,String> additionalData)

putAdditionalDataItem

public ApiError putAdditionalDataItem(String key,
                                      String additionalDataItem)

getAdditionalData

public Map<String,String> getAdditionalData()

Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.

Returns:

additionalData

setAdditionalData

public void setAdditionalData(Map<String,String> additionalData)

errorCode

public ApiError errorCode(String errorCode)

getErrorCode

public String getErrorCode()

The error code mapped to the error message.

Returns:

errorCode

setErrorCode

public void setErrorCode(String errorCode)

errorType

public ApiError errorType(String errorType)

getErrorType

public String getErrorType()

The category of the error.

Returns:

errorType

setErrorType

public void setErrorType(String errorType)

message

public ApiError message(String message)

getMessage

public String getMessage()

A short explanation of the issue.

Returns:

message

setMessage

public void setMessage(String message)

pspReference

public ApiError pspReference(String pspReference)

getPspReference

public String getPspReference()

The PSP reference of the payment.

Returns:

pspReference

setPspReference

public void setPspReference(String pspReference)

status

public ApiError status(Integer status)

getStatus

public Integer getStatus()

The HTTP response status.

Returns:

status

setStatus

public void setStatus(Integer status)

equals

public boolean equals(Object o)

Return true if this ServiceError object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

fromJson

public static ApiError fromJson(String jsonString)
                         throws com.fasterxml.jackson.core.JsonProcessingException

Create an instance of ApiError given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of ServiceError

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to ServiceError

toJson

public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException

Convert an instance of ApiError to an JSON string

Returns:

JSON string

Throws:

com.fasterxml.jackson.core.JsonProcessingException