com.onlinepayments.domain

Class PaymentStatusOutput

java.lang.Object

com.onlinepayments.domain.PaymentStatusOutput

public class PaymentStatusOutput
extends Object

This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource. In case of failed payments and negative scenarios, detailed error information is listed.

Constructor Summary

Constructors

Constructor and Description
PaymentStatusOutput()

Method Summary

Modifier and Type	Method and Description
List<APIError>	getErrors() Contains the set of errors
Boolean	getIsAuthorized() Indicates if the transaction has been authorized
Boolean	getIsCancellable() Flag indicating if the payment can be cancelled
Boolean	getIsRefundable() Flag indicating if the payment can be refunded
String	getStatusCategory() Highlevel status of the payment, payout or refund.
Integer	getStatusCode() Numeric status code of the legacy API.
String	getStatusCodeChangeDateTime() Timestamp of the latest status change
void	setErrors(List<APIError> value) Contains the set of errors
void	setIsAuthorized(Boolean value) Indicates if the transaction has been authorized
void	setIsCancellable(Boolean value) Flag indicating if the payment can be cancelled
void	setIsRefundable(Boolean value) Flag indicating if the payment can be refunded
void	setStatusCategory(String value) Highlevel status of the payment, payout or refund.
void	setStatusCode(Integer value) Numeric status code of the legacy API.
void	setStatusCodeChangeDateTime(String value) Timestamp of the latest status change
PaymentStatusOutput	withErrors(List<APIError> value) Contains the set of errors
PaymentStatusOutput	withIsAuthorized(Boolean value) Indicates if the transaction has been authorized
PaymentStatusOutput	withIsCancellable(Boolean value) Flag indicating if the payment can be cancelled
PaymentStatusOutput	withIsRefundable(Boolean value) Flag indicating if the payment can be refunded
PaymentStatusOutput	withStatusCategory(String value) Highlevel status of the payment, payout or refund.
PaymentStatusOutput	withStatusCode(Integer value) Numeric status code of the legacy API.
PaymentStatusOutput	withStatusCodeChangeDateTime(String value) Timestamp of the latest status change

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentStatusOutput

public PaymentStatusOutput()

Method Detail

getErrors

public List<APIError> getErrors()

Contains the set of errors

setErrors

public void setErrors(List<APIError> value)

Contains the set of errors

withErrors

public PaymentStatusOutput withErrors(List<APIError> value)

Contains the set of errors

getIsAuthorized

public Boolean getIsAuthorized()

Indicates if the transaction has been authorized

setIsAuthorized

public void setIsAuthorized(Boolean value)

Indicates if the transaction has been authorized

withIsAuthorized

public PaymentStatusOutput withIsAuthorized(Boolean value)

Indicates if the transaction has been authorized

getIsCancellable

public Boolean getIsCancellable()

Flag indicating if the payment can be cancelled

setIsCancellable

public void setIsCancellable(Boolean value)

Flag indicating if the payment can be cancelled

withIsCancellable

public PaymentStatusOutput withIsCancellable(Boolean value)

Flag indicating if the payment can be cancelled

getIsRefundable

public Boolean getIsRefundable()

Flag indicating if the payment can be refunded

setIsRefundable

public void setIsRefundable(Boolean value)

Flag indicating if the payment can be refunded

withIsRefundable

public PaymentStatusOutput withIsRefundable(Boolean value)

Flag indicating if the payment can be refunded

getStatusCategory

public String getStatusCategory()

Highlevel status of the payment, payout or refund.

setStatusCategory

public void setStatusCategory(String value)

Highlevel status of the payment, payout or refund.

withStatusCategory

public PaymentStatusOutput withStatusCategory(String value)

Highlevel status of the payment, payout or refund.

getStatusCode

public Integer getStatusCode()

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the BackOffice and in report files.

setStatusCode

public void setStatusCode(Integer value)

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the BackOffice and in report files.

withStatusCode

public PaymentStatusOutput withStatusCode(Integer value)

Numeric status code of the legacy API. It is returned to ease the migration from the legacy APIs. You should not write new business logic based on this property as it will be deprecated in a future version of the API. The value can also be found in the BackOffice and in report files.

getStatusCodeChangeDateTime

public String getStatusCodeChangeDateTime()

Timestamp of the latest status change

setStatusCodeChangeDateTime

public void setStatusCodeChangeDateTime(String value)

Timestamp of the latest status change

withStatusCodeChangeDateTime

public PaymentStatusOutput withStatusCodeChangeDateTime(String value)

Timestamp of the latest status change