PaymentsApiError

public struct PaymentsApiError : Error, JsonApiResponse, PaymentsErrorApiResponse

Payments API error

  • id

    The error ID in which it is possible to find operation in Kibana.

    Declaration

    Swift

    public let id: String?
  • Object type.

    Declaration

    Swift

    public let type: PaymentErrorType
  • Detailed description of the error.

    Declaration

    Swift

    public let description: String?
  • The name of the parameter that caused the error.

    Declaration

    Swift

    public let parameter: String?
  • The recommended number of milliseconds after which to retry the query.

    Declaration

    Swift

    public let retryAfter: String?
  • Error code.

    Declaration

    Swift

    public let errorCode: PaymentErrorCode
  • Creates instance of PaymentError.

    Declaration

    Swift

    public init(id: String?,
                type: PaymentErrorType,
                description: String?,
                parameter: String?,
                retryAfter: String?,
                errorCode: PaymentErrorCode)

    Parameters

    id

    The error ID in which it is possible to find operation in Kibana.

    type

    Object type.

    description

    Detailed description of the error.

    retryAfter

    The recommended number of milliseconds after which to retry the query.

    errorCode

    Error code.

    Return Value

    Instance of PaymentsApiError.

  • Creates a new instance by decoding from the given decoder. This initializer throws an error if reading from the decoder fails, or if the data read is corrupted or otherwise invalid.

    Declaration

    Swift

    public init(from decoder: Decoder) throws

    Parameters

    decoder

    The decoder to read data from.