Package com.onlinepayments.domain

Class APIError

java.lang.Object
com.onlinepayments.domain.APIError
public class APIError extends Object

  • Constructor Details

    • APIError

      public APIError()

  • Method Details

    • 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:
      • DIRECT_PLATFORM_ERROR - indicating that a functional error has occurred in the 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 payment platform or between the payment platform and 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:
      • DIRECT_PLATFORM_ERROR - indicating that a functional error has occurred in the 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 payment platform or between the payment platform and third party systems.

    • withCategory

      public APIError withCategory(String value)
      Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
      • DIRECT_PLATFORM_ERROR - indicating that a functional error has occurred in the 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 payment platform or between the payment platform and third party systems.

    • getCode

      @Deprecated public String getCode()
      Deprecated.
      Use errorCode instead. Error code
      Deprecated: Use errorCode instead. Error code

    • setCode

      @Deprecated public void setCode(String value)
      Deprecated.
      Use errorCode instead. Error code
      Deprecated: Use errorCode instead. Error code

    • withCode

      @Deprecated public APIError withCode(String value)
      Deprecated.
      Use errorCode instead. Error code
      Deprecated: Use errorCode instead. Error code

    • getErrorCode

      public String getErrorCode()
      Error code

    • setErrorCode

      public void setErrorCode(String value)
      Error code

    • withErrorCode

      public APIError withErrorCode(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

    • withHttpStatusCode

      public APIError withHttpStatusCode(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.

    • withId

      public APIError withId(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

    • withMessage

      public APIError withMessage(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'.

    • withPropertyName

      public APIError withPropertyName(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'.

    • getRetriable

      public Boolean getRetriable()
      Flag indicating if the request is retriable. Retriable requests mean that a technical error happened and that the same request can safely be sent again with a new idempotence key.

    • setRetriable

      public void setRetriable(Boolean value)
      Flag indicating if the request is retriable. Retriable requests mean that a technical error happened and that the same request can safely be sent again with a new idempotence key.

    • withRetriable

      public APIError withRetriable(Boolean value)
      Flag indicating if the request is retriable. Retriable requests mean that a technical error happened and that the same request can safely be sent again with a new idempotence key.