com.worldline.connect.sdk.java.v1.domain

Class APIError

java.lang.Object

com.worldline.connect.sdk.java.v1.domain.APIError

public class APIError
extends Object

Constructor Summary

Constructors

Constructor and Description
APIError()

Method Summary

Modifier and Type	Method and Description
String	getCategory() Category the error belongs to.
String	getCode() Error code
Integer	getHttpStatusCode() HTTP status code for this error that can be used to determine the type of error
String	getId() ID of the error.
String	getMessage() Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
String	getPropertyName() Returned only if the error relates to a value that was missing or incorrect. Contains a location path to the value as a JSonata query. Some common examples: a.b selects the value of property b of root property a, a[1] selects the first element of the array in root property a, a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
String	getRequestId() ID of the request that can be used for debugging purposes
void	setCategory(String value) Category the error belongs to.
void	setCode(String value) Error code
void	setHttpStatusCode(Integer value) HTTP status code for this error that can be used to determine the type of error
void	setId(String value) ID of the error.
void	setMessage(String value) Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
void	setPropertyName(String value) Returned only if the error relates to a value that was missing or incorrect. Contains a location path to the value as a JSonata query. Some common examples: a.b selects the value of property b of root property a, a[1] selects the first element of the array in root property a, a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
void	setRequestId(String value) ID of the request that can be used for debugging purposes

Methods inherited from class java.lang.Object

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

Constructor Detail

APIError

public APIError()

Method Detail

getCategory

public String getCategory()

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:

• CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
• PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
• IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.

setCategory

public void setCategory(String value)

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:

• CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
• PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
• IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.

getCode

public String getCode()

Error code

setCode

public void setCode(String value)

Error code

getHttpStatusCode

public Integer getHttpStatusCode()

HTTP status code for this error that can be used to determine the type of error

setHttpStatusCode

public void setHttpStatusCode(Integer value)

HTTP status code for this error that can be used to determine the type of error

getId

public String getId()

ID of the error. This is a short human-readable message that briefly describes the error.

setId

public void setId(String value)

ID of the error. This is a short human-readable message that briefly describes the error.

getMessage

public String getMessage()

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud

setMessage

public void setMessage(String value)

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud

getPropertyName

public String getPropertyName()

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:

• a.b selects the value of property b of root property a,
• a[1] selects the first element of the array in root property a,
• a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.

setPropertyName

public void setPropertyName(String value)

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:

• a.b selects the value of property b of root property a,
• a[1] selects the first element of the array in root property a,
• a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.

getRequestId

public String getRequestId()

ID of the request that can be used for debugging purposes

setRequestId

public void setRequestId(String value)

ID of the request that can be used for debugging purposes