Class APIError

Inheritance
object
APIError
Inherited Members
Namespace: Worldline.Connect.Sdk.V1.Domain
Assembly: Worldline.Connect.Sdk.dll
Syntax
public class APIError

Properties

Category

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.
Declaration
public string Category { get; set; }
Property Value
Type Description
string

Code

Error code

Declaration
public string Code { get; set; }
Property Value
Type Description
string

HttpStatusCode

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

Declaration
public int? HttpStatusCode { get; set; }
Property Value
Type Description
int?

Id

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

Declaration
public string Id { get; set; }
Property Value
Type Description
string

Message

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

Declaration
public string Message { get; set; }
Property Value
Type Description
string

PropertyName

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'.
Declaration
public string PropertyName { get; set; }
Property Value
Type Description
string

RequestId

ID of the request that can be used for debugging purposes

Declaration
public string RequestId { get; set; }
Property Value
Type Description
string